EC2 / Client / modify_metric_category

modify_metric_category

EC2.Client.modify_metric_category(**kwargs)

Modifies the metrics in the specified metric category. The metrics that you specify replace the existing metrics.

Instances that are associated with the metric category are updated asynchronously.

For more information, see Use metric categories for additional metrics in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

response = client.modify_metric_category(
    MetricCategoryId='string',
    Metrics=[
        'string',
    ],
    DryRun=True|False
)
Parameters:

  • MetricCategoryId (string) –

    [REQUIRED]

    The ID of the metric category.

  • Metrics (list) –

    [REQUIRED]

    The names of the metrics for the metric category. These metrics replace the existing metrics, and must differ from the current set.

    Specify each metric by its Amazon CloudWatch metric name or its OpenTelemetry metric name. The two names for a measurement are separate entries, and you can include both.

    In Regions where Amazon CloudWatch OpenTelemetry metrics aren’t available, you can’t specify OpenTelemetry metric names.

    • (string) –

  • DryRun (boolean) – Checks whether you have the required permissions for the operation, 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

{
    'MetricCategory': {
        'MetricCategoryId': 'string',
        'Metrics': [
            'string',
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • MetricCategory (dict) –

      Information about the metric category.

      • MetricCategoryId (string) –

        The ID of the metric category.

      • Metrics (list) –

        The names of the metrics in the metric category.

        • (string) –

      • Tags (list) –

        Any tags assigned to the metric category.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.