Skip to content

delete_notify_code_configuration 

delete_notify_code_configuration(
    notify_code_configuration_id: NotifyCodeConfigurationIdOrArn,
    *,
    config_overrides: Optional[EndUserMessagingClientConfig] = None,
) -> DeleteNotifyCodeConfigurationOutput

Deletes a notify code configuration. Verifications that are already in progress are not affected, because they capture the policy at the time that the passcode was sent.

Parameters:

  • notify_code_configuration_id (NotifyCodeConfigurationIdOrArn) –

    The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).

Raises:

  • AccessDeniedException –

    You do not have sufficient access to perform this action.

  • ConflictException –

    The request conflicts with the current state of the resource.

  • InternalServerException –

    An unexpected error occurred during the processing of the request.

  • ResourceNotFoundException –

    The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.

  • ThrottlingException –

    The request was denied because it exceeded the allowed request rate.

  • ValidationException –

    A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

  • UnknownServiceError –

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

Examples:

Delete a notify code configuration

>>> client.delete_notify_code_configuration(notify_code_configuration_id='ncc-abc12345678901234')
Source code in docs_src/capo_endusermessaging/_services/end_user_messaging.py 
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
def delete_notify_code_configuration(
    self,
    notify_code_configuration_id: "capo_endusermessaging.types.notify_code_configuration_id_or_arn.NotifyCodeConfigurationIdOrArn",
    *,
    config_overrides: Optional[EndUserMessagingClientConfig] = None,
) -> "capo_endusermessaging.types.delete_notify_code_configuration_output.DeleteNotifyCodeConfigurationOutput":
    """<p>Deletes a notify code configuration. Verifications that are already in progress are not affected, because they capture the policy at the time that the passcode was sent.</p>

    Args:
        notify_code_configuration_id: <p>The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).</p>

    Raises:
        capo_endusermessaging.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_endusermessaging.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource.</p>
        capo_endusermessaging.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of the request.</p>
        capo_endusermessaging.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
        capo_endusermessaging.errors.throttling_exception.ThrottlingException: <p>The request was denied because it exceeded the allowed request rate.</p>
        capo_endusermessaging.errors.validation_exception.ValidationException: A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
        capo_endusermessaging.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Delete a notify code configuration

        >>> client.delete_notify_code_configuration(notify_code_configuration_id='ncc-abc12345678901234')
    """

    def _handler(
        req: "OperationRequest[capo_endusermessaging.types.delete_notify_code_configuration_input.DeleteNotifyCodeConfigurationInput]",
    ) -> OperationResponse[
        "capo_endusermessaging.types.delete_notify_code_configuration_output.DeleteNotifyCodeConfigurationOutput"
    ]:
        import capo_endusermessaging._operations.end_user_messaging.delete_notify_code_configuration

        output, http_response = (
            capo_endusermessaging._operations.end_user_messaging.delete_notify_code_configuration.delete_notify_code_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteNotifyCodeConfiguration")
    )
    input_: capo_endusermessaging.types.delete_notify_code_configuration_input.DeleteNotifyCodeConfigurationInput = {
        "notify_code_configuration_id": notify_code_configuration_id
    }

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