Skip to content

EC2  >  Operations  >  enable_snapshot_block_public_access

enable_snapshot_block_public_access

Operation

enable_snapshot_block_public_access async

enable_snapshot_block_public_access(request: EnableSnapshotBlockPublicAccessInput | EnableSnapshotBlockPublicAccessInputDict, /, *, plugins: list[Plugin] | None = None) -> EnableSnapshotBlockPublicAccessOutput
enable_snapshot_block_public_access(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableSnapshotBlockPublicAccessInputDict]) -> EnableSnapshotBlockPublicAccessOutput

Enables or modifies the block public access for snapshots setting at the account level for the specified Amazon Web Services Region. After you enable block public access for snapshots in a Region, users can no longer request public sharing for snapshots in that Region. Snapshots that are already publicly shared are either treated as private or they remain publicly shared, depending on the State that you specify.

Warning

Enabling block public access for snapshots in block all sharing mode does not change the permissions for snapshots that are already publicly shared. Instead, it prevents these snapshots from be publicly visible and publicly accessible. Therefore, the attributes for these snapshots still indicate that they are publicly shared, even though they are not publicly available.

If you later disable block public access or change the mode to block new sharing, these snapshots will become publicly available again.

For more information, see Block public access for snapshots in the Amazon EBS User Guide.

Parameters:

Name Type Description Default
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

Returns:

Type Description
EnableSnapshotBlockPublicAccessOutput

An instance of EnableSnapshotBlockPublicAccessOutput.

Input

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

Model

EnableSnapshotBlockPublicAccessInput dataclass

Bases: _SerdeShape

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

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

The mode in which to enable block public access for snapshots for the Region. Specify one of the following values:

  • block-all-sharing - Prevents all public sharing of snapshots in the Region. Users in the account will no longer be able to request new public sharing. Additionally, snapshots that are already publicly shared are treated as private and they are no longer publicly available.

  • block-new-sharing - Prevents only new public sharing of snapshots in the Region. Users in the account will no longer be able to request new public sharing. However, snapshots that are already publicly shared, remain publicly available.

unblocked is not a valid value for EnableSnapshotBlockPublicAccess.

Dictionaries

EnableSnapshotBlockPublicAccessInputDict

Bases: TypedDict

Dictionary form of EnableSnapshotBlockPublicAccessInput.

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.

state instance-attribute
state: Required[str]

The mode in which to enable block public access for snapshots for the Region. Specify one of the following values:

  • block-all-sharing - Prevents all public sharing of snapshots in the Region. Users in the account will no longer be able to request new public sharing. Additionally, snapshots that are already publicly shared are treated as private and they are no longer publicly available.

  • block-new-sharing - Prevents only new public sharing of snapshots in the Region. Users in the account will no longer be able to request new public sharing. However, snapshots that are already publicly shared, remain publicly available.

unblocked is not a valid value for EnableSnapshotBlockPublicAccess.

Output

EnableSnapshotBlockPublicAccessOutput dataclass

Bases: _SerdeShape

Dataclass for EnableSnapshotBlockPublicAccessOutput structure.

Attributes

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.

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

The state of block public access for snapshots for the account and Region. Returns either block-all-sharing or block-new-sharing if the request succeeds.