Redshift / Paginator / DescribeClusterSubnetGroups

DescribeClusterSubnetGroups#

class Redshift.Paginator.DescribeClusterSubnetGroups#
paginator = client.get_paginator('describe_cluster_subnet_groups')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClusterSubnetGroupName='string',
    TagKeys=[
        'string',
    ],
    TagValues=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • ClusterSubnetGroupName (string) – The name of the cluster subnet group for which information is requested.

  • TagKeys (list) –

    A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet 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 subnet 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 subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet 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 subnet 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

{
    'ClusterSubnetGroups': [
        {
            'ClusterSubnetGroupName': 'string',
            'Description': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string',
                        'SupportedPlatforms': [
                            {
                                'Name': 'string'
                            },
                        ]
                    },
                    'SubnetStatus': 'string'
                },
            ],
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'SupportedClusterIpAddressTypes': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Contains the output from the DescribeClusterSubnetGroups action.

    • ClusterSubnetGroups (list) –

      A list of ClusterSubnetGroup instances.

      • (dict) –

        Describes a subnet group.

        • ClusterSubnetGroupName (string) –

          The name of the cluster subnet group.

        • Description (string) –

          The description of the cluster subnet group.

        • VpcId (string) –

          The VPC ID of the cluster subnet group.

        • SubnetGroupStatus (string) –

          The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.

        • Subnets (list) –

          A list of the VPC Subnet elements.

          • (dict) –

            Describes a subnet.

            • SubnetIdentifier (string) –

              The identifier of the subnet.

            • SubnetAvailabilityZone (dict) –

              • Name (string) –

                The name of the availability zone.

              • SupportedPlatforms (list) –

                • (dict) –

                  A list of supported platforms for orderable clusters.

                  • Name (string) –

            • SubnetStatus (string) –

              The status of the subnet.

        • Tags (list) –

          The list of tags for the cluster subnet 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.

        • SupportedClusterIpAddressTypes (list) –

          The IP address types supported by this cluster subnet group. Possible values are ipv4 and dualstack.

          • (string) –

    • NextToken (string) –

      A token to resume pagination.