Skip to content

get_user_journey

get_user_journey(
    system_arn: Arn,
    user_journey_id: UserJourneyId,
    *,
    config_overrides: Optional[resiliencehubv2ClientConfig] = None,
) -> GetUserJourneyResponse

Retrieves a user journey.

Parameters:

  • user_journey_id (UserJourneyId) –

    The identifier of the user journey to retrieve.

Raises:

Source code in docs_src/capo_resiliencehubv2/_services/resiliencehubv2.py
def get_user_journey(
    self,
    system_arn: "capo_resiliencehubv2.types.arn.Arn",
    user_journey_id: "capo_resiliencehubv2.types.user_journey_id.UserJourneyId",
    *,
    config_overrides: Optional[resiliencehubv2ClientConfig] = None,
) -> "capo_resiliencehubv2.types.get_user_journey_response.GetUserJourneyResponse":
    """<p>Retrieves a user journey.</p>

    Args:
        user_journey_id: <p>The identifier of the user journey to retrieve.</p>

    Raises:
        capo_resiliencehubv2.errors.access_denied_exception.AccessDeniedException: <p>Access denied — caller lacks required permissions.</p>
        capo_resiliencehubv2.errors.internal_server_exception.InternalServerException: <p>Internal service error.</p>
        capo_resiliencehubv2.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource not found.</p>
        capo_resiliencehubv2.errors.validation_exception.ValidationException: <p>Validation error — invalid input parameters.</p>
        capo_resiliencehubv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_resiliencehubv2.types.get_user_journey_request.GetUserJourneyRequest]",
    ) -> OperationResponse[
        "capo_resiliencehubv2.types.get_user_journey_response.GetUserJourneyResponse"
    ]:
        import capo_resiliencehubv2._operations.ngrh_service_core.get_user_journey

        output, http_response = (
            capo_resiliencehubv2._operations.ngrh_service_core.get_user_journey.get_user_journey(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetUserJourney")
    )
    input_: capo_resiliencehubv2.types.get_user_journey_request.GetUserJourneyRequest = {
        "system_arn": system_arn,
        "user_journey_id": user_journey_id,
    }

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