Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

DescribeReplicationSubnetGroups

class DatabaseMigrationService.Paginator.DescribeReplicationSubnetGroups
paginator = client.get_paginator('describe_replication_subnet_groups')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_replication_subnet_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (list) --

    Filters applied to replication subnet groups.

    Valid filter names: replication-subnet-group-id

    • (dict) --

      Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.

      • Name (string) -- [REQUIRED]

        The name of the filter as specified for a Describe* or similar operation.

      • Values (list) -- [REQUIRED]

        The filter value, which can specify one or more values used to narrow the returned results.

        • (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

dict

Returns

Response Syntax

{
    'ReplicationSubnetGroups': [
        {
            'ReplicationSubnetGroupIdentifier': 'string',
            'ReplicationSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': 'string'
                },
            ],
            'SupportedNetworkTypes': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ReplicationSubnetGroups (list) --

      A description of the replication subnet groups.

      • (dict) --

        Describes a subnet group in response to a request by the DescribeReplicationSubnetGroups operation.

        • ReplicationSubnetGroupIdentifier (string) --

          The identifier of the replication instance subnet group.

        • ReplicationSubnetGroupDescription (string) --

          A description for the replication subnet group.

        • VpcId (string) --

          The ID of the VPC.

        • SubnetGroupStatus (string) --

          The status of the subnet group.

        • Subnets (list) --

          The subnets that are in the subnet group.

          • (dict) --

            In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.

            • SubnetIdentifier (string) --

              The subnet identifier.

            • SubnetAvailabilityZone (dict) --

              The Availability Zone of the subnet.

              • Name (string) --

                The name of the Availability Zone.

            • SubnetStatus (string) --

              The status of the subnet.

        • SupportedNetworkTypes (list) --

          The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.

          • (string) --
    • NextToken (string) --

      A token to resume pagination.