Skip to content

EC2  >  Operations  >  modify_metric_category

modify_metric_category

Operation

modify_metric_category async

modify_metric_category(request: ModifyMetricCategoryInput | ModifyMetricCategoryInputDict, /, *, plugins: list[Plugin] | None = None) -> ModifyMetricCategoryOutput
modify_metric_category(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyMetricCategoryInputDict]) -> ModifyMetricCategoryOutput

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ModifyMetricCategoryOutput

An instance of ModifyMetricCategoryOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

ModifyMetricCategoryInput dataclass

Bases: _SerdeShape

Dataclass for ModifyMetricCategoryInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

metric_category_id class-attribute instance-attribute
metric_category_id: str | None = ...

The ID of the metric category.

metrics class-attribute instance-attribute
metrics: list[str] | None = ...

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.

Dictionaries

ModifyMetricCategoryInputDict

Bases: TypedDict

Dictionary form of ModifyMetricCategoryInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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.

metric_category_id instance-attribute
metric_category_id: Required[str]

The ID of the metric category.

metrics instance-attribute
metrics: Required[Sequence[str]]

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.

Output

ModifyMetricCategoryOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyMetricCategoryOutput structure.

Attributes

metric_category class-attribute instance-attribute
metric_category: MetricCategory | None = ...

Information about the metric category.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.