EC2 / Paginator / GetCapacityManagerMonitoredTagKeys

GetCapacityManagerMonitoredTagKeys

class EC2.Paginator.GetCapacityManagerMonitoredTagKeys

paginator = client.get_paginator('get_capacity_manager_monitored_tag_keys')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EC2.Client.get_capacity_manager_monitored_tag_keys().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DryRun=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• PaginationConfig (dict) –

  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.

Return type:

dict

Returns:

Response Syntax

{
    'CapacityManagerTagKeys': [
        {
            'TagKey': 'string',
            'Status': 'activating'|'activated'|'deactivating'|'suspended',
            'StatusMessage': 'string',
            'CapacityManagerProvided': True|False,
            'EarliestDatapointTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • CapacityManagerTagKeys (list) –

    The list of tag keys being monitored by Capacity Manager, including their current status and metadata.

    • (dict) –

      Describes a tag key that is being monitored by Capacity Manager, including its activation status and the earliest available data point.

      • TagKey (string) –

        The tag key being monitored.

      • Status (string) –

        The current status of the monitored tag key. Valid values are activating, activated, deactivating, and suspended.

      • StatusMessage (string) –

        A message providing additional details about the current status of the monitored tag key.

      • CapacityManagerProvided (boolean) –

        Indicates whether this tag key is provided by Capacity Manager by default, rather than being user-activated.

      • EarliestDatapointTimestamp (datetime) –

        The earliest timestamp from which tag data is available for queries, in UTC ISO 8601 format.