MemoryDB / Client / describe_subnet_groups

describe_subnet_groups#

MemoryDB.Client.describe_subnet_groups(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_subnet_groups(
    SubnetGroupName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • SubnetGroupName (string) – The name of the subnet group to return details for.

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

  • NextToken (string) – An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'SubnetGroups': [
        {
            'Name': 'string',
            'Description': 'string',
            'VpcId': 'string',
            'Subnets': [
                {
                    'Identifier': 'string',
                    'AvailabilityZone': {
                        'Name': 'string'
                    }
                },
            ],
            'ARN': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    • SubnetGroups (list) –

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

      • (dict) –

        Represents the output of one of the following operations:

        • CreateSubnetGroup

        • UpdateSubnetGroup

        A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment.

        • Name (string) –

          The name of the subnet group

        • Description (string) –

          A 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 cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.

            • Identifier (string) –

              The unique identifier for the subnet.

            • AvailabilityZone (dict) –

              The Availability Zone where the subnet resides

              • Name (string) –

                The name of the Availability Zone.

        • ARN (string) –

          The ARN (Amazon Resource Name) of the subnet group.

Exceptions

  • MemoryDB.Client.exceptions.SubnetGroupNotFoundFault

  • MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault