Skip to content

EC2  >  Operations  >  enable_image_block_public_access

enable_image_block_public_access

Operation

enable_image_block_public_access async

enable_image_block_public_access(request: EnableImageBlockPublicAccessInput | EnableImageBlockPublicAccessInputDict, /, *, plugins: list[Plugin] | None = None) -> EnableImageBlockPublicAccessOutput
enable_image_block_public_access(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableImageBlockPublicAccessInputDict]) -> EnableImageBlockPublicAccessOutput

Enables block public access for AMIs at the account level in the specified Amazon Web Services Region. This prevents the public sharing of your AMIs. However, if you already have public AMIs, they will remain publicly available.

The API can take up to 10 minutes to configure this setting. During this time, if you run GetImageBlockPublicAccessState, the response will be unblocked. When the API has completed the configuration, the response will be block-new-sharing.

For more information, see Block public access to your AMIs in the Amazon EC2 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
EnableImageBlockPublicAccessOutput

An instance of EnableImageBlockPublicAccessOutput.

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

EnableImageBlockPublicAccessInput dataclass

Bases: _SerdeShape

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

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

Specify block-new-sharing to enable block public access for AMIs at the account level in the specified Region. This will block any attempt to publicly share your AMIs in the specified Region.

Dictionaries

EnableImageBlockPublicAccessInputDict

Bases: TypedDict

Dictionary form of EnableImageBlockPublicAccessInput.

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.

image_block_public_access_state instance-attribute
image_block_public_access_state: Required[str]

Specify block-new-sharing to enable block public access for AMIs at the account level in the specified Region. This will block any attempt to publicly share your AMIs in the specified Region.

Output

EnableImageBlockPublicAccessOutput dataclass

Bases: _SerdeShape

Dataclass for EnableImageBlockPublicAccessOutput structure.

Attributes

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

Returns block-new-sharing if the request succeeds; otherwise, it returns an error.

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.