Class DescribeSubnetGroupsCommandProtected

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

Example

Use a bare-bones client and the command you need to make an API call.

import { DAXClient, DescribeSubnetGroupsCommand } from "@aws-sdk/client-dax"; // ES Modules import
// const { DAXClient, DescribeSubnetGroupsCommand } = require("@aws-sdk/client-dax"); // CommonJS import
const client = new DAXClient(config);
const input = { // DescribeSubnetGroupsRequest
  SubnetGroupNames: [ // SubnetGroupNameList
    "STRING_VALUE",
  ],
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new DescribeSubnetGroupsCommand(input);
const response = await client.send(command);
// { // DescribeSubnetGroupsResponse
//   NextToken: "STRING_VALUE",
//   SubnetGroups: [ // SubnetGroupList
//     { // SubnetGroup
//       SubnetGroupName: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       VpcId: "STRING_VALUE",
//       Subnets: [ // SubnetList
//         { // Subnet
//           SubnetIdentifier: "STRING_VALUE",
//           SubnetAvailabilityZone: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
// };

Param

DescribeSubnetGroupsCommandInput

Returns

DescribeSubnetGroupsCommandOutput

See

• DescribeSubnetGroupsCommandInput for command's input shape.
• DescribeSubnetGroupsCommandOutput for command's response shape.
• config for DAXClient's config shape.

Throws

ServiceLinkedRoleNotFoundFault (client fault)

The specified service linked role (SLR) was not found.

Throws

SubnetGroupNotFoundFault (client fault)

The requested subnet group name does not refer to an existing subnet group.

Throws

DAXServiceException

Base exception class for all service exceptions from DAX service.