DescribeCacheSubnetGroups¶

class ElastiCache.Paginator.DescribeCacheSubnetGroups¶

paginator = client.get_paginator('describe_cache_subnet_groups')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from ElastiCache.Client.describe_cache_subnet_groups().

See also: AWS API Documentation

Request Syntax

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

Parameters

CacheSubnetGroupName (string) -- The name of the cache 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

{
    'CacheSubnetGroups': [
        {
            'CacheSubnetGroupName': 'string',
            'CacheSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetOutpost': {
                        'SubnetOutpostArn': 'string'
                    },
                    'SupportedNetworkTypes': [
                        'ipv4'|'ipv6'|'dual_stack',
                    ]
                },
            ],
            'ARN': 'string',
            'SupportedNetworkTypes': [
                'ipv4'|'ipv6'|'dual_stack',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Represents the output of a DescribeCacheSubnetGroups operation.
- CacheSubnetGroups (list) --
  
  A list of cache subnet groups. Each element in the list contains detailed information about one group.
  - (dict) --
    
    Represents the output of one of the following operations:
    - CreateCacheSubnetGroup
    - ModifyCacheSubnetGroup
    - CacheSubnetGroupName (string) --
      
      The name of the cache subnet group.
    - CacheSubnetGroupDescription (string) --
      
      The description of the cache subnet group.
    - VpcId (string) --
      
      The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
    - Subnets (list) --
      
      A list of subnets associated with the cache 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 ElastiCache.
        
        SubnetIdentifier (string) --
        
        The unique identifier for the subnet.
        
        SubnetAvailabilityZone (dict) --
        
        The Availability Zone associated with the subnet.
        
        Name (string) --
        
        The name of the Availability Zone.
        
        SubnetOutpost (dict) --
        
        The outpost ARN of the subnet.
        
        SubnetOutpostArn (string) --
        
        The outpost ARN of the subnet.
        
        SupportedNetworkTypes (list) --
        
        Either ipv4 | ipv6 | dual_stack . IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
        
        (string) --
    - ARN (string) --
      
      The ARN (Amazon Resource Name) of the cache subnet group.
    - SupportedNetworkTypes (list) --
      
      Either ipv4 | ipv6 | dual_stack . IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
      - (string) --
- NextToken (string) --
  
  A token to resume pagination.

Table Of Contents

DescribeCacheSubnetGroups¶