Skip to content

EC2  >  Operations  >  get_image_block_public_access_state

get_image_block_public_access_state

Operation

get_image_block_public_access_state async

get_image_block_public_access_state(request: GetImageBlockPublicAccessStateInput | GetImageBlockPublicAccessStateInputDict, /, *, plugins: list[Plugin] | None = None) -> GetImageBlockPublicAccessStateOutput
get_image_block_public_access_state(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetImageBlockPublicAccessStateInputDict]) -> GetImageBlockPublicAccessStateOutput

Gets the current state of block public access for AMIs at the account level in the specified Amazon Web Services Region.

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
GetImageBlockPublicAccessStateOutput

An instance of GetImageBlockPublicAccessStateOutput.

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

GetImageBlockPublicAccessStateInput dataclass

Bases: _SerdeShape

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

Dictionaries

GetImageBlockPublicAccessStateInputDict

Bases: TypedDict

Dictionary form of GetImageBlockPublicAccessStateInput.

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.

Output

GetImageBlockPublicAccessStateOutput dataclass

Bases: _SerdeShape

Dataclass for GetImageBlockPublicAccessStateOutput structure.

Attributes

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

The current state of block public access for AMIs at the account level in the specified Amazon Web Services Region.

Possible values:

  • block-new-sharing - Any attempt to publicly share your AMIs in the specified Region is blocked.

  • unblocked - Your AMIs in the specified Region can be publicly shared.

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

The entity that manages the state for block public access for AMIs. Possible values include:

  • account - The state is managed by the account.

  • declarative-policy - The state is managed by a declarative policy and can't be modified by the account.

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.