ResetParameterGroup
Modifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters.
Request Syntax
{
"AllParameters": boolean,
"ParameterGroupName": "string",
"ParameterNames": [ "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.
- AllParameters
-
If true, all parameters in the parameter group are reset to their default values. If false, only the parameters listed by ParameterNames are reset to their default values.
Type: Boolean
Required: No
- ParameterGroupName
-
The name of the parameter group to reset.
Type: String
Required: Yes
- ParameterNames
-
An array of parameter names to reset to their default values. If AllParameters is true, do not use ParameterNames. If AllParameters is false, you must specify the name of at least one parameter to reset.
Type: Array of strings
Required: No
Response Syntax
{
"ParameterGroup": {
"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.
- ParameterGroup
-
The parameter group being reset.
Type: ParameterGroup object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterCombinationException
-
HTTP Status Code: 400
- InvalidParameterGroupStateFault
-
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:
