Skip to content

get_in_app_messages async 

get_in_app_messages(
    application_id: __string,
    endpoint_id: __string,
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
) -> GetInAppMessagesResponse

Retrieves the in-app messages targeted for the provided endpoint ID.

Parameters:

  • application_id (__string) –

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

  • endpoint_id (__string) –

    The unique identifier for the endpoint.

Raises:

Source code in docs_src/capo_pinpoint/_services/async_pinpoint.py 
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
async def get_in_app_messages(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    endpoint_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
) -> "capo_pinpoint.types.get_in_app_messages_response.GetInAppMessagesResponse":
    """<p>Retrieves the in-app messages targeted for the provided endpoint ID.</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>
        endpoint_id: <p>The unique identifier for the endpoint.</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.get_in_app_messages_request.GetInAppMessagesRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint.types.get_in_app_messages_response.GetInAppMessagesResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.get_in_app_messages

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetInAppMessages")
    )
    input_: capo_pinpoint.types.get_in_app_messages_request.GetInAppMessagesRequest = {
        "application_id": application_id,
        "endpoint_id": endpoint_id,
    }

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