EC2 / Client / describe_vpc_encryption_controls

describe_vpc_encryption_controls¶

EC2.Client.describe_vpc_encryption_controls(**kwargs)¶

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.

Request Syntax

response = client.describe_vpc_encryption_controls(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    VpcEncryptionControlIds=[
        'string',
    ],
    VpcIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)

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.
Filters (list) –
The filters to apply to the request.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    - (string) –
VpcEncryptionControlIds (list) –
The IDs of the VPC Encryption Control configurations to describe.
- (string) –
VpcIds (list) –
The IDs of the VPCs to describe encryption control configurations for.
- (string) –
NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'VpcEncryptionControls': [
        {
            'VpcId': 'string',
            'VpcEncryptionControlId': 'string',
            'Mode': 'monitor'|'enforce',
            'State': 'enforce-in-progress'|'monitor-in-progress'|'enforce-failed'|'monitor-failed'|'deleting'|'deleted'|'available'|'creating'|'delete-failed',
            'StateMessage': 'string',
            'ResourceExclusions': {
                'InternetGateway': {
                    'State': 'enabling'|'enabled'|'disabling'|'disabled',
                    'StateMessage': 'string'
                },
                'EgressOnlyInternetGateway': {
                    'State': 'enabling'|'enabled'|'disabling'|'disabled',
                    'StateMessage': 'string'
                },
                'NatGateway': {
                    'State': 'enabling'|'enabled'|'disabling'|'disabled',
                    'StateMessage': 'string'
                },
                'VirtualPrivateGateway': {
                    'State': 'enabling'|'enabled'|'disabling'|'disabled',
                    'StateMessage': 'string'
                },
                'VpcPeering': {
                    'State': 'enabling'|'enabled'|'disabling'|'disabled',
                    'StateMessage': 'string'
                },
                'Lambda': {
                    'State': 'enabling'|'enabled'|'disabling'|'disabled',
                    'StateMessage': 'string'
                },
                'VpcLattice': {
                    'State': 'enabling'|'enabled'|'disabling'|'disabled',
                    'StateMessage': 'string'
                },
                'ElasticFileSystem': {
                    'State': 'enabling'|'enabled'|'disabling'|'disabled',
                    'StateMessage': 'string'
                }
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- VpcEncryptionControls (list) –
  
  Information about the VPC Encryption Control configurations.
  - (dict) –
    
    Describes the configuration and state of VPC encryption controls.
    
    For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
    - VpcId (string) –
      
      The ID of the VPC associated with the encryption control configuration.
    - VpcEncryptionControlId (string) –
      
      The ID of the VPC Encryption Control configuration.
    - Mode (string) –
      
      The encryption mode for the VPC Encryption Control configuration.
    - State (string) –
      
      The current state of the VPC Encryption Control configuration.
    - StateMessage (string) –
      
      A message providing additional information about the encryption control state.
    - ResourceExclusions (dict) –
      
      Information about resource exclusions for the VPC Encryption Control configuration.
      - InternetGateway (dict) –
        
        The exclusion configuration for internet gateway traffic.
        
        State (string) –
        
        The current state of the exclusion configuration.
        
        StateMessage (string) –
        
        A message providing additional information about the exclusion state.
      - EgressOnlyInternetGateway (dict) –
        
        The exclusion configuration for egress-only internet gateway traffic.
        
        State (string) –
        
        The current state of the exclusion configuration.
        
        StateMessage (string) –
        
        A message providing additional information about the exclusion state.
      - NatGateway (dict) –
        
        The exclusion configuration for NAT gateway traffic.
        
        State (string) –
        
        The current state of the exclusion configuration.
        
        StateMessage (string) –
        
        A message providing additional information about the exclusion state.
      - VirtualPrivateGateway (dict) –
        
        The exclusion configuration for virtual private gateway traffic.
        
        State (string) –
        
        The current state of the exclusion configuration.
        
        StateMessage (string) –
        
        A message providing additional information about the exclusion state.
      - VpcPeering (dict) –
        
        The exclusion configuration for VPC peering connection traffic.
        
        State (string) –
        
        The current state of the exclusion configuration.
        
        StateMessage (string) –
        
        A message providing additional information about the exclusion state.
      - Lambda (dict) –
        
        The exclusion configuration for Lambda function traffic.
        
        State (string) –
        
        The current state of the exclusion configuration.
        
        StateMessage (string) –
        
        A message providing additional information about the exclusion state.
      - VpcLattice (dict) –
        
        The exclusion configuration for VPC Lattice traffic.
        
        State (string) –
        
        The current state of the exclusion configuration.
        
        StateMessage (string) –
        
        A message providing additional information about the exclusion state.
      - ElasticFileSystem (dict) –
        
        The exclusion configuration for Elastic File System traffic.
        
        State (string) –
        
        The current state of the exclusion configuration.
        
        StateMessage (string) –
        
        A message providing additional information about the exclusion state.
    - Tags (list) –
      
      The tags assigned to the VPC Encryption Control configuration.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
- NextToken (string) –
  
  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.