Skip to content

DescribeLockedSnapshotsRequest

Source code in docs_src/capo_ec2/types/describe_locked_snapshots_request.py
class DescribeLockedSnapshotsRequest(TypedDict, closed=True):
    filters: NotRequired["capo_ec2.types.filter_list.FilterList"]
    """<p>The filters.</p> <ul> <li> <p> <code>lock-state</code> - The state of the snapshot lock (<code>compliance-cooloff</code> | <code>governance</code> | <code>compliance</code> | <code>expired</code>).</p> </li> </ul>"""
    max_results: NotRequired[
        "capo_ec2.types.describe_locked_snapshots_max_results.DescribeLockedSnapshotsMaxResults"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>"""
    next_token: NotRequired["capo_ec2.types.string.String"]
    """<p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>"""
    snapshot_ids: NotRequired[
        "capo_ec2.types.snapshot_id_string_list.SnapshotIdStringList"
    ]
    """<p>The IDs of the snapshots for which to view the lock status.</p>"""
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""

dry_run instance-attribute

dry_run: NotRequired[Boolean]

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: NotRequired[FilterList]

The filters.

  • lock-state - The state of the snapshot lock (compliance-cooloff | governance | compliance | expired).

max_results instance-attribute

max_results: NotRequired[DescribeLockedSnapshotsMaxResults]

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: NotRequired[String]

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: NotRequired[SnapshotIdStringList]

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