Skip to content

reset_cluster_parameter_group async

reset_cluster_parameter_group(
    *,
    config_overrides: Optional[AsyncRedshiftClientConfig] = None,
    parameter_group_name: Optional[String] = None,
    reset_all_parameters: Optional[Boolean] = None,
    parameters: Optional[ParametersList] = None,
) -> ClusterParameterGroupNameMessage

Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.

Parameters:

  • parameter_group_name (Optional[String], default: None ) –

    The name of the cluster parameter group to be reset.

  • reset_all_parameters (Optional[Boolean], default: None ) –

    If true, all parameters in the specified parameter group will be reset to their default values.

    Default: true

  • parameters (Optional[ParametersList], default: None ) –

    An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.

    Constraints: A maximum of 20 parameters can be reset in a single request.

Raises:

Source code in docs_src/capo_redshift/_services/async_redshift.py
async def reset_cluster_parameter_group(
    self,
    *,
    config_overrides: Optional[AsyncRedshiftClientConfig] = None,
    parameter_group_name: Optional["capo_redshift.types.string.String"] = None,
    reset_all_parameters: Optional["capo_redshift.types.boolean.Boolean"] = None,
    parameters: Optional[
        "capo_redshift.types.parameters_list.ParametersList"
    ] = None,
) -> "capo_redshift.types.cluster_parameter_group_name_message.ClusterParameterGroupNameMessage":
    """<p>Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the <i>ResetAllParameters</i> parameter. For parameter changes to take effect you must reboot any associated clusters. </p>

    Args:
        parameter_group_name: <p>The name of the cluster parameter group to be reset.</p>
        reset_all_parameters: <p>If <code>true</code>, all parameters in the specified parameter group will be reset to their default values. </p> <p>Default: <code>true</code> </p>
        parameters: <p>An array of names of parameters to be reset. If <i>ResetAllParameters</i> option is not used, then at least one parameter name must be supplied. </p> <p>Constraints: A maximum of 20 parameters can be reset in a single request.</p>

    Raises:
        capo_redshift.errors.cluster_parameter_group_not_found_fault.ClusterParameterGroupNotFoundFault: <p>The parameter group name does not refer to an existing parameter group.</p>
        capo_redshift.errors.invalid_cluster_parameter_group_state_fault.InvalidClusterParameterGroupStateFault: <p>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.</p>
        capo_redshift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_redshift.types.reset_cluster_parameter_group_message.ResetClusterParameterGroupMessage]",
    ) -> AsyncOperationResponse[
        "capo_redshift.types.cluster_parameter_group_name_message.ClusterParameterGroupNameMessage"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.reset_cluster_parameter_group

        (
            output,
            http_response,
        ) = await capo_redshift._operations.redshift_service_version20121201.reset_cluster_parameter_group.async_reset_cluster_parameter_group(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ResetClusterParameterGroup")
    )
    input_: capo_redshift.types.reset_cluster_parameter_group_message.ResetClusterParameterGroupMessage = {}
    if parameter_group_name is not None:
        input_["parameter_group_name"] = parameter_group_name
    if reset_all_parameters is not None:
        input_["reset_all_parameters"] = reset_all_parameters
    if parameters is not None:
        input_["parameters"] = parameters

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output