Skip to content

send_users_messages async

send_users_messages(
    application_id: __string,
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
    send_users_message_request: Optional[SendUsersMessageRequest] = None,
) -> SendUsersMessagesResponse

Creates and sends a message to a list of users.

Parameters:

  • application_id (__string) –

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Raises:

Source code in docs_src/capo_pinpoint/_services/async_pinpoint.py
async def send_users_messages(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
    send_users_message_request: Optional[
        "capo_pinpoint.types.send_users_message_request.SendUsersMessageRequest"
    ] = None,
) -> "capo_pinpoint.types.send_users_messages_response.SendUsersMessagesResponse":
    """<p>Creates and sends a message to a list of users.</p>

    Args:
        application_id: <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</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_users_messages_request.SendUsersMessagesRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint.types.send_users_messages_response.SendUsersMessagesResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.send_users_messages

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SendUsersMessages")
    )
    input_: capo_pinpoint.types.send_users_messages_request.SendUsersMessagesRequest = {
        "application_id": application_id
    }
    if send_users_message_request is not None:
        input_["send_users_message_request"] = send_users_message_request

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