get_snapshot_block_public_access_state¶
Operation¶
get_snapshot_block_public_access_state
¶
get_snapshot_block_public_access_state(request: GetSnapshotBlockPublicAccessStateInput | GetSnapshotBlockPublicAccessStateInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSnapshotBlockPublicAccessStateInputDict]) -> GetSnapshotBlockPublicAccessStateOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetSnapshotBlockPublicAccessStateInput | GetSnapshotBlockPublicAccessStateInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetSnapshotBlockPublicAccessStateInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetSnapshotBlockPublicAccessStateOutput
|
An instance of |
get_snapshot_block_public_access_state
async
¶
get_snapshot_block_public_access_state(request: GetSnapshotBlockPublicAccessStateInput | GetSnapshotBlockPublicAccessStateInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSnapshotBlockPublicAccessStateInputDict]) -> GetSnapshotBlockPublicAccessStateOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetSnapshotBlockPublicAccessStateInput | GetSnapshotBlockPublicAccessStateInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetSnapshotBlockPublicAccessStateInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetSnapshotBlockPublicAccessStateOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetSnapshotBlockPublicAccessStateInputDict
¶
Bases: TypedDict
Dictionary form of GetSnapshotBlockPublicAccessStateInput.
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.
GetSnapshotBlockPublicAccessStateInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetSnapshotBlockPublicAccessStateInput 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.
Output¶
GetSnapshotBlockPublicAccessStateOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetSnapshotBlockPublicAccessStateOutput structure.
Attributes¶
managed_by
class-attribute
instance-attribute
¶
managed_by: str | None = ...
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.
response_metadata
class-attribute
instance-attribute
¶
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 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.