Skip to content

send_otp_message async

send_otp_message(
    application_id: __string,
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
    send_otp_message_request_parameters: Optional[
        SendOTPMessageRequestParameters
    ] = None,
) -> SendOTPMessageResponse

Send an OTP message

Parameters:

  • application_id (__string) –

    The unique ID of your Amazon Pinpoint application.

Raises:

Source code in docs_src/capo_pinpoint/_services/async_pinpoint.py
async def send_otp_message(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
    send_otp_message_request_parameters: Optional[
        "capo_pinpoint.types.send_otp_message_request_parameters.SendOTPMessageRequestParameters"
    ] = None,
) -> "capo_pinpoint.types.send_otp_message_response.SendOTPMessageResponse":
    """<p>Send an OTP message</p>

    Args:
        application_id: <p>The unique ID of your Amazon Pinpoint application.</p>

    Raises:
        capo_pinpoint.errors.bad_request_exception.BadRequestException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.forbidden_exception.ForbiddenException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.internal_server_error_exception.InternalServerErrorException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.method_not_allowed_exception.MethodNotAllowedException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.not_found_exception.NotFoundException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.payload_too_large_exception.PayloadTooLargeException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.too_many_requests_exception.TooManyRequestsException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_pinpoint.types.send_otp_message_request.SendOTPMessageRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint.types.send_otp_message_response.SendOTPMessageResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.send_otp_message

        (
            output,
            http_response,
        ) = await capo_pinpoint._operations.pinpoint.send_otp_message.async_send_otp_message(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SendOTPMessage")
    )
    input_: capo_pinpoint.types.send_otp_message_request.SendOTPMessageRequest = {
        "application_id": application_id
    }
    if send_otp_message_request_parameters is not None:
        input_["send_otp_message_request_parameters"] = (
            send_otp_message_request_parameters
        )

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