Neptune / Paginator / DescribeDBSubnetGroups

DescribeDBSubnetGroups

class Neptune.Paginator.DescribeDBSubnetGroups

paginator = client.get_paginator('describe_db_subnet_groups')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• DBSubnetGroupName (string) – The name of the DB subnet group to return details for.

• Filters (list) –

  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) –

• 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

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

Response Structure

• (dict) –

  • DBSubnetGroups (list) –

    A list of DBSubnetGroup instances.

    • (dict) –

      Contains the details of an Amazon Neptune DB subnet group.

      This data type is used as a response element in the DescribeDBSubnetGroups action.

      • DBSubnetGroupName (string) –

        The name of the DB subnet group.

      • DBSubnetGroupDescription (string) –

        Provides the description of the DB subnet group.

      • VpcId (string) –

        Provides the VpcId of the DB subnet group.

      • SubnetGroupStatus (string) –

        Provides the status of the DB subnet group.

      • Subnets (list) –

        Contains a list of Subnet elements.

        • (dict) –

          Specifies a subnet.

          This data type is used as a response element in the DescribeDBSubnetGroups action.

          • SubnetIdentifier (string) –

            Specifies the identifier of the subnet.

          • SubnetAvailabilityZone (dict) –

            Specifies the EC2 Availability Zone that the subnet is in.

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