| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
ec2-describe-regions
Description
Describes one or more of the regions that are available to you.
For a list of the regions supported by Amazon EC2, see Regions and Endpoints.
The short version of this command is ec2dre.
Syntax
ec2-describe-regions
[
region...]
[[--filter "name=value"] ...]
Options
| Name | Description |
|---|---|
|
|
One or more region names. Type: String Default: Describes all your regions. Required: No Example: eu-west-1 |
|
|
A filter for limiting the results. See the Supported Filters section for a list of supported filters. Use quotation marks if the value string has a space ("name=value example"). On a Windows system, use quotation marks even without a space in the value string ("name=value"). Type: String Default: Describes all your regions, or only those you specified by name. Required: No Example: --filter "endpoint=*ap*" |
Supported Filters
You can specify filters so that the response includes information for only certain regions.
You can use wildcards in a filter value. An asterisk (*) matches zero or more characters, and a question mark (?) 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 are the available filters.
endpointThe endpoint of the region (for example, ec2.us-east-1.amazonaws.com).
Type: String
region-nameThe name of the region.
Type: String
Common Options
| Option | Description |
|---|---|
|
|
Overrides the region specified by the Default: The value of the Example: |
|
|
The uniform resource locator (URL) of the Amazon EC2 web service entry point. Default: The value of the Example: |
|
|
The private key that identifies you to Amazon EC2. For more information, see Tell the Tools Who You Are. Default: The value of the Example: |
|
|
The X.509 certificate that identifies you to Amazon EC2. Default: The value of the Example: |
|
|
The access key ID associated with your AWS account. For more information, see Tell the Tools Who You Are. Default: The value of the Example: Note For more information, see the following section, Deprecated Options. |
|
|
The secret access key associated with your AWS account. Default: The value of the Example: Note For more information, see the following section, Deprecated Options. |
|
|
The AWS delegation token. Default: The value of the environment variable (if set). |
|
|
The connection timeout, in seconds. Example: |
|
|
The request timeout, in seconds. Example: |
|
|
Displays verbose output, including the API request and response on the command line. This is useful if you are building tools to talk directly to our Query API. |
|
|
Includes column headers in the command output. |
|
|
Shows empty columns as |
|
|
Omits tags for tagged resources. |
|
|
Displays internal debugging information. This can assist us when helping you troubleshooting problems. |
|
|
Displays usage information for the command. |
|
|
Reads arguments from standard input. This is useful when piping the output from one command to the input of another. Example: |
Deprecated Options
For a limited time, you can still use the private key and X.509 certificate instead of your access key ID and secret access key. However, we recommend that you start using your access key ID (-O, --aws-access-key) and secret access key (-W, --aws-secret-key) now, as the private key (-K, --private-key) and X.509 certificate (-C, --cert) won't be supported after the transition period elapses. For more information, see Tell the Tools Who You Are.
| Option | Description |
|---|---|
|
|
The private key to use when constructing requests to Amazon EC2. Default: The value of the Example: |
|
|
The X.509 certificate to use when constructing requests to Amazon EC2. Default: The value of the Example: |
Output
This command returns a table that contains the following information:
The REGION identifier
The name of the region
The service endpoint for the region
Amazon EC2 command line tools display errors on stderr.
Examples
Example Request
This example displays information about all the regions that are available to the account.
PROMPT>ec2-describe-regionsREGION ap-northeast-1 ec2.ap-northeast-1.amazonaws.com REGION ap-southeast-1 ec2.ap-southeast-1.amazonaws.com ..
Example Request
This example displays information about all regions that have the string ap in the endpoint.
PROMPT>ec2-describe-regions --filter "endpoint=*ap*"REGION ap-southeast-1 ec2.ap-southeast-1.amazonaws.com
