Container for the parameters to the GetCapacityManagerMetricData operation. Retrieves capacity usage metrics for your EC2 resources. Returns time-series data for metrics like unused capacity, utilization rates, and costs across On-Demand, Spot, and Capacity Reservations. Data can be grouped and filtered by various dimensions such as region, account, and instance family.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.EC2.AmazonEC2Request
Amazon.EC2.Model.GetCapacityManagerMetricDataRequest
Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z
Syntax
public class GetCapacityManagerMetricDataRequest : AmazonEC2Request IAmazonWebServiceRequest
The GetCapacityManagerMetricDataRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetCapacityManagerMetricDataRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
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 |
|
|
EndTime | System.Nullable<System.DateTime> |
Gets and sets the property EndTime. The end time for the metric data query, in ISO 8601 format. If the end time is beyond the latest ingested data, it will be automatically adjusted to the latest available data point. |
|
|
FilterBy | System.Collections.Generic.List<Amazon.EC2.Model.CapacityManagerCondition> |
Gets and sets the property FilterBy. Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), 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. |
|
|
GroupBy | System.Collections.Generic.List<System.String> |
Gets and sets the property GroupBy. The dimensions by which to group the metric data. This determines how the data is aggregated and returned. 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. |
|
|
MaxResults | System.Nullable<System.Int32> |
Gets and sets the property MaxResults. The maximum number of data points to return. Valid range is 1 to 100,000. Use with NextToken for pagination of large result sets. |
|
|
MetricNames | System.Collections.Generic.List<System.String> |
Gets and sets the property MetricNames. The names of the metrics to retrieve. Maximum of 10 metrics per request. 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. |
|
|
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 data points. |
|
|
Period | System.Nullable<System.Int32> |
Gets and sets the property Period. The granularity, in seconds, of the returned data points. |
|
|
StartTime | System.Nullable<System.DateTime> |
Gets and sets the property StartTime. The start time for the metric data query, in ISO 8601 format. The time range (end time - start time) must be a multiple of the specified period. |
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