EC2 / Client / describe_vpc_peering_connections

describe_vpc_peering_connections#

EC2.Client.describe_vpc_peering_connections(**kwargs)#

Describes your VPC peering connections. The default is to describe all your VPC peering connections. Alternatively, you can specify specific VPC peering connection IDs or filter the results to include only the VPC peering connections that match specific criteria.

Request Syntax

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

Parameters:

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.
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.
VpcPeeringConnectionIds (list) –
The IDs of the VPC peering connections.

Default: Describes all your VPC peering connections.
- (string) –
Filters (list) –
The filters.
- accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
- accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.
- accepter-vpc-info.vpc-id - The ID of the accepter VPC.
- expiration-time - The expiration date and time for the VPC peering connection.
- requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester’s VPC.
- requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.
- requester-vpc-info.vpc-id - The ID of the requester VPC.
- status-code - The status of the VPC peering connection ( pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).
- status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
- 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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for 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.
- vpc-peering-connection-id - The ID of the VPC peering connection.
- (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) –

Return type:

dict

Returns:

Response Syntax

{
    'VpcPeeringConnections': [
        {
            'AccepterVpcInfo': {
                'CidrBlock': 'string',
                'Ipv6CidrBlockSet': [
                    {
                        'Ipv6CidrBlock': 'string'
                    },
                ],
                'CidrBlockSet': [
                    {
                        'CidrBlock': 'string'
                    },
                ],
                'OwnerId': 'string',
                'PeeringOptions': {
                    'AllowDnsResolutionFromRemoteVpc': True|False,
                    'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
                    'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
                },
                'VpcId': 'string',
                'Region': 'string'
            },
            'ExpirationTime': datetime(2015, 1, 1),
            'RequesterVpcInfo': {
                'CidrBlock': 'string',
                'Ipv6CidrBlockSet': [
                    {
                        'Ipv6CidrBlock': 'string'
                    },
                ],
                'CidrBlockSet': [
                    {
                        'CidrBlock': 'string'
                    },
                ],
                'OwnerId': 'string',
                'PeeringOptions': {
                    'AllowDnsResolutionFromRemoteVpc': True|False,
                    'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False,
                    'AllowEgressFromLocalVpcToRemoteClassicLink': True|False
                },
                'VpcId': 'string',
                'Region': 'string'
            },
            'Status': {
                'Code': 'initiating-request'|'pending-acceptance'|'active'|'deleted'|'rejected'|'failed'|'expired'|'provisioning'|'deleting',
                'Message': 'string'
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VpcPeeringConnectionId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- VpcPeeringConnections (list) –
  
  Information about the VPC peering connections.
  - (dict) –
    
    Describes a VPC peering connection.
    - AccepterVpcInfo (dict) –
      
      Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
      - CidrBlock (string) –
        
        The IPv4 CIDR block for the VPC.
      - Ipv6CidrBlockSet (list) –
        
        The IPv6 CIDR block for the VPC.
        
        (dict) –
        
        Describes an IPv6 CIDR block.
        
        Ipv6CidrBlock (string) –
        
        The IPv6 CIDR block.
      - CidrBlockSet (list) –
        
        Information about the IPv4 CIDR blocks for the VPC.
        
        (dict) –
        
        Describes an IPv4 CIDR block.
        
        CidrBlock (string) –
        
        The IPv4 CIDR block.
      - OwnerId (string) –
        
        The ID of the Amazon Web Services account that owns the VPC.
      - PeeringOptions (dict) –
        
        Information about the VPC peering connection options for the accepter or requester VPC.
        
        AllowDnsResolutionFromRemoteVpc (boolean) –
        
        Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
        
        AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) –
        
        Deprecated.
        
        AllowEgressFromLocalVpcToRemoteClassicLink (boolean) –
        
        Deprecated.
      - VpcId (string) –
        
        The ID of the VPC.
      - Region (string) –
        
        The Region in which the VPC is located.
    - ExpirationTime (datetime) –
      
      The time that an unaccepted VPC peering connection will expire.
    - RequesterVpcInfo (dict) –
      
      Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
      - CidrBlock (string) –
        
        The IPv4 CIDR block for the VPC.
      - Ipv6CidrBlockSet (list) –
        
        The IPv6 CIDR block for the VPC.
        
        (dict) –
        
        Describes an IPv6 CIDR block.
        
        Ipv6CidrBlock (string) –
        
        The IPv6 CIDR block.
      - CidrBlockSet (list) –
        
        Information about the IPv4 CIDR blocks for the VPC.
        
        (dict) –
        
        Describes an IPv4 CIDR block.
        
        CidrBlock (string) –
        
        The IPv4 CIDR block.
      - OwnerId (string) –
        
        The ID of the Amazon Web Services account that owns the VPC.
      - PeeringOptions (dict) –
        
        Information about the VPC peering connection options for the accepter or requester VPC.
        
        AllowDnsResolutionFromRemoteVpc (boolean) –
        
        Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
        
        AllowEgressFromLocalClassicLinkToRemoteVpc (boolean) –
        
        Deprecated.
        
        AllowEgressFromLocalVpcToRemoteClassicLink (boolean) –
        
        Deprecated.
      - VpcId (string) –
        
        The ID of the VPC.
      - Region (string) –
        
        The Region in which the VPC is located.
    - Status (dict) –
      
      The status of the VPC peering connection.
      - Code (string) –
        
        The status of the VPC peering connection.
      - Message (string) –
        
        A message that provides more information about the status, if applicable.
    - Tags (list) –
      
      Any tags assigned to the resource.
      - (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.
    - VpcPeeringConnectionId (string) –
      
      The ID of the VPC peering connection.
- 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.