Skip to content

get_capacity_manager_metric_dimensions

Operation

get_capacity_manager_metric_dimensions

Retrieves the available dimension values for capacity metrics within a specified time range. This is useful for discovering what accounts, regions, instance families, and other dimensions have data available for filtering and grouping.

Parameters:

Name Type Description Default
request GetCapacityManagerMetricDimensionsInput | GetCapacityManagerMetricDimensionsInputDict | 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[GetCapacityManagerMetricDimensionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCapacityManagerMetricDimensionsOutput

An instance of GetCapacityManagerMetricDimensionsOutput.

get_capacity_manager_metric_dimensions async

Retrieves the available dimension values for capacity metrics within a specified time range. This is useful for discovering what accounts, regions, instance families, and other dimensions have data available for filtering and grouping.

Parameters:

Name Type Description Default
request GetCapacityManagerMetricDimensionsInput | GetCapacityManagerMetricDimensionsInputDict | 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[GetCapacityManagerMetricDimensionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCapacityManagerMetricDimensionsOutput

An instance of GetCapacityManagerMetricDimensionsOutput.

Input

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

GetCapacityManagerMetricDimensionsInputDict

Bases: TypedDict

Dictionary form of GetCapacityManagerMetricDimensionsInput.

Attributes

dry_run instance-attribute
dry_run: bool | None

Checks whether you have the required permissions for the action, 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.

end_time instance-attribute
end_time: Required[datetime]

The end time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

filter_by instance-attribute

Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against.

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

The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

max_results instance-attribute
max_results: int | None

The maximum number of dimension combinations to return. Valid range is 1 to 1000. Use with NextToken for pagination.

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

The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

next_token instance-attribute
next_token: str | None

The token for the next page of results. Use this value in a subsequent call to retrieve additional dimension values.

start_time instance-attribute
start_time: Required[datetime]

The start time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

GetCapacityManagerMetricDimensionsInput dataclass

Bases: _SerdeShape

Dataclass for GetCapacityManagerMetricDimensionsInput structure.

Attributes

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

Checks whether you have the required permissions for the action, 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.

end_time class-attribute instance-attribute
end_time: datetime | None = ...

The end time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

filter_by class-attribute instance-attribute
filter_by: list[CapacityManagerCondition] | None = ...

Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against.

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

The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of dimension combinations to return. Valid range is 1 to 1000. Use with NextToken for pagination.

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

The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

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

The token for the next page of results. Use this value in a subsequent call to retrieve additional dimension values.

start_time class-attribute instance-attribute
start_time: datetime | None = ...

The start time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

Output

GetCapacityManagerMetricDimensionsOutput dataclass

Bases: _SerdeShape

Dataclass for GetCapacityManagerMetricDimensionsOutput structure.

Attributes

metric_dimension_results class-attribute instance-attribute
metric_dimension_results: list[CapacityManagerDimension] | None = ...

The available dimension combinations that have data within the specified time range and filters.

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

The token to use to retrieve the next page of results. This value is null when there are no more results 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.