Get Capacity Manager Metric Data
| ec2_get_capacity_manager_metric_data | R Documentation |
Retrieves capacity usage metrics for your EC2 resources¶
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.
Usage¶
ec2_get_capacity_manager_metric_data(MetricNames, StartTime, EndTime,
Period, GroupBy, FilterBy, MaxResults, NextToken, DryRun)
Arguments¶
MetricNames |
[required] The names of the metrics to retrieve. Maximum of 10 metrics per request. |
StartTime |
[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. |
EndTime |
[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 |
[required] The granularity, in seconds, of the returned data points. |
GroupBy |
The dimensions by which to group the metric data. This determines how the data is aggregated and returned. |
FilterBy |
Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), and values to match against. |
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. |
NextToken |
The token for the next page of results. Use this value in a subsequent call to retrieve additional data points. |
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
|
Value¶
A list with the following syntax:
list(
MetricDataResults = list(
list(
Dimension = list(
ResourceRegion = "string",
AvailabilityZoneId = "string",
AccountId = "string",
AccountName = "string",
InstanceFamily = "string",
InstanceType = "string",
InstancePlatform = "string",
ReservationArn = "string",
ReservationId = "string",
ReservationType = "capacity-block"|"odcr",
ReservationCreateTimestamp = as.POSIXct(
"2015-01-01"
),
ReservationStartTimestamp = as.POSIXct(
"2015-01-01"
),
ReservationEndTimestamp = as.POSIXct(
"2015-01-01"
),
ReservationEndDateType = "limited"|"unlimited",
Tenancy = "default"|"dedicated",
ReservationState = "active"|"expired"|"cancelled"|"scheduled"|"pending"|"failed"|"delayed"|"unsupported"|"payment-pending"|"payment-failed"|"retired",
ReservationInstanceMatchCriteria = "string",
ReservationUnusedFinancialOwner = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
)
),
Timestamp = as.POSIXct(
"2015-01-01"
),
MetricValues = list(
list(
Metric = "reservation-total-capacity-hrs-vcpu"|"reservation-total-capacity-hrs-inst"|"reservation-max-size-vcpu"|"reservation-max-size-inst"|"reservation-min-size-vcpu"|"reservation-min-size-inst"|"reservation-unused-total-capacity-hrs-vcpu"|"reservation-unused-total-capacity-hrs-inst"|"reservation-unused-total-estimated-cost"|"reservation-max-unused-size-vcpu"|"reservation-max-unused-size-inst"|"reservation-min-unused-size-vcpu"|"reservation-min-unused-size-inst"|"reservation-max-utilization"|"reservation-min-utilization"|"reservation-avg-utilization-vcpu"|"reservation-avg-utilization-inst"|"reservation-total-count"|"reservation-total-estimated-cost"|"reservation-avg-future-size-vcpu"|"reservation-avg-future-size-inst"|"reservation-min-future-size-vcpu"|"reservation-min-future-size-inst"|"reservation-max-future-size-vcpu"|"reservation-max-future-size-inst"|"reservation-avg-committed-size-vcpu"|"reservation-avg-committed-size-inst"|"reservation-max-committed-size-vcpu"|"reservation-max-committed-size-inst"|"reservation-min-committed-size-vcpu"|"reservation-min-committed-size-inst"|"reserved-total-usage-hrs-vcpu"|"reserved-total-usage-hrs-inst"|"reserved-total-estimated-cost"|"unreserved-total-usage-hrs-vcpu"|"unreserved-total-usage-hrs-inst"|"unreserved-total-estimated-cost"|"spot-total-usage-hrs-vcpu"|"spot-total-usage-hrs-inst"|"spot-total-estimated-cost"|"spot-avg-run-time-before-interruption-inst"|"spot-max-run-time-before-interruption-inst"|"spot-min-run-time-before-interruption-inst"|"spot-total-interruptions-inst"|"spot-total-interruptions-vcpu"|"spot-total-count-inst"|"spot-total-count-vcpu"|"spot-interruption-rate-inst"|"spot-interruption-rate-vcpu",
Value = 123.0
)
)
)
),
NextToken = "string"
)
Request syntax¶
svc$get_capacity_manager_metric_data(
MetricNames = list(
"reservation-total-capacity-hrs-vcpu"|"reservation-total-capacity-hrs-inst"|"reservation-max-size-vcpu"|"reservation-max-size-inst"|"reservation-min-size-vcpu"|"reservation-min-size-inst"|"reservation-unused-total-capacity-hrs-vcpu"|"reservation-unused-total-capacity-hrs-inst"|"reservation-unused-total-estimated-cost"|"reservation-max-unused-size-vcpu"|"reservation-max-unused-size-inst"|"reservation-min-unused-size-vcpu"|"reservation-min-unused-size-inst"|"reservation-max-utilization"|"reservation-min-utilization"|"reservation-avg-utilization-vcpu"|"reservation-avg-utilization-inst"|"reservation-total-count"|"reservation-total-estimated-cost"|"reservation-avg-future-size-vcpu"|"reservation-avg-future-size-inst"|"reservation-min-future-size-vcpu"|"reservation-min-future-size-inst"|"reservation-max-future-size-vcpu"|"reservation-max-future-size-inst"|"reservation-avg-committed-size-vcpu"|"reservation-avg-committed-size-inst"|"reservation-max-committed-size-vcpu"|"reservation-max-committed-size-inst"|"reservation-min-committed-size-vcpu"|"reservation-min-committed-size-inst"|"reserved-total-usage-hrs-vcpu"|"reserved-total-usage-hrs-inst"|"reserved-total-estimated-cost"|"unreserved-total-usage-hrs-vcpu"|"unreserved-total-usage-hrs-inst"|"unreserved-total-estimated-cost"|"spot-total-usage-hrs-vcpu"|"spot-total-usage-hrs-inst"|"spot-total-estimated-cost"|"spot-avg-run-time-before-interruption-inst"|"spot-max-run-time-before-interruption-inst"|"spot-min-run-time-before-interruption-inst"|"spot-total-interruptions-inst"|"spot-total-interruptions-vcpu"|"spot-total-count-inst"|"spot-total-count-vcpu"|"spot-interruption-rate-inst"|"spot-interruption-rate-vcpu"
),
StartTime = as.POSIXct(
"2015-01-01"
),
EndTime = as.POSIXct(
"2015-01-01"
),
Period = 123,
GroupBy = list(
"resource-region"|"availability-zone-id"|"account-id"|"account-name"|"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"
),
FilterBy = list(
list(
DimensionCondition = list(
Dimension = "resource-region"|"availability-zone-id"|"account-id"|"account-name"|"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 = list(
"string"
)
)
)
),
MaxResults = 123,
NextToken = "string",
DryRun = TRUE|FALSE
)