Skip to content

describe_vpc_block_public_access_options

Operation

describe_vpc_block_public_access_options

Describe VPC Block Public Access (BPA) options. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. 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 DescribeVpcBlockPublicAccessOptionsInput | DescribeVpcBlockPublicAccessOptionsInputDict | 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[DescribeVpcBlockPublicAccessOptionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeVpcBlockPublicAccessOptionsOutput

An instance of DescribeVpcBlockPublicAccessOptionsOutput.

describe_vpc_block_public_access_options async

Describe VPC Block Public Access (BPA) options. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. 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 DescribeVpcBlockPublicAccessOptionsInput | DescribeVpcBlockPublicAccessOptionsInputDict | 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[DescribeVpcBlockPublicAccessOptionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeVpcBlockPublicAccessOptionsOutput

An instance of DescribeVpcBlockPublicAccessOptionsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeVpcBlockPublicAccessOptionsInputDict

Bases: TypedDict

Dictionary form of DescribeVpcBlockPublicAccessOptionsInput.

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.

DescribeVpcBlockPublicAccessOptionsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeVpcBlockPublicAccessOptionsInput 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

DescribeVpcBlockPublicAccessOptionsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeVpcBlockPublicAccessOptionsOutput structure.

Attributes

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.

vpc_block_public_access_options class-attribute instance-attribute
vpc_block_public_access_options: VpcBlockPublicAccessOptions | None = ...

Details related to the options.