Skip to content

delete_cluster_parameter_group

delete_cluster_parameter_group(
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    parameter_group_name: Optional[String] = None,
) -> None

Deletes a specified Amazon Redshift parameter group.

You cannot delete a parameter group if it is associated with a cluster.

Parameters:

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

    The name of the parameter group to be deleted.

    Constraints:

    • Must be the name of an existing cluster parameter group.

    • Cannot delete a default cluster parameter group.

Raises:

Source code in docs_src/capo_redshift/_services/redshift.py
def delete_cluster_parameter_group(
    self,
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    parameter_group_name: Optional["capo_redshift.types.string.String"] = None,
) -> None:
    """<p>Deletes a specified Amazon Redshift parameter group.</p> <note> <p>You cannot delete a parameter group if it is associated with a cluster.</p> </note>

    Args:
        parameter_group_name: <p>The name of the parameter group to be deleted.</p> <p>Constraints:</p> <ul> <li> <p>Must be the name of an existing cluster parameter group.</p> </li> <li> <p>Cannot delete a default cluster parameter group.</p> </li> </ul>

    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.
    """

    def _handler(
        req: "OperationRequest[capo_redshift.types.delete_cluster_parameter_group_message.DeleteClusterParameterGroupMessage]",
    ) -> OperationResponse[None]:
        import capo_redshift._operations.redshift_service_version20121201.delete_cluster_parameter_group

        output, http_response = (
            capo_redshift._operations.redshift_service_version20121201.delete_cluster_parameter_group.delete_cluster_parameter_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteClusterParameterGroup")
    )
    input_: capo_redshift.types.delete_cluster_parameter_group_message.DeleteClusterParameterGroupMessage = {}
    if parameter_group_name is not None:
        input_["parameter_group_name"] = parameter_group_name

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output