Skip to content

describe_metric_categories

Operation

describe_metric_categories

describe_metric_categories(request: DescribeMetricCategoriesInput | DescribeMetricCategoriesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeMetricCategoriesInputDict]) -> DescribeMetricCategoriesOutput

Describes the specified metric categories, or all of your metric categories.

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

Parameters:

Name Type Description Default
request DescribeMetricCategoriesInput | DescribeMetricCategoriesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeMetricCategoriesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeMetricCategoriesOutput

An instance of DescribeMetricCategoriesOutput.

describe_metric_categories async

describe_metric_categories(request: DescribeMetricCategoriesInput | DescribeMetricCategoriesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeMetricCategoriesInputDict]) -> DescribeMetricCategoriesOutput

Describes the specified metric categories, or all of your metric categories.

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

Parameters:

Name Type Description Default
request DescribeMetricCategoriesInput | DescribeMetricCategoriesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeMetricCategoriesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeMetricCategoriesOutput

An instance of DescribeMetricCategoriesOutput.

Input

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

DescribeMetricCategoriesInputDict

Bases: TypedDict

Dictionary form of DescribeMetricCategoriesInput.

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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

The filters.

  • metric-name - The name of a metric in the metric category.
max_results instance-attribute
max_results: int | None

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

Valid range: 5 - 100.

metric_category_ids instance-attribute
metric_category_ids: Sequence[str] | None

The IDs of the metric categories. If you specify IDs, you can't specify MaxResults or NextToken.

next_token instance-attribute
next_token: str | None

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

DescribeMetricCategoriesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeMetricCategoriesInput 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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

The filters.

  • metric-name - The name of a metric in the metric category.
max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

Valid range: 5 - 100.

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

The IDs of the metric categories. If you specify IDs, you can't specify MaxResults or NextToken.

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

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Output

DescribeMetricCategoriesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeMetricCategoriesOutput structure.

Attributes

metric_categories class-attribute instance-attribute
metric_categories: list[MetricCategory] | None = ...

Information about the metric categories.

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

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

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.