Amazon Elastic Compute Cloud
CLI Reference (API Version 2012-04-01)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

ec2-describe-vpcs

Description

Gives you information about your VPCs. You can filter the results to return information only about VPCs that match criteria you specify. For example, you could get information only about VPCs whose state is available. You can specify multiple values for the filter. A VPC must match at least one of the specified values for it to be included in the results.

You can specify multiple filters (e.g., the VPC uses one of several sets of DHCP options, and the VPC's state is available). The result includes information for a particular VPC only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty.

You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.

The following table shows the available filters.

Filter Name Description

cidr

The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC.

Type: String

Constraints: Must contain the slash followed by one or two digits (e.g., /28)

dchp-options-id

The ID of a set of DHCP options.

Type: String

state

The state of the VPC.

Type: String

Valid Values: pending | available

tag-key

Key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter tag-key=Purpose and the filter tag-value=X, you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose=X, see the tag:key filter later in this table.

For more information about tags, go to Using Tags in the Amazon Elastic Compute Cloud User Guide.

Type: String

tag-value

Value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Type: String

tag:key

Filters the results based on a specific tag/value combination.

Example: To list just the resources assigned tag Purpose=X, then specify:

--filter tag:Purpose=X

Example: To list just resources assigned tag Purpose=X OR Purpose=Y, then specify:

--filter tag:Purpose=X --filter tag:Purpose=Y

vpc-id

ID of the VPC.

Type: String

The short version of this command is ec2dvpc.

Syntax

ec2-describe-vpcs [ vpc_id ... ] [[--filter name=value] ...]

Options

NameDescriptionRequired

vpc_id

The ID of a VPC you want information about.

Type: String

Default: Returns information about all your VPCs.

Example: vpc-1a2b3c4d

No

-F, --filter name=value

A filter for limiting the results. See the preceding table for a list of allowed filter names and values. You need to use quotation marks if the value string has a space (e.g., "name=value example"). If you're using the command line tools on a Windows system, you might need to use quotation marks, even when there is no space in the value string (e.g., "name=value").

Type: String

Default: Describes all VPCs you own, or only those otherwise specified.

Example: --filter "tag-key=Production"

No

Common Options

OptionDescription

--region REGION

Overrides the Region specified in the EC2_URL environment variable and the URL specified by the -U option.

Default: The EC2_URL environment variable, or us-east-1 if the environment variable is not set.

Example: --region eu-west-1

-U, --url URL

URL is the uniform resource locator of the Amazon EC2 web service entry point.

Default: The EC2_URL environment variable, or https://ec2.amazonaws.com if the environment variable is not set.

Example: -U https://ec2.amazonaws.com

-K, --private-key EC2-PRIVATE-KEY

The private key to use when constructing requests to Amazon EC2.

Default: The value of the EC2_PRIVATE_KEY environment variable.

Example: -K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-C, --cert EC2-CERT

The X.509 certificate to use when constructing requests to Amazon EC2.

Default: The value of the EC2_CERT environment variable.

Example: -C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

--connection-timeout TIMEOUT

Specifies a connection timeout (in seconds).

Example: --connection-timeout 30

--request-timeout TIMEOUT

Specifies a request timeout (in seconds).

Example: --request-timeout 45

-v, --verbose

Displays verbose output by showing the SOAP request and response on the command line. This is particularly useful if you are building tools to talk directly to our SOAP API.

-H, --headers

Displays column headers in the output.

--show-empty-fields

Shows empty columns as (nil).

--hide-tags

Do not display tags for tagged resources.

--debug

Prints internal debugging information. This is useful to assist us when troubleshooting problems.

-?, --help, -h

Displays Help.

-

If - is specified as an argument to one of the parameters, a list of arguments is read from standard input. This is useful for piping the output of one command into the input of another.

Example: ec2-describe-instances | grep stopped | cut -f 2 | ec2-start-instances -

Output

The command returns a table that contains the following information:

  • Output type identifier ("VPC")

  • VPC ID

  • CIDR block of the VPC

  • The current state of the VPC (pending or available)

  • ID of the DHCP options associated with the VPC (or default if none)

  • Any tags assigned to the VPC

  • The allowed tenancy of instances launched into the VPC.

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example gives a description of the VPC with ID vpc-1a2b3c4d.

PROMPT> ec2-describe-vpcs vpc-1a2b3c4d 
					VPC  vpc-1a2b3c4d   available  10.0.0.0/23  dopt-7a8b9c2d 

Example Request

This example uses filters to give a description of any VPC you own that uses the set of DHCP options with ID dopt-7a8b9c2d or dopt-2b2a3d3c and whose state is available.

PROMPT> ec2-describe-vpcs --filter "dhcp-options-id=dopt-7a8b9c2d" --filter "dhcp-options-id=dopt-2b2a3d3c"  --filter "state=available" 
VPC  vpc-1a2b3c4d  available  10.0.0.0/23  dopt-7a8b9c2d