MemoryDB / Paginator / DescribeSubnetGroups

DescribeSubnetGroups

class MemoryDB.Paginator.DescribeSubnetGroups

paginator = client.get_paginator('describe_subnet_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MemoryDB.Client.describe_subnet_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SubnetGroupName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• 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

{
    'SubnetGroups': [
        {
            'Name': 'string',
            'Description': 'string',
            'VpcId': 'string',
            'Subnets': [
                {
                    'Identifier': 'string',
                    'AvailabilityZone': {
                        'Name': 'string'
                    },
                    'SupportedNetworkTypes': [
                        'ipv4'|'ipv6'|'dual_stack',
                    ]
                },
            ],
            'ARN': 'string',
            'SupportedNetworkTypes': [
                'ipv4'|'ipv6'|'dual_stack',
            ]
        },
    ]
}

Response Structure

• (dict) –

  • SubnetGroups (list) –

    A list of subnet groups. Each element in the list contains detailed information about one group.

    • (dict) –

      Represents the output of one of the following operations:

      • CreateSubnetGroup

      • UpdateSubnetGroup

      A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment.

      • Name (string) –

        The name of the subnet group

      • Description (string) –

        A description of the subnet group

      • VpcId (string) –

        The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.

      • Subnets (list) –

        A list of subnets associated with the subnet group.

        • (dict) –

          Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.

          • Identifier (string) –

            The unique identifier for the subnet.

          • AvailabilityZone (dict) –

            The Availability Zone where the subnet resides

            • Name (string) –

              The name of the Availability Zone.

          • SupportedNetworkTypes (list) –

            The network types supported by this subnet. Returns an array of strings that can include ‘ipv4’, ‘ipv6’, or both, indicating whether the subnet supports IPv4 only, IPv6 only, or dual-stack deployments.

            • (string) –

      • ARN (string) –

        The ARN (Amazon Resource Name) of the subnet group.

      • SupportedNetworkTypes (list) –

        The network types supported by this subnet group. Returns an array of strings that can include ‘ipv4’, ‘ipv6’, or both, indicating the IP address types that can be used for clusters deployed in this subnet group.

        • (string) –