EC2 / Client / get_capacity_manager_monitored_tag_keys

get_capacity_manager_monitored_tag_keys

EC2.Client.get_capacity_manager_monitored_tag_keys(**kwargs)

Retrieves the tag keys that are currently being monitored by EC2 Capacity Manager. Monitored tag keys are included as dimensions in capacity metric data, enabling you to group and filter metrics by tag values.

See also: AWS API Documentation

Request Syntax

response = client.get_capacity_manager_monitored_tag_keys(
    MaxResults=123,
    NextToken='string',
    DryRun=True|False
)
Parameters:

  • MaxResults (integer) – The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. If not specified, up to 1000 results are returned.

  • NextToken (string) – The token for the next page of results. Use the value returned from a previous call to retrieve additional results.

  • 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

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

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.

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