Skip to content

EC2  >  Operations  >  describe_vpc_encryption_controls

describe_vpc_encryption_controls

Operation

describe_vpc_encryption_controls async

describe_vpc_encryption_controls(request: DescribeVpcEncryptionControlsInput | DescribeVpcEncryptionControlsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeVpcEncryptionControlsOutput
describe_vpc_encryption_controls(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpcEncryptionControlsInputDict]) -> DescribeVpcEncryptionControlsOutput

Describes one or more VPC Encryption Control configurations. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements You can filter the results to return information about specific encryption controls or VPCs.

For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.

Parameters:

Name Type Description Default
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

Returns:

Type Description
DescribeVpcEncryptionControlsOutput

An instance of DescribeVpcEncryptionControlsOutput.

Input

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

Model

DescribeVpcEncryptionControlsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeVpcEncryptionControlsInput 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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

The filters to apply to the request.

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.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

vpc_encryption_control_ids class-attribute instance-attribute
vpc_encryption_control_ids: list[str] | None = ...

The IDs of the VPC Encryption Control configurations to describe.

vpc_ids class-attribute instance-attribute
vpc_ids: list[str] | None = ...

The IDs of the VPCs to describe encryption control configurations for.

Dictionaries

DescribeVpcEncryptionControlsInputDict

Bases: TypedDict

Dictionary form of DescribeVpcEncryptionControlsInput.

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

The filters to apply to the request.

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.

next_token instance-attribute
next_token: str | None

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

vpc_encryption_control_ids instance-attribute
vpc_encryption_control_ids: Sequence[str] | None

The IDs of the VPC Encryption Control configurations to describe.

vpc_ids instance-attribute
vpc_ids: Sequence[str] | None

The IDs of the VPCs to describe encryption control configurations for.

Output

DescribeVpcEncryptionControlsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeVpcEncryptionControlsOutput 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
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_encryption_controls class-attribute instance-attribute
vpc_encryption_controls: list[VpcEncryptionControl] | None = ...

Information about the VPC Encryption Control configurations.