DocDB / Paginator / DescribeDBSubnetGroups


class DocDB.Paginator.DescribeDBSubnetGroups#
paginator = client.get_paginator('describe_db_subnet_groups')

Creates an iterator that will paginate through responses from DocDB.Client.describe_db_subnet_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
            'Name': 'string',
            'Values': [
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • DBSubnetGroupName (string) – The name of the subnet group to return details for.

  • Filters (list) –

    This parameter is not currently supported.

    • (dict) –

      A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

      Wildcards are not supported in filters.

      • 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

    'DBSubnetGroups': [
            'DBSubnetGroupName': 'string',
            'DBSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    'SubnetStatus': 'string'
            'DBSubnetGroupArn': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    Represents the output of DescribeDBSubnetGroups.

    • DBSubnetGroups (list) –

      Detailed information about one or more subnet groups.

      • (dict) –

        Detailed information about a subnet group.

        • DBSubnetGroupName (string) –

          The name of the subnet group.

        • DBSubnetGroupDescription (string) –

          Provides the description of the subnet group.

        • VpcId (string) –

          Provides the virtual private cloud (VPC) ID of the subnet group.

        • SubnetGroupStatus (string) –

          Provides the status of the subnet group.

        • Subnets (list) –

          Detailed information about one or more subnets within a subnet group.

          • (dict) –

            Detailed information about a subnet.

            • SubnetIdentifier (string) –

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone (dict) –

              Specifies the Availability Zone for the subnet.

              • Name (string) –

                The name of the Availability Zone.

            • SubnetStatus (string) –

              Specifies the status of the subnet.

        • DBSubnetGroupArn (string) –

          The Amazon Resource Name (ARN) for the DB subnet group.

    • NextToken (string) –

      A token to resume pagination.