DescribeCacheSecurityGroups

class ElastiCache.Paginator.DescribeCacheSecurityGroups

paginator = client.get_paginator('describe_cache_security_groups')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters

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

{
    'CacheSecurityGroups': [
        {
            'OwnerId': 'string',
            'CacheSecurityGroupName': 'string',
            'Description': 'string',
            'EC2SecurityGroups': [
                {
                    'Status': 'string',
                    'EC2SecurityGroupName': 'string',
                    'EC2SecurityGroupOwnerId': 'string'
                },
            ],
            'ARN': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  Represents the output of a DescribeCacheSecurityGroups operation.

  • CacheSecurityGroups (list) --

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

    • (dict) --

      Represents the output of one of the following operations:

      • AuthorizeCacheSecurityGroupIngress
      • CreateCacheSecurityGroup
      • RevokeCacheSecurityGroupIngress

      • OwnerId (string) --

        The Amazon account ID of the cache security group owner.

      • CacheSecurityGroupName (string) --

        The name of the cache security group.

      • Description (string) --

        The description of the cache security group.

      • EC2SecurityGroups (list) --

        A list of Amazon EC2 security groups that are associated with this cache security group.

        • (dict) --

          Provides ownership and status information for an Amazon EC2 security group.

          • Status (string) --

            The status of the Amazon EC2 security group.

          • EC2SecurityGroupName (string) --

            The name of the Amazon EC2 security group.

          • EC2SecurityGroupOwnerId (string) --

            The Amazon account ID of the Amazon EC2 security group owner.

      • ARN (string) --

        The ARN of the cache security group,

  • NextToken (string) --

    A token to resume pagination.