AutoScaling / Client / describe_metric_collection_types

describe_metric_collection_types#

AutoScaling.Client.describe_metric_collection_types()#

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

See also: AWS API Documentation

Request Syntax

response = client.describe_metric_collection_types()
Return type:

dict

Returns:

Response Syntax

{
    'Metrics': [
        {
            'Metric': 'string'
        },
    ],
    'Granularities': [
        {
            'Granularity': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Metrics (list) –

      The metrics.

      • (dict) –

        Describes a metric.

        • Metric (string) –

          One of the following metrics:

          • GroupMinSize

          • GroupMaxSize

          • GroupDesiredCapacity

          • GroupInServiceInstances

          • GroupPendingInstances

          • GroupStandbyInstances

          • GroupTerminatingInstances

          • GroupTotalInstances

          • GroupInServiceCapacity

          • GroupPendingCapacity

          • GroupStandbyCapacity

          • GroupTerminatingCapacity

          • GroupTotalCapacity

          • WarmPoolDesiredCapacity

          • WarmPoolWarmedCapacity

          • WarmPoolPendingCapacity

          • WarmPoolTerminatingCapacity

          • WarmPoolTotalCapacity

          • GroupAndWarmPoolDesiredCapacity

          • GroupAndWarmPoolTotalCapacity

    • Granularities (list) –

      The granularities for the metrics.

      • (dict) –

        Describes a granularity of a metric.

        • Granularity (string) –

          The granularity. The only valid value is 1Minute.

Exceptions

  • AutoScaling.Client.exceptions.ResourceContentionFault

Examples

This example describes the available metric collection types.

response = client.describe_metric_collection_types(
)

print(response)

Expected Output:

{
    'Granularities': [
        {
            'Granularity': '1Minute',
        },
    ],
    'Metrics': [
        {
            'Metric': 'GroupMinSize',
        },
        {
            'Metric': 'GroupMaxSize',
        },
        {
            'Metric': 'GroupDesiredCapacity',
        },
        {
            'Metric': 'GroupInServiceInstances',
        },
        {
            'Metric': 'GroupPendingInstances',
        },
        {
            'Metric': 'GroupTerminatingInstances',
        },
        {
            'Metric': 'GroupStandbyInstances',
        },
        {
            'Metric': 'GroupTotalInstances',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}