EC2 / Client / get_capacity_manager_metric_dimensions

get_capacity_manager_metric_dimensions

EC2.Client.get_capacity_manager_metric_dimensions(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_capacity_manager_metric_dimensions(
    GroupBy=[
        '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',
    ],
    FilterBy=[
        {
            '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',
                ]
            }
        },
    ],
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    MetricNames=[
        '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',
    ],
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)

Parameters:

• GroupBy (list) –

  [REQUIRED]

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

  • (string) –

• FilterBy (list) –

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

  • (dict) –

    Represents a filter condition for Capacity Manager queries. Contains dimension-based filtering criteria used to narrow down metric data and dimension results.

    • DimensionCondition (dict) –

      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.

      • Comparison (string) –

        The comparison operator to use for the filter.

      • Values (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.

        • (string) –

• StartTime (datetime) –

  [REQUIRED]

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

• EndTime (datetime) –

  [REQUIRED]

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

• MetricNames (list) –

  [REQUIRED]

  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.

  • (string) –

• MaxResults (integer) – The maximum number of dimension combinations to return. Valid range is 1 to 1000. Use with NextToken for pagination.

• NextToken (string) – The token for the next page of results. Use this value in a subsequent call to retrieve additional dimension values.

• DryRun (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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'MetricDimensionResults': [
        {
            'ResourceRegion': 'string',
            'AvailabilityZoneId': 'string',
            'AccountId': 'string',
            'InstanceFamily': 'string',
            'InstanceType': 'string',
            'InstancePlatform': 'string',
            'ReservationArn': 'string',
            'ReservationId': 'string',
            'ReservationType': 'capacity-block'|'odcr',
            'ReservationCreateTimestamp': datetime(2015, 1, 1),
            'ReservationStartTimestamp': datetime(2015, 1, 1),
            'ReservationEndTimestamp': datetime(2015, 1, 1),
            'ReservationEndDateType': 'limited'|'unlimited',
            'Tenancy': 'default'|'dedicated',
            'ReservationState': 'active'|'expired'|'cancelled'|'scheduled'|'pending'|'failed'|'delayed'|'unsupported'|'payment-pending'|'payment-failed'|'retired',
            'ReservationInstanceMatchCriteria': 'string',
            'ReservationUnusedFinancialOwner': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • MetricDimensionResults (list) –

    The available dimension combinations that have data within the specified time range and filters.

    • (dict) –

      Represents dimension values for capacity metrics, including resource identifiers, geographic information, and reservation details used for grouping and filtering capacity data.

      • 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.

      • ReservationCreateTimestamp (datetime) –

        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 (datetime) –

        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 (datetime) –

        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.

      • Tenancy (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.

      • ReservationState (string) –

        The current state of the capacity reservation.

      • ReservationInstanceMatchCriteria (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.

  • 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.