get-capacity-manager-metric-data¶
Description¶
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.
See also: AWS API Documentation
get-capacity-manager-metric-data is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.
When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: MetricDataResults
Synopsis¶
get-capacity-manager-metric-data
--metric-names <value>
--start-time <value>
--end-time <value>
--period <value>
[--group-by <value>]
[--filter-by <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--metric-names (list) [required]
The names of the metrics to retrieve. Maximum of 10 metrics per request.
Constraints:
- min:
0- max:
40(string)
Possible values:
reservation-total-capacity-hrs-vcpureservation-total-capacity-hrs-instreservation-max-size-vcpureservation-max-size-instreservation-min-size-vcpureservation-min-size-instreservation-unused-total-capacity-hrs-vcpureservation-unused-total-capacity-hrs-instreservation-unused-total-estimated-costreservation-max-unused-size-vcpureservation-max-unused-size-instreservation-min-unused-size-vcpureservation-min-unused-size-instreservation-max-utilizationreservation-min-utilizationreservation-avg-utilization-vcpureservation-avg-utilization-instreservation-total-countreservation-total-estimated-costreservation-avg-future-size-vcpureservation-avg-future-size-instreservation-min-future-size-vcpureservation-min-future-size-instreservation-max-future-size-vcpureservation-max-future-size-instreservation-avg-committed-size-vcpureservation-avg-committed-size-instreservation-max-committed-size-vcpureservation-max-committed-size-instreservation-min-committed-size-vcpureservation-min-committed-size-instreserved-total-usage-hrs-vcpureserved-total-usage-hrs-instreserved-total-estimated-costunreserved-total-usage-hrs-vcpuunreserved-total-usage-hrs-instunreserved-total-estimated-costspot-total-usage-hrs-vcpuspot-total-usage-hrs-instspot-total-estimated-costspot-avg-run-time-before-interruption-instspot-max-run-time-before-interruption-instspot-min-run-time-before-interruption-inst
Syntax:
"string" "string" ...
--start-time (timestamp) [required]
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.
--end-time (timestamp) [required]
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.
--period (integer) [required]
The granularity, in seconds, of the returned data points.
Constraints:
- min:
3600- max:
86400
--group-by (list)
The dimensions by which to group the metric data. This determines how the data is aggregated and returned.
Constraints:
- min:
0- max:
20(string)
Possible values:
resource-regionavailability-zone-idaccount-idinstance-familyinstance-typeinstance-platformreservation-arnreservation-idreservation-typereservation-create-timestampreservation-start-timestampreservation-end-timestampreservation-end-date-typetenancyreservation-statereservation-instance-match-criteriareservation-unused-financial-owner
Syntax:
"string" "string" ...
--filter-by (list)
Conditions to filter the metric data. Each filter specifies a dimension, comparison operator (‘equals’, ‘in’), and values to match against.
Constraints:
- min:
0- max:
20(structure)
Represents a filter condition for Capacity Manager queries. Contains dimension-based filtering criteria used to narrow down metric data and dimension results.
DimensionCondition -> (structure)
The dimension-based condition that specifies how to filter the data based on dimension values.
Dimension -> (string)
The name of the dimension to filter by.
Possible values:
resource-regionavailability-zone-idaccount-idinstance-familyinstance-typeinstance-platformreservation-arnreservation-idreservation-typereservation-create-timestampreservation-start-timestampreservation-end-timestampreservation-end-date-typetenancyreservation-statereservation-instance-match-criteriareservation-unused-financial-ownerComparison -> (string)
The comparison operator to use for the filter.
Possible values:
equalsinValues -> (list)
The list of values to match against the specified dimension. For ‘equals’ comparison, only the first value is used. For ‘in’ comparison, any matching value will satisfy the condition.
Constraints:
- min:
0- max:
10(string)
Shorthand Syntax:
DimensionCondition={Dimension=string,Comparison=string,Values=[string,string]} ...
JSON Syntax:
[
{
"DimensionCondition": {
"Dimension": "resource-region"|"availability-zone-id"|"account-id"|"instance-family"|"instance-type"|"instance-platform"|"reservation-arn"|"reservation-id"|"reservation-type"|"reservation-create-timestamp"|"reservation-start-timestamp"|"reservation-end-timestamp"|"reservation-end-date-type"|"tenancy"|"reservation-state"|"reservation-instance-match-criteria"|"reservation-unused-financial-owner",
"Comparison": "equals"|"in",
"Values": ["string", ...]
}
}
...
]
--dry-run | --no-dry-run (boolean)
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 isDryRunOperation. Otherwise, it isUnauthorizedOperation.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size (integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items (integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextTokenis provided in the command’s output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶
MetricDataResults -> (list)
The metric data points returned by the query. Each result contains dimension values, timestamp, and metric values with their associated statistics.
(structure)
Contains a single data point from a capacity metrics query, including the dimension values, timestamp, and metric values for that specific combination.
Dimension -> (structure)
The dimension values that identify this specific data point, such as account ID, region, and instance family.
ResourceRegion -> (string)
The Amazon Web Services Region where the capacity resource is located.AvailabilityZoneId -> (string)
The unique identifier of the Availability Zone where the capacity resource is located.AccountId -> (string)
The Amazon Web Services account ID that owns the capacity resource.InstanceFamily -> (string)
The EC2 instance family of the capacity resource.InstanceType -> (string)
The specific EC2 instance type of the capacity resource.InstancePlatform -> (string)
The platform or operating system of the instance.ReservationArn -> (string)
The Amazon Resource Name (ARN) of the capacity reservation. This provides a unique identifier that can be used across Amazon Web Services services to reference the specific reservation.ReservationId -> (string)
The unique identifier of the capacity reservation.ReservationType -> (string)
The type of capacity reservation.
Possible values:
capacity-blockodcrReservationCreateTimestamp -> (timestamp)
The timestamp when the capacity reservation was originally created, in milliseconds since epoch. This differs from the start timestamp as reservations can be created before they become active.ReservationStartTimestamp -> (timestamp)
The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch. This is when the reservation begins providing capacity.ReservationEndTimestamp -> (timestamp)
The timestamp when the capacity reservation expires and is no longer available, in milliseconds since epoch. After this time, the reservation will not provide any capacity.ReservationEndDateType -> (string)
The type of end date for the capacity reservation. This indicates whether the reservation has a fixed end date, is open-ended, or follows a specific termination pattern.
Possible values:
limitedunlimitedTenancy -> (string)
The tenancy of the EC2 instances associated with this capacity dimension. Valid values are ‘default’ for shared tenancy, ‘dedicated’ for dedicated instances, or ‘host’ for dedicated hosts.
Possible values:
defaultdedicatedReservationState -> (string)
The current state of the capacity reservation.
Possible values:
activeexpiredcancelledscheduledpendingfaileddelayedunsupportedpayment-pendingpayment-failedretiredReservationInstanceMatchCriteria -> (string)
The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation.ReservationUnusedFinancialOwner -> (string)
The Amazon Web Services account ID that is financially responsible for unused capacity reservation costs.Timestamp -> (timestamp)
The timestamp for this data point, indicating when the capacity usage occurred.MetricValues -> (list)
The metric values and statistics for this data point, containing the actual capacity usage numbers.
(structure)
Represents a single metric value with its associated statistic, such as the sum or average of unused capacity hours.
Metric -> (string)
The name of the metric.
Possible values:
reservation-total-capacity-hrs-vcpureservation-total-capacity-hrs-instreservation-max-size-vcpureservation-max-size-instreservation-min-size-vcpureservation-min-size-instreservation-unused-total-capacity-hrs-vcpureservation-unused-total-capacity-hrs-instreservation-unused-total-estimated-costreservation-max-unused-size-vcpureservation-max-unused-size-instreservation-min-unused-size-vcpureservation-min-unused-size-instreservation-max-utilizationreservation-min-utilizationreservation-avg-utilization-vcpureservation-avg-utilization-instreservation-total-countreservation-total-estimated-costreservation-avg-future-size-vcpureservation-avg-future-size-instreservation-min-future-size-vcpureservation-min-future-size-instreservation-max-future-size-vcpureservation-max-future-size-instreservation-avg-committed-size-vcpureservation-avg-committed-size-instreservation-max-committed-size-vcpureservation-max-committed-size-instreservation-min-committed-size-vcpureservation-min-committed-size-instreserved-total-usage-hrs-vcpureserved-total-usage-hrs-instreserved-total-estimated-costunreserved-total-usage-hrs-vcpuunreserved-total-usage-hrs-instunreserved-total-estimated-costspot-total-usage-hrs-vcpuspot-total-usage-hrs-instspot-total-estimated-costspot-avg-run-time-before-interruption-instspot-max-run-time-before-interruption-instspot-min-run-time-before-interruption-instValue -> (double)
The numerical value of the metric for the specified statistic and time period.
NextToken -> (string)
The token to use to retrieve the next page of results. This value is null when there are no more results to return.