EC2 / Client / enable_image_block_public_access

enable_image_block_public_access#

EC2.Client.enable_image_block_public_access(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.enable_image_block_public_access(
    ImageBlockPublicAccessState='block-new-sharing',
    DryRun=True|False
)
Parameters:

  • ImageBlockPublicAccessState (string) –

    [REQUIRED]

    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.

  • DryRun (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.

Return type:

dict

Returns:

Response Syntax

{
    'ImageBlockPublicAccessState': 'block-new-sharing'
}

Response Structure

  • (dict) –

    • ImageBlockPublicAccessState (string) –

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