Redshift / Paginator / DescribeClusterSecurityGroups

DescribeClusterSecurityGroups

class Redshift.Paginator.DescribeClusterSecurityGroups

paginator = client.get_paginator('describe_cluster_security_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Redshift.Client.describe_cluster_security_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClusterSecurityGroupName='string',
    TagKeys=[
        'string',
    ],
    TagValues=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ClusterSecurityGroupName (string) –

  The name of a cluster security group for which you are requesting details. You must specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.

  Example: securitygroup1

• TagKeys (list) –

  A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.

  • (string) –

• TagValues (list) –

  A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.

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

{
    'ClusterSecurityGroups': [
        {
            'ClusterSecurityGroupName': 'string',
            'Description': 'string',
            'EC2SecurityGroups': [
                {
                    'Status': 'string',
                    'EC2SecurityGroupName': 'string',
                    'EC2SecurityGroupOwnerId': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ],
            'IPRanges': [
                {
                    'Status': 'string',
                    'CIDRIP': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ],
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ClusterSecurityGroups (list) –

    A list of ClusterSecurityGroup instances.

    • (dict) –

      Describes a security group.

      • ClusterSecurityGroupName (string) –

        The name of the cluster security group to which the operation was applied.

      • Description (string) –

        A description of the security group.

      • EC2SecurityGroups (list) –

        A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

        • (dict) –

          Describes an Amazon EC2 security group.

          • Status (string) –

            The status of the EC2 security group.

          • EC2SecurityGroupName (string) –

            The name of the EC2 Security Group.

          • EC2SecurityGroupOwnerId (string) –

            The Amazon Web Services account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

          • Tags (list) –

            The list of tags for the EC2 security group.

            • (dict) –

              A tag consisting of a name/value pair for a resource.

              • Key (string) –

                The key, or name, for the resource tag.

              • Value (string) –

                The value for the resource tag.

      • IPRanges (list) –

        A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

        • (dict) –

          Describes an IP range used in a security group.

          • Status (string) –

            The status of the IP range, for example, “authorized”.

          • CIDRIP (string) –

            The IP range in Classless Inter-Domain Routing (CIDR) notation.

          • Tags (list) –

            The list of tags for the IP range.

            • (dict) –

              A tag consisting of a name/value pair for a resource.

              • Key (string) –

                The key, or name, for the resource tag.

              • Value (string) –

                The value for the resource tag.

      • Tags (list) –

        The list of tags for the cluster security group.

        • (dict) –

          A tag consisting of a name/value pair for a resource.

          • Key (string) –

            The key, or name, for the resource tag.

          • Value (string) –

            The value for the resource tag.

  • NextToken (string) –

    A token to resume pagination.