ResilienceHubV2 / Client / get_user_journey

get_user_journey

ResilienceHubV2.Client.get_user_journey(**kwargs)

Retrieves a user journey.

See also: AWS API Documentation

Request Syntax

response = client.get_user_journey(
    systemArn='string',
    userJourneyId='string'
)
Parameters:
  • systemArn (string) –

    [REQUIRED]

    ARN identifier.

  • userJourneyId (string) –

    [REQUIRED]

    The identifier of the user journey to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'userJourney': {
        'userJourneyId': 'string',
        'name': 'string',
        'description': 'string',
        'policyArn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • userJourney (dict) –

      The requested user journey.

      • userJourneyId (string) –

        The unique identifier of the user journey.

      • name (string) –

        Entity label (not part of ARN — spaces allowed).

      • description (string) –

        Resource description.

      • policyArn (string) –

        ARN identifier.

      • createdAt (datetime) –

        The timestamp when the user journey was created.

      • updatedAt (datetime) –

        The timestamp when the user journey was last updated.

Exceptions

  • ResilienceHubV2.Client.exceptions.InternalServerException

  • ResilienceHubV2.Client.exceptions.ResourceNotFoundException

  • ResilienceHubV2.Client.exceptions.ValidationException

  • ResilienceHubV2.Client.exceptions.AccessDeniedException