:doc:`EC2 <../../ec2>` / Paginator / GetCapacityManagerMetricDimensions

**********************************
GetCapacityManagerMetricDimensions
**********************************



.. py:class:: EC2.Paginator.GetCapacityManagerMetricDimensions

  ::

    
    paginator = client.get_paginator('get_capacity_manager_metric_dimensions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`EC2.Client.get_capacity_manager_metric_dimensions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/GetCapacityManagerMetricDimensions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          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'|'spot-total-interruptions-inst'|'spot-total-interruptions-vcpu'|'spot-total-count-inst'|'spot-total-count-vcpu'|'spot-interruption-rate-inst'|'spot-interruption-rate-vcpu',
          ],
          DryRun=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type GroupBy: list
    :param GroupBy: **[REQUIRED]** 

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

      

    
      - *(string) --* 

      
  
    :type FilterBy: list
    :param FilterBy: 

      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) --* 

            
        
        
      
  
    :type StartTime: datetime
    :param StartTime: **[REQUIRED]** 

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

      

    
    :type EndTime: datetime
    :param EndTime: **[REQUIRED]** 

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

      

    
    :type MetricNames: list
    :param MetricNames: **[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) --* 

      
  
    :type DryRun: boolean
    :param 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``.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: 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'
                },
            ],
            
        }
        
      **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.

              
        
      
    