AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
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.
See also: AWS API Documentation
describe-vpc-peering-connections
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: VpcPeeringConnections
describe-vpc-peering-connections
[--dry-run | --no-dry-run]
[--vpc-peering-connection-ids <value>]
[--filters <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--dry-run
| --no-dry-run
(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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.
--vpc-peering-connection-ids
(list)
The IDs of the VPC peering connections.
Default: Describes all your VPC peering connections.
(string)
Syntax:
"string" "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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.(structure)
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.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)
Shorthand Syntax:
Name=string,Values=string,string ...
JSON Syntax:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command's output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command's output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To describe your VPC peering connections
This example describes all of your VPC peering connections.
Command:
aws ec2 describe-vpc-peering-connections
Output:
{
"VpcPeeringConnections": [
{
"Status": {
"Message": "Active",
"Code": "active"
},
"Tags": [
{
"Value": "Peering-1",
"Key": "Name"
}
],
"AccepterVpcInfo": {
"OwnerId": "111122223333",
"VpcId": "vpc-1a2b3c4d",
"CidrBlock": "10.0.1.0/28"
},
"VpcPeeringConnectionId": "pcx-11122233",
"RequesterVpcInfo": {
"PeeringOptions": {
"AllowEgressFromLocalVpcToRemoteClassicLink": false,
"AllowEgressFromLocalClassicLinkToRemoteVpc": false
},
"OwnerId": "444455556666",
"VpcId": "vpc-123abc45",
"CidrBlock": "192.168.0.0/16"
}
},
{
"Status": {
"Message": "Pending Acceptance by 444455556666",
"Code": "pending-acceptance"
},
"Tags": [],
"RequesterVpcInfo": {
"PeeringOptions": {
"AllowEgressFromLocalVpcToRemoteClassicLink": false,
"AllowEgressFromLocalClassicLinkToRemoteVpc": false
},
"OwnerId": "444455556666",
"VpcId": "vpc-11aa22bb",
"CidrBlock": "10.0.0.0/28"
},
"VpcPeeringConnectionId": "pcx-abababab",
"ExpirationTime": "2014-04-03T09:12:43.000Z",
"AccepterVpcInfo": {
"OwnerId": "444455556666",
"VpcId": "vpc-33cc44dd"
}
}
]
}
To describe specific VPC peering connections
This example describes all of your VPC peering connections that are in the pending-acceptance state.
Command:
aws ec2 describe-vpc-peering-connections --filters Name=status-code,Values=pending-acceptance
This example describes all of your VPC peering connections that have the tag Owner=Finance.
Command:
aws ec2 describe-vpc-peering-connections --filters Name=tag:Owner,Values=Finance
This example describes all of the VPC peering connections you requested for the specified VPC, vpc-1a2b3c4d.
Command:
aws ec2 describe-vpc-peering-connections --filters Name=requester-vpc-info.vpc-id,Values=vpc-1a2b3c4d
VpcPeeringConnections -> (list)
Information about the VPC peering connections.
(structure)
Describes a VPC peering connection.
AccepterVpcInfo -> (structure)
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.
(structure)
Describes an IPv6 CIDR block.
Ipv6CidrBlock -> (string)
The IPv6 CIDR block.CidrBlockSet -> (list)
Information about the IPv4 CIDR blocks for the VPC.
(structure)
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 -> (structure)
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 -> (timestamp)
The time that an unaccepted VPC peering connection will expire.RequesterVpcInfo -> (structure)
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.
(structure)
Describes an IPv6 CIDR block.
Ipv6CidrBlock -> (string)
The IPv6 CIDR block.CidrBlockSet -> (list)
Information about the IPv4 CIDR blocks for the VPC.
(structure)
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 -> (structure)
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 -> (structure)
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.
(structure)
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 isnull
when there are no more items to return.