update_journey_state `async` ¶

update_journey_state(
    application_id: __string,
    journey_id: __string,
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
    journey_state_request: Optional[JourneyStateRequest] = None,
) -> UpdateJourneyStateResponse

Cancels (stops) an active journey.

Parameters:

application_id (__string) –

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
journey_id (__string) –

The unique identifier for the journey.

Raises:

BadRequestException –

Provides information about an API request or response.
ForbiddenException –

Provides information about an API request or response.
InternalServerErrorException –

Provides information about an API request or response.
MethodNotAllowedException –

Provides information about an API request or response.
NotFoundException –

Provides information about an API request or response.
PayloadTooLargeException –

Provides information about an API request or response.
TooManyRequestsException –

Provides information about an API request or response.
UnknownServiceError –

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

Source code in docs_src/capo_pinpoint/_services/async_pinpoint.py

async def update_journey_state(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    journey_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
    journey_state_request: Optional[
        "capo_pinpoint.types.journey_state_request.JourneyStateRequest"
    ] = None,
) -> "capo_pinpoint.types.update_journey_state_response.UpdateJourneyStateResponse":
    """<p>Cancels (stops) an active journey.</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>
        journey_id: <p>The unique identifier for the journey.</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.update_journey_state_request.UpdateJourneyStateRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint.types.update_journey_state_response.UpdateJourneyStateResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.update_journey_state

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateJourneyState")
    )
    input_: capo_pinpoint.types.update_journey_state_request.UpdateJourneyStateRequest = {
        "application_id": application_id,
        "journey_id": journey_id,
    }
    if journey_state_request is not None:
        input_["journey_state_request"] = journey_state_request

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

update_journey_state async ¶

update_journey_state `async` ¶