create_metric_category¶
Operation¶
create_metric_category
async
¶
create_metric_category(request: CreateMetricCategoryInput | CreateMetricCategoryInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateMetricCategoryOutput
create_metric_category(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateMetricCategoryInputDict]) -> CreateMetricCategoryOutput
Creates a metric category. A metric category is a set of additional metrics that you can associate with an instance that has detailed monitoring enabled.
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 |
|---|---|
CreateMetricCategoryOutput
|
An instance of |
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¶
CreateMetricCategoryInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateMetricCategoryInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
This field is autopopulated if not provided.
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.
metrics
class-attribute
instance-attribute
¶
The names of the metrics to include in the metric category.
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.
tag_specifications
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
The tags to apply to the metric category during creation.
Dictionaries¶
CreateMetricCategoryInputDict
¶
Bases: TypedDict
Dictionary form of CreateMetricCategoryInput.
Attributes¶
client_token
instance-attribute
¶
client_token: str | None
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
This field is autopopulated if not provided.
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.
metrics
instance-attribute
¶
The names of the metrics to include in the metric category.
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.
tag_specifications
instance-attribute
¶
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None
The tags to apply to the metric category during creation.
Output¶
CreateMetricCategoryOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateMetricCategoryOutput structure.
Attributes¶
metric_category
class-attribute
instance-attribute
¶
metric_category: MetricCategory | None = ...
Information about the metric category.
response_metadata
class-attribute
instance-attribute
¶
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.