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...

DescribeRegions

Description

Describes Regions that are currently available to the account.

You can use filters with this call just as you can with other "describe" calls.

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

endpoint

Region's endpoint (e.g., ec2.us-east-1.amazonaws.com).

Type: String

region-name

Name of the Region.

Type: String

Request Parameters

NameDescriptionRequired

RegionName.n

One or more Region names.

Type: String

Default: Describes all Regions available to the account.

No

Filter.n.Name

Name of a filter. See the preceding table for a list of allowed filter names.

Type: String

Default: None

No

Filter.n.Value.m

A value for the filter. See the preceding table for a list of allowed values for each filter.

Type: String

Default: None

No

Response Elements

The elements in the following table are wrapped in a DescribeRegionsResponse structure.

NameDescription

requestId

The ID of the request.

Type: xsd:string

regionInfo

List of Regions. Each Region's information is wrapped in an item element.

Type: RegionItemType

Examples

Example Request

This example displays information about all Regions.

https://ec2.amazonaws.com/?Action=DescribeRegions
&AUTHPARAMS

Example Request

This example displays information about just the specified Regions.

https://ec2.amazonaws.com/?Action=DescribeRegions
&RegionName.1=us-east-1
&RegionName.2=eu-west-1
&AUTHPARAMS

Example Response

<DescribeRegionsResponse xmlns="http://ec2.amazonaws.com/doc/2011-05-15/">
   <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> 
   <regionInfo>
      <item>
         <regionName>us-east-1</regionName>
         <regionEndpoint>ec2.us-east-1.amazonaws.com</regionEndpoint>
      </item>
      <item>
         <regionName>eu-west-1</regionName>
         <regionEndpoint>ec2.eu-west-1.amazonaws.com</regionEndpoint>
      </item>
   </regionInfo>
</DescribeRegionsResponse>

Example Request

This example displays information about all Regions that have the string ap in the endpoint.

https://ec2.amazonaws.com/?Action=DescribeRegions
&Filter.1.Name=endpoint
&Filter.1.Value.1=*ap*
&AUTHPARAMS

Example Response

<DescribeRegionsResponse xmlns="http://ec2.amazonaws.com/doc/2011-05-15/">
   <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> 
   <regionInfo>
      <item>
         <regionName>ap-southeast-1</regionName>
         <regionEndpoint>ec2.ap-southeast-1.amazonaws.com</regionEndpoint>
      </item>
   </regionInfo>
</DescribeRegionsResponse>