DescribeParameterGroups
Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.
Request Syntax
{
"MaxResults": number,
"NextToken": "string",
"ParameterGroupName": "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
- ParameterGroupName
-
The name of a specific parameter group to return details for.
Type: String
Required: No
Response Syntax
{
"NextToken": "string",
"ParameterGroups": [
{
"ARN": "string",
"Description": "string",
"Family": "string",
"Name": "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
- ParameterGroups
-
A list of parameter groups. Each element in the list contains detailed information about one parameter group.
Type: Array of ParameterGroup objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterCombinationException
-
HTTP Status Code: 400
- InvalidParameterValueException
-
HTTP Status Code: 400
- ParameterGroupNotFoundFault
-
HTTP Status Code: 400
- ServiceLinkedRoleNotFoundFault
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
