describe_vpc_block_public_access_exclusions¶
Operation¶
describe_vpc_block_public_access_exclusions
¶
describe_vpc_block_public_access_exclusions(request: DescribeVpcBlockPublicAccessExclusionsInput | DescribeVpcBlockPublicAccessExclusionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpcBlockPublicAccessExclusionsInputDict]) -> DescribeVpcBlockPublicAccessExclusionsOutput
Describe VPC Block Public Access (BPA) exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account's BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeVpcBlockPublicAccessExclusionsInput | DescribeVpcBlockPublicAccessExclusionsInputDict | 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[DescribeVpcBlockPublicAccessExclusionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeVpcBlockPublicAccessExclusionsOutput
|
An instance of |
describe_vpc_block_public_access_exclusions
async
¶
describe_vpc_block_public_access_exclusions(request: DescribeVpcBlockPublicAccessExclusionsInput | DescribeVpcBlockPublicAccessExclusionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpcBlockPublicAccessExclusionsInputDict]) -> DescribeVpcBlockPublicAccessExclusionsOutput
Describe VPC Block Public Access (BPA) exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account's BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeVpcBlockPublicAccessExclusionsInput | DescribeVpcBlockPublicAccessExclusionsInputDict | 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[DescribeVpcBlockPublicAccessExclusionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeVpcBlockPublicAccessExclusionsOutput
|
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.
DescribeVpcBlockPublicAccessExclusionsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeVpcBlockPublicAccessExclusionsInput.
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.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
Filters for the request:
-
resource-arn- The Amazon Resource Name (ARN) of a exclusion. -
internet-gateway-exclusion-mode- The mode of a VPC BPA exclusion. Possible values:allow-bidirectional | allow-egress. -
state- The state of VPC BPA. Possible values:create-in-progress | create-complete | update-in-progress | update-complete | delete-in-progress | deleted-complete | disable-in-progress | disable-complete -
tag- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
tag-value: The value of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific value, regardless of the tag key.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
DescribeVpcBlockPublicAccessExclusionsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVpcBlockPublicAccessExclusionsInput 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.
exclusion_ids
class-attribute
instance-attribute
¶
IDs of exclusions.
filters
class-attribute
instance-attribute
¶
Filters for the request:
-
resource-arn- The Amazon Resource Name (ARN) of a exclusion. -
internet-gateway-exclusion-mode- The mode of a VPC BPA exclusion. Possible values:allow-bidirectional | allow-egress. -
state- The state of VPC BPA. Possible values:create-in-progress | create-complete | update-in-progress | update-complete | delete-in-progress | deleted-complete | disable-in-progress | disable-complete -
tag- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
tag-value: The value of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific value, regardless of the tag key.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Output¶
DescribeVpcBlockPublicAccessExclusionsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVpcBlockPublicAccessExclusionsOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to include in another request to get the next page of items.
This value is null when there are no more items to return.
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.
vpc_block_public_access_exclusions
class-attribute
instance-attribute
¶
vpc_block_public_access_exclusions: list[VpcBlockPublicAccessExclusion] | None = ...
Details related to the exclusions.