Skip to content

describe_locked_snapshots

Operation

describe_locked_snapshots

describe_locked_snapshots(request: DescribeLockedSnapshotsInput | DescribeLockedSnapshotsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeLockedSnapshotsInputDict]) -> DescribeLockedSnapshotsOutput

Describes the lock status for a snapshot.

Parameters:

Name Type Description Default
request DescribeLockedSnapshotsInput | DescribeLockedSnapshotsInputDict | 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[DescribeLockedSnapshotsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeLockedSnapshotsOutput

An instance of DescribeLockedSnapshotsOutput.

describe_locked_snapshots async

describe_locked_snapshots(request: DescribeLockedSnapshotsInput | DescribeLockedSnapshotsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeLockedSnapshotsInputDict]) -> DescribeLockedSnapshotsOutput

Describes the lock status for a snapshot.

Parameters:

Name Type Description Default
request DescribeLockedSnapshotsInput | DescribeLockedSnapshotsInputDict | 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[DescribeLockedSnapshotsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeLockedSnapshotsOutput

An instance of DescribeLockedSnapshotsOutput.

Input

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

DescribeLockedSnapshotsInputDict

Bases: TypedDict

Dictionary form of DescribeLockedSnapshotsInput.

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.

  • lock-state - The state of the snapshot lock (compliance-cooloff | governance | compliance | expired).
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.

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

The IDs of the snapshots for which to view the lock status.

DescribeLockedSnapshotsInput dataclass

Bases: _SerdeShape

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

  • lock-state - The state of the snapshot lock (compliance-cooloff | governance | compliance | expired).
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.

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

The IDs of the snapshots for which to view the lock status.

Output

DescribeLockedSnapshotsOutput dataclass

Bases: _SerdeShape

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

snapshots class-attribute instance-attribute
snapshots: list[LockedSnapshotsInfo] | None = ...

Information about the snapshots.