DescribeSubnetGroups
Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
Request Syntax
{
"MaxResults": number,
"NextToken": "string",
"SubnetGroupName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
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.
Type: Integer
Required: No
- NextToken
-
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.
Type: String
Required: No
- SubnetGroupName
-
The name of the subnet group to return details for.
Type: String
Required: No
Response Syntax
{
"NextToken": "string",
"SubnetGroups": [
{
"ARN": "string",
"Description": "string",
"Name": "string",
"Subnets": [
{
"AvailabilityZone": {
"Name": "string"
},
"Identifier": "string"
}
],
"VpcId": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
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.
Type: String
- SubnetGroups
-
A list of subnet groups. Each element in the list contains detailed information about one group.
Type: Array of SubnetGroup objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- ServiceLinkedRoleNotFoundFault
-
HTTP Status Code: 400
- SubnetGroupNotFoundFault
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
