EC2 / Client / get_snapshot_block_public_access_state

get_snapshot_block_public_access_state#

EC2.Client.get_snapshot_block_public_access_state(**kwargs)#

Gets the current state of block public access for snapshots setting for the account and Region.

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

See also: AWS API Documentation

Request Syntax

response = client.get_snapshot_block_public_access_state(
    DryRun=True|False
)
Parameters:

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

{
    'State': 'block-all-sharing'|'block-new-sharing'|'unblocked',
    'ManagedBy': 'account'|'declarative-policy'
}

Response Structure

  • (dict) –

    • State (string) –

      The current state of block public access for snapshots. Possible values include:

      • block-all-sharing - All public sharing of snapshots is blocked. Users in the account can’t request new public sharing. Additionally, snapshots that were already publicly shared are treated as private and are not publicly available.

      • block-new-sharing - Only new public sharing of snapshots is blocked. Users in the account can’t request new public sharing. However, snapshots that were already publicly shared, remain publicly available.

      • unblocked - Public sharing is not blocked. Users can publicly share snapshots.

    • ManagedBy (string) –

      The entity that manages the state for block public access for snapshots. 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.