[ aws . autoscaling ]

describe-metric-collection-types

Description

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

The GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling the EnableMetricsCollection API.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-metric-collection-types
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe the Auto Scaling metric collection types

This example describes the available metric collection types:

aws autoscaling describe-metric-collection-types

The following is example output:

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

For more information, see Auto Scaling Group Metrics in the Amazon EC2 Auto Scaling User Guide.

Output

Metrics -> (list)

One or more metrics.

(structure)

Describes a metric.

Metric -> (string)

One of the following metrics:

  • GroupMinSize

  • GroupMaxSize

  • GroupDesiredCapacity

  • GroupInServiceInstances

  • GroupPendingInstances

  • GroupStandbyInstances

  • GroupTerminatingInstances

  • GroupTotalInstances

  • GroupInServiceCapacity

  • GroupPendingCapacity

  • GroupStandbyCapacity

  • GroupTerminatingCapacity

  • GroupTotalCapacity

Granularities -> (list)

The granularities for the metrics.

(structure)

Describes a granularity of a metric.

Granularity -> (string)

The granularity. The only valid value is 1Minute .