DescribeSourceRegions - Amazon Relational Database Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeSourceRegions

Returns a list of the source Amazon Regions where the current Amazon Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Filters.Filter.N

This parameter isn't currently supported.

Type: Array of Filter objects

Required: No

Marker

An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Type: String

Required: No

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer

Required: No

RegionName

The source Amazon Region name. For example, us-east-1.

Constraints:

  • Must specify a valid Amazon Region name.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

Marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Type: String

SourceRegions.SourceRegion.N

A list of SourceRegion instances that contains each source Amazon Region that the current Amazon Region can get a read replica or a DB snapshot from.

Type: Array of SourceRegion objects

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example

This example illustrates one usage of DescribeSourceRegions.

Sample Request

https://rds.us-east-1.amazonaws.com/ ?Action=DescribeSourceRegions &MaxRecords=10 &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-10-31 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20140429/us-east-1/rds/aws4_request &X-Amz-Date=20140429T175351Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=9164337efa99caf850e874a1cb7ef62f3cea29d0b448b9e0e7c53b288ddffed2

Sample Response

<DescribeSourceRegionsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> <DescribeSourceRegionsResult> <SourceRegions> <SourceRegion> <RegionName>ap-northeast-1</RegionName> <EndPoint>https://rds.ap-northeast-1.amazonaws.com</EndPoint> <Status>available</Status> </SourceRegion> <SourceRegion> <RegionName>ap-southeast-2</RegionName> <EndPoint>https://rds.ap-southeast-2.amazonaws.com</EndPoint> <Status>available</Status> </SourceRegion> </SourceRegions> </DescribeSourceRegionsResult> <ResponseMetadata> <RequestId>01b2685a-b978-11d3-f272-7cd6cce12cc5</RequestId> </ResponseMetadata> </DescribeSourceRegionsResponse>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: