Menu
Amazon Redshift
API Reference (API Version 2012-12-01)

ModifyClusterParameterGroup

Modifies the parameters of a parameter group.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ParameterGroupName

The name of the parameter group to be modified.

Type: String

Required: Yes

Parameters.Parameter.N

An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.

For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

Type: Array of Parameter objects

Required: Yes

Response Elements

The following elements are returned by the service.

ParameterGroupName

The name of the cluster parameter group.

Type: String

ParameterGroupStatus

The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

ClusterParameterGroupNotFound

The parameter group name does not refer to an existing parameter group.

HTTP Status Code: 404

InvalidClusterParameterGroupState

The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.

HTTP Status Code: 400

Example

Sample Request

https://redshift.us-east-1.amazonaws.com/ ?Action=ModifyClusterParameterGroup &ParameterGroupName=parametergroup1 &Parameters.member.1.ParameterName=extra_float_digits &Parameters.member.1.ParameterValue=2 &Parameters.member.2.ParameterName=wlm_json_configuration &Parameters.member.2.ParameterValue=[{"user_group":["example_user_group1"],"query_group":["example_query_group1"],"query_concurrency":7},{"query_concurrency":5}] &Version=2012-12-01 &x-amz-algorithm=AWS4-HMAC-SHA256 &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121208/us-east-1/redshift/aws4_request &x-amz-date=20121208T022525Z &x-amz-signedheaders=content-type;host;x-amz-date

Sample Response

<ModifyClusterParameterGroupResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <ModifyClusterParameterGroupResult> <ParameterGroupStatus>Your parameter group has been updated. Updates to dynamic parameters will be applied immediately. Updates to static parameters will be applied when you reboot the associated Clusters.</ParameterGroupStatus> <ParameterGroupName>parametergroup1</ParameterGroupName> </ModifyClusterParameterGroupResult> <ResponseMetadata> <RequestId>86e64043-40de-11e2-8a25-eb010998df4e</RequestId> </ResponseMetadata> </ModifyClusterParameterGroupResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: