RDS / Paginator / DescribeSourceRegions


class RDS.Paginator.DescribeSourceRegions#
paginator = client.get_paginator('describe_source_regions')

Creates an iterator that will paginate through responses from RDS.Client.describe_source_regions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
            'Name': 'string',
            'Values': [
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • RegionName (string) –

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


    • Must specify a valid Amazon Web Services Region name.

  • Filters (list) –

    This parameter isn’t currently supported.

    • (dict) –

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.


      Currently, wildcards are not supported in filters.

      The following actions can be filtered:

      • DescribeDBClusterBacktracks

      • DescribeDBClusterEndpoints

      • DescribeDBClusters

      • DescribeDBInstances

      • DescribeDBRecommendations

      • DescribeDBShardGroups

      • DescribePendingMaintenanceActions

      • Name (string) – [REQUIRED]

        The name of the filter. Filter names are case-sensitive.

      • Values (list) – [REQUIRED]

        One or more filter values. Filter values are case-sensitive.

        • (string) –

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'SourceRegions': [
            'RegionName': 'string',
            'Endpoint': 'string',
            'Status': 'string',
            'SupportsDBInstanceAutomatedBackupsReplication': True|False
    'NextToken': 'string'

Response Structure

  • (dict) –

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

    • SourceRegions (list) –

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

      • (dict) –

        Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.

        • RegionName (string) –

          The name of the source Amazon Web Services Region.

        • Endpoint (string) –

          The endpoint for the source Amazon Web Services Region endpoint.

        • Status (string) –

          The status of the source Amazon Web Services Region.

        • SupportsDBInstanceAutomatedBackupsReplication (boolean) –

          Indicates whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

    • NextToken (string) –

      A token to resume pagination.