EC2 / Client / update_capacity_manager_monitored_tag_keys

update_capacity_manager_monitored_tag_keys

EC2.Client.update_capacity_manager_monitored_tag_keys(**kwargs)

Activates or deactivates tag keys for monitoring by EC2 Capacity Manager. Activated 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.update_capacity_manager_monitored_tag_keys(
    ActivateTagKeys=[
        'string',
    ],
    DeactivateTagKeys=[
        'string',
    ],
    DryRun=True|False,
    ClientToken='string'
)
Parameters:

  • ActivateTagKeys (list) –

    The tag keys to activate for monitoring. Once activated, these tag keys will be included as dimensions in capacity metric data.

    • (string) –

  • DeactivateTagKeys (list) –

    The tag keys to deactivate. Deactivated tag keys will no longer be included as dimensions in capacity metric data.

    • (string) –

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

  • ClientToken (string) –

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

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 affected by the update, 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.