AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the GetCapacityManagerMetricDimensions operation. Retrieves the available dimension values for capacity metrics within a specified time range. This is useful for discovering what accounts, regions, instance families, and other dimensions have data available for filtering and grouping.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.GetCapacityManagerMetricDimensionsRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class GetCapacityManagerMetricDimensionsRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The GetCapacityManagerMetricDimensionsRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property DryRun System.Nullable<System.Boolean>

Gets and sets the property DryRun.

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Public Property EndTime System.Nullable<System.DateTime>

Gets and sets the property EndTime.

The end time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

Public Property FilterBy System.Collections.Generic.List<Amazon.EC2.Model.CapacityManagerCondition>

Gets and sets the property FilterBy.

Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property GroupBy System.Collections.Generic.List<System.String>

Gets and sets the property GroupBy.

The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property MaxResults System.Nullable<System.Int32>

Gets and sets the property MaxResults.

The maximum number of dimension combinations to return. Valid range is 1 to 1000. Use with NextToken for pagination.

Public Property MetricNames System.Collections.Generic.List<System.String>

Gets and sets the property MetricNames.

The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property NextToken System.String

Gets and sets the property NextToken.

The token for the next page of results. Use this value in a subsequent call to retrieve additional dimension values.

Public Property StartTime System.Nullable<System.DateTime>

Gets and sets the property StartTime.

The start time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer