Amazon Relational Database Service

Returns a list that includes the status of each source AWS Region that the current region can get a Read Replica or a DB snapshot from. This API action supports pagination.

Request Syntax

client.describe_source_regions(
    RegionName='string',
    MaxRecords=123,
    Marker='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

type RegionName:

string

param RegionName:

The source region name, for example US West (Oregon).

Constraints:

• Must specify a valid AWS Region name, for example US West (Oregon).

type MaxRecords:

integer

param 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 that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker:

string

param 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 Filters:

list

param Filters:

This parameter is not currently supported.

• (dict) --

  This type is not currently supported.

  • Name (string) -- [REQUIRED]

    This parameter is not currently supported.

  • Values (list) -- [REQUIRED]

    This parameter is not currently supported.

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'Marker': 'string',
    'SourceRegions': [
        {
            'RegionName': 'string',
            'Endpoint': 'string',
            'Status': 'string'
        },
    ]
}

Response Structure

• (dict) --

  Contains the result of a successful invocation of the DescribeSourceRegions action.

  • Marker (string) --

    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.

  • SourceRegions (list) --

    A list of SourceRegion instances that contains each source AWS Region that the current region can get a Read Replica or a DB snapshot from.

    • (dict) --

      Contains an AWS Region name as the result of a successful call to the DescribeSourceRegions action.

      • RegionName (string) --

        The source region name.

      • Endpoint (string) --

        The source region endpoint.

      • Status (string) --

        The status of the source region.