- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ResetParameterGroupCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MemoryDBClient, ResetParameterGroupCommand } from "@aws-sdk/client-memorydb"; // ES Modules import
// const { MemoryDBClient, ResetParameterGroupCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import
const client = new MemoryDBClient(config);
const input = { // ResetParameterGroupRequest
ParameterGroupName: "STRING_VALUE", // required
AllParameters: true || false,
ParameterNames: [ // ParameterNameList
"STRING_VALUE",
],
};
const command = new ResetParameterGroupCommand(input);
const response = await client.send(command);
// { // ResetParameterGroupResponse
// ParameterGroup: { // ParameterGroup
// Name: "STRING_VALUE",
// Family: "STRING_VALUE",
// Description: "STRING_VALUE",
// ARN: "STRING_VALUE",
// },
// };
ResetParameterGroupCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ParameterGroupNameRequired | string | undefined | The name of the parameter group to reset. |
AllParameters | boolean | undefined | 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. |
ParameterNames | string[] | undefined | 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. |
ResetParameterGroupCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
ParameterGroup | ParameterGroup | undefined | The parameter group being reset. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InvalidParameterCombinationException | client | |
| InvalidParameterGroupStateFault | client | |
| InvalidParameterValueException | client | |
| ParameterGroupNotFoundFault | client | |
| ServiceLinkedRoleNotFoundFault | client | |
| MemoryDBServiceException | Base exception class for all service exceptions from MemoryDB service. |