Skip to content

get_journey 

get_journey(
    application_id: __string,
    journey_id: __string,
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
) -> GetJourneyResponse

Retrieves information about the status, configuration, and other settings for a 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:

Source code in docs_src/capo_pinpoint/_services/pinpoint.py 
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
def get_journey(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    journey_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
) -> "capo_pinpoint.types.get_journey_response.GetJourneyResponse":
    """<p>Retrieves information about the status, configuration, and other settings for a 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.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint.types.get_journey_request.GetJourneyRequest]",
    ) -> OperationResponse[
        "capo_pinpoint.types.get_journey_response.GetJourneyResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.get_journey

        output, http_response = (
            capo_pinpoint._operations.pinpoint.get_journey.get_journey(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetJourney")
    )
    input_: capo_pinpoint.types.get_journey_request.GetJourneyRequest = {
        "application_id": application_id,
        "journey_id": journey_id,
    }

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