Redshift / Client / describe_cluster_subnet_groups

describe_cluster_subnet_groups

Redshift.Client.describe_cluster_subnet_groups(**kwargs)

Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.

See also: AWS API Documentation

Request Syntax

response = client.describe_cluster_subnet_groups(
    ClusterSubnetGroupName='string',
    MaxRecords=123,
    Marker='string',
    TagKeys=[
        'string',
    ],
    TagValues=[
        'string',
    ]
)

Parameters:

• ClusterSubnetGroupName (string) – The name of the cluster subnet group for which information is requested.

• MaxRecords (integer) –

  The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

  Default: 100

  Constraints: minimum 20, maximum 100.

• Marker (string) – An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

• 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) –

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    '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',
            ]
        },
    ]
}

Response Structure

• (dict) –

  Contains the output from the DescribeClusterSubnetGroups action.

  • Marker (string) –

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • 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) –

Exceptions

• Redshift.Client.exceptions.ClusterSubnetGroupNotFoundFault

• Redshift.Client.exceptions.InvalidTagFault