DAX / Client / describe_subnet_groups

describe_subnet_groups#

DAX.Client.describe_subnet_groups(**kwargs)#

Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.

See also: AWS API Documentation

Request Syntax

response = client.describe_subnet_groups(
    SubnetGroupNames=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • SubnetGroupNames (list) –

    The name of the subnet group.

    • (string) –

  • MaxResults (integer) –

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    The value for MaxResults must be between 20 and 100.

  • NextToken (string) – An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'SubnetGroups': [
        {
            'SubnetGroupName': 'string',
            'Description': 'string',
            'VpcId': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      Provides an identifier to allow retrieval of paginated results.

    • SubnetGroups (list) –

      An array of subnet groups. Each element in the array represents a single subnet group.

      • (dict) –

        Represents the output of one of the following actions:

        • CreateSubnetGroup

        • ModifySubnetGroup

        • SubnetGroupName (string) –

          The name of the subnet group.

        • Description (string) –

          The description of the subnet group.

        • VpcId (string) –

          The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.

        • Subnets (list) –

          A list of subnets associated with the subnet group.

          • (dict) –

            Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.

            • SubnetIdentifier (string) –

              The system-assigned identifier for the subnet.

            • SubnetAvailabilityZone (string) –

              The Availability Zone (AZ) for the subnet.

Exceptions

  • DAX.Client.exceptions.SubnetGroupNotFoundFault

  • DAX.Client.exceptions.ServiceLinkedRoleNotFoundFault