Skip to content

delete_configuration_set

delete_configuration_set(
    configuration_set_name: ConfigurationSetName,
    *,
    config_overrides: Optional[PinpointEmailClientConfig] = None,
) -> DeleteConfigurationSetResponse

Delete an existing configuration set.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Parameters:

  • configuration_set_name (ConfigurationSetName) –

    The name of the configuration set that you want to delete.

Raises:

Source code in docs_src/capo_pinpoint_email/_services/pinpoint_email.py
def delete_configuration_set(
    self,
    configuration_set_name: "capo_pinpoint_email.types.configuration_set_name.ConfigurationSetName",
    *,
    config_overrides: Optional[PinpointEmailClientConfig] = None,
) -> "capo_pinpoint_email.types.delete_configuration_set_response.DeleteConfigurationSetResponse":
    """<p>Delete an existing configuration set.</p> <p>In Amazon Pinpoint, <i>configuration sets</i> are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.</p>

    Args:
        configuration_set_name: <p>The name of the configuration set that you want to delete.</p>

    Raises:
        capo_pinpoint_email.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_pinpoint_email.errors.concurrent_modification_exception.ConcurrentModificationException: <p>The resource is being modified by another operation or thread.</p>
        capo_pinpoint_email.errors.not_found_exception.NotFoundException: <p>The resource you attempted to access doesn't exist.</p>
        capo_pinpoint_email.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many requests have been made to the operation.</p>
        capo_pinpoint_email.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_email.types.delete_configuration_set_request.DeleteConfigurationSetRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_email.types.delete_configuration_set_response.DeleteConfigurationSetResponse"
    ]:
        import capo_pinpoint_email._operations.amazon_pinpoint_email_service.delete_configuration_set

        output, http_response = (
            capo_pinpoint_email._operations.amazon_pinpoint_email_service.delete_configuration_set.delete_configuration_set(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteConfigurationSet")
    )
    input_: capo_pinpoint_email.types.delete_configuration_set_request.DeleteConfigurationSetRequest = {
        "configuration_set_name": configuration_set_name
    }

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