Skip to content

describe_capacity_manager_data_exports

Operation

describe_capacity_manager_data_exports

Describes one or more Capacity Manager data export configurations. Returns information about export settings, delivery status, and recent export activity.

Parameters:

Name Type Description Default
request DescribeCapacityManagerDataExportsInput | DescribeCapacityManagerDataExportsInputDict | 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[DescribeCapacityManagerDataExportsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeCapacityManagerDataExportsOutput

An instance of DescribeCapacityManagerDataExportsOutput.

describe_capacity_manager_data_exports async

Describes one or more Capacity Manager data export configurations. Returns information about export settings, delivery status, and recent export activity.

Parameters:

Name Type Description Default
request DescribeCapacityManagerDataExportsInput | DescribeCapacityManagerDataExportsInputDict | 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[DescribeCapacityManagerDataExportsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeCapacityManagerDataExportsOutput

An instance of DescribeCapacityManagerDataExportsOutput.

Input

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

DescribeCapacityManagerDataExportsInputDict

Bases: TypedDict

Dictionary form of DescribeCapacityManagerDataExportsInput.

Attributes

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

The IDs of the data export configurations to describe. If not specified, all export configurations are returned.

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.

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

One or more filters to narrow the results. Supported filters include export status, creation date, and S3 bucket name.

max_results instance-attribute
max_results: int | None

The maximum number of results to return in a single call. If not specified, up to 1000 results are returned.

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 results.

DescribeCapacityManagerDataExportsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeCapacityManagerDataExportsInput structure.

Attributes

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

The IDs of the data export configurations to describe. If not specified, all export configurations are returned.

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.

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

One or more filters to narrow the results. Supported filters include export status, creation date, and S3 bucket name.

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

The maximum number of results to return in a single call. If not specified, up to 1000 results are returned.

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 results.

Output

DescribeCapacityManagerDataExportsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeCapacityManagerDataExportsOutput structure.

Attributes

capacity_manager_data_exports class-attribute instance-attribute
capacity_manager_data_exports: list[CapacityManagerDataExportResponse] | None = ...

Information about the data export configurations, including export settings, delivery status, and recent activity.

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.