Skip to content

delete_notify_configuration

delete_notify_configuration(
    notify_configuration_id: NotifyConfigurationIdOrArn,
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
) -> DeleteNotifyConfigurationResult

Deletes an existing notify configuration.

If deletion protection is enabled, an error is returned.

Parameters:

Raises:

  • AccessDeniedException –

    The request was denied because you don't have sufficient permissions to access the resource.

  • ConflictException –

    Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

  • InternalServerException –

    The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

  • ResourceNotFoundException –

    A requested resource couldn't be found.

  • ThrottlingException –

    An error that occurred because too many requests were sent during a certain amount of time.

  • ValidationException –

    A validation exception for a field.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Examples:

DeleteNotifyConfiguration Delete an existing notify configuration.

>>> client.delete_notify_configuration(notify_configuration_id='nc-1234567890abcdef0')
Source code in docs_src/capo_pinpoint_sms_voice_v2/_services/pinpoint_sms_voice_v2.py
def delete_notify_configuration(
    self,
    notify_configuration_id: "capo_pinpoint_sms_voice_v2.types.notify_configuration_id_or_arn.NotifyConfigurationIdOrArn",
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
) -> "capo_pinpoint_sms_voice_v2.types.delete_notify_configuration_result.DeleteNotifyConfigurationResult":
    """<p>Deletes an existing notify configuration.</p> <p>If deletion protection is enabled, an error is returned.</p>

    Args:
        notify_configuration_id: <p>The identifier of the notify configuration to delete. The NotifyConfigurationId can be found using the <a>DescribeNotifyConfigurations</a> operation.</p>

    Raises:
        capo_pinpoint_sms_voice_v2.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
        capo_pinpoint_sms_voice_v2.errors.conflict_exception.ConflictException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
        capo_pinpoint_sms_voice_v2.errors.internal_server_exception.InternalServerException: <p>The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.</p>
        capo_pinpoint_sms_voice_v2.errors.resource_not_found_exception.ResourceNotFoundException: <p>A requested resource couldn't be found.</p>
        capo_pinpoint_sms_voice_v2.errors.throttling_exception.ThrottlingException: <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_pinpoint_sms_voice_v2.errors.validation_exception.ValidationException: <p>A validation exception for a field.</p>
        capo_pinpoint_sms_voice_v2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        DeleteNotifyConfiguration
        Delete an existing notify configuration.

        >>> client.delete_notify_configuration(notify_configuration_id='nc-1234567890abcdef0')
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_sms_voice_v2.types.delete_notify_configuration_request.DeleteNotifyConfigurationRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_sms_voice_v2.types.delete_notify_configuration_result.DeleteNotifyConfigurationResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.delete_notify_configuration

        output, http_response = (
            capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.delete_notify_configuration.delete_notify_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteNotifyConfiguration")
    )
    input_: capo_pinpoint_sms_voice_v2.types.delete_notify_configuration_request.DeleteNotifyConfigurationRequest = {
        "notify_configuration_id": notify_configuration_id
    }

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