WellArchitected / Client / get_profile

get_profile

WellArchitected.Client.get_profile(**kwargs)

Get profile information.

See also: AWS API Documentation

Request Syntax

response = client.get_profile(
    ProfileArn='string',
    ProfileVersion='string'
)

Parameters:

• ProfileArn (string) –

  [REQUIRED]

  The profile ARN.

• ProfileVersion (string) – The profile version.

Return type:

dict

Returns:

Response Syntax

{
    'Profile': {
        'ProfileArn': 'string',
        'ProfileVersion': 'string',
        'ProfileName': 'string',
        'ProfileDescription': 'string',
        'ProfileQuestions': [
            {
                'QuestionId': 'string',
                'QuestionTitle': 'string',
                'QuestionDescription': 'string',
                'QuestionChoices': [
                    {
                        'ChoiceId': 'string',
                        'ChoiceTitle': 'string',
                        'ChoiceDescription': 'string'
                    },
                ],
                'SelectedChoiceIds': [
                    'string',
                ],
                'MinSelectedChoices': 123,
                'MaxSelectedChoices': 123
            },
        ],
        'Owner': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'ShareInvitationId': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) –

  • Profile (dict) –

    The profile.

    • ProfileArn (string) –

      The profile ARN.

    • ProfileVersion (string) –

      The profile version.

    • ProfileName (string) –

      The profile name.

    • ProfileDescription (string) –

      The profile description.

    • ProfileQuestions (list) –

      Profile questions.

      • (dict) –

        A profile question.

        • QuestionId (string) –

          The ID of the question.

        • QuestionTitle (string) –

          The title of the question.

        • QuestionDescription (string) –

          The description of the question.

        • QuestionChoices (list) –

          The question choices.

          • (dict) –

            The profile choice.

            • ChoiceId (string) –

              The ID of a choice.

            • ChoiceTitle (string) –

              The title of a choice.

            • ChoiceDescription (string) –

              The description of a choice.

        • SelectedChoiceIds (list) –

          The selected choices.

          • (string) –

            The ID of a choice.

        • MinSelectedChoices (integer) –

          The minimum number of selected choices.

        • MaxSelectedChoices (integer) –

          The maximum number of selected choices.

    • Owner (string) –

      An Amazon Web Services account ID.

    • CreatedAt (datetime) –

      The date and time recorded.

    • UpdatedAt (datetime) –

      The date and time recorded.

    • ShareInvitationId (string) –

      The ID assigned to the share invitation.

    • Tags (dict) –

      The tags assigned to the profile.

      • (string) –

        • (string) –

Exceptions

• WellArchitected.Client.exceptions.ValidationException

• WellArchitected.Client.exceptions.ResourceNotFoundException

• WellArchitected.Client.exceptions.InternalServerException

• WellArchitected.Client.exceptions.AccessDeniedException

• WellArchitected.Client.exceptions.ThrottlingException