UpdateParameterGroupCommand

Suggest an Edit

Modifies the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

Example Syntax

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

import { DAXClient, UpdateParameterGroupCommand } from "@aws-sdk/client-dax"; // ES Modules import
// const { DAXClient, UpdateParameterGroupCommand } = require("@aws-sdk/client-dax"); // CommonJS import
const client = new DAXClient(config);
const input = { // UpdateParameterGroupRequest
  ParameterGroupName: "STRING_VALUE", // required
  ParameterNameValues: [ // ParameterNameValueList // required
    { // ParameterNameValue
      ParameterName: "STRING_VALUE",
      ParameterValue: "STRING_VALUE",
    },
  ],
};
const command = new UpdateParameterGroupCommand(input);
const response = await client.send(command);
// { // UpdateParameterGroupResponse
//   ParameterGroup: { // ParameterGroup
//     ParameterGroupName: "STRING_VALUE",
//     Description: "STRING_VALUE",
//   },
// };

UpdateParameterGroupCommand Input

See UpdateParameterGroupCommandInput for more details

Parameter
Type
Description
ParameterGroupName
Required
string | undefined

The name of the parameter group.

ParameterNameValues
Required
ParameterNameValue[] | undefined

An array of name-value pairs for the parameters in the group. Each element in the array represents a single parameter.

record-ttl-millis and query-ttl-millis are the only supported parameter names. For more details, see Configuring TTL Settings .

UpdateParameterGroupCommand Output

See UpdateParameterGroupCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ParameterGroup
ParameterGroup | undefined

The parameter group that has been modified.

Throws

Name
Fault
Details
InvalidParameterCombinationException
client

Two or more incompatible parameters were specified.

InvalidParameterGroupStateFault
client

One or more parameters in a parameter group are in an invalid state.

InvalidParameterValueException
client

The value for a parameter is invalid.

ParameterGroupNotFoundFault
client

The specified parameter group does not exist.

ServiceLinkedRoleNotFoundFault
client

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

DAXServiceException
Base exception class for all service exceptions from DAX service.