Skip to content

describe_snapshot_tier_status

Operation

describe_snapshot_tier_status

describe_snapshot_tier_status(request: DescribeSnapshotTierStatusInput | DescribeSnapshotTierStatusInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeSnapshotTierStatusInputDict]) -> DescribeSnapshotTierStatusOutput

Describes the storage tier status of one or more Amazon EBS snapshots.

Parameters:

Name Type Description Default
request DescribeSnapshotTierStatusInput | DescribeSnapshotTierStatusInputDict | 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[DescribeSnapshotTierStatusInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeSnapshotTierStatusOutput

An instance of DescribeSnapshotTierStatusOutput.

describe_snapshot_tier_status async

describe_snapshot_tier_status(request: DescribeSnapshotTierStatusInput | DescribeSnapshotTierStatusInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeSnapshotTierStatusInputDict]) -> DescribeSnapshotTierStatusOutput

Describes the storage tier status of one or more Amazon EBS snapshots.

Parameters:

Name Type Description Default
request DescribeSnapshotTierStatusInput | DescribeSnapshotTierStatusInputDict | 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[DescribeSnapshotTierStatusInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeSnapshotTierStatusOutput

An instance of DescribeSnapshotTierStatusOutput.

Input

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

DescribeSnapshotTierStatusInputDict

Bases: TypedDict

Dictionary form of DescribeSnapshotTierStatusInput.

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.

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

The filters.

  • snapshot-id - The snapshot ID.

  • volume-id - The ID of the volume the snapshot is for.

  • last-tiering-operation - The state of the last archive or restore action. (archival-in-progress | archival-completed | archival-failed | permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed | temporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed)

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.

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.

DescribeSnapshotTierStatusInput dataclass

Bases: _SerdeShape

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

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

The filters.

  • snapshot-id - The snapshot ID.

  • volume-id - The ID of the volume the snapshot is for.

  • last-tiering-operation - The state of the last archive or restore action. (archival-in-progress | archival-completed | archival-failed | permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed | temporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed)

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.

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

DescribeSnapshotTierStatusOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeSnapshotTierStatusOutput structure.

Attributes

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.

snapshot_tier_statuses class-attribute instance-attribute
snapshot_tier_statuses: list[SnapshotTierStatus] | None = ...

Information about the snapshot's storage tier.