WellArchitected / Client / list_answers

list_answers

WellArchitected.Client.list_answers(**kwargs)

List of answers for a particular workload and lens.

See also: AWS API Documentation

Request Syntax

response = client.list_answers(
    WorkloadId='string',
    LensAlias='string',
    PillarId='string',
    MilestoneNumber=123,
    NextToken='string',
    MaxResults=123
)

Parameters:

• WorkloadId (string) –

  [REQUIRED]

  The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

• LensAlias (string) –

  [REQUIRED]

  The alias of the lens.

  For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

  For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

  Each lens is identified by its LensSummary$LensAlias.

• PillarId (string) –

  The ID used to identify a pillar, for example, security.

  A pillar is identified by its PillarReviewSummary$PillarId.

• MilestoneNumber (integer) –

  The milestone number.

  A workload can have a maximum of 100 milestones.

• NextToken (string) – The token to use to retrieve the next set of results.

• MaxResults (integer) – The maximum number of results to return for this request.

Return type:

dict

Returns:

Response Syntax

{
    'WorkloadId': 'string',
    'MilestoneNumber': 123,
    'LensAlias': 'string',
    'LensArn': 'string',
    'AnswerSummaries': [
        {
            'QuestionId': 'string',
            'PillarId': 'string',
            'QuestionTitle': 'string',
            'Choices': [
                {
                    'ChoiceId': 'string',
                    'Title': 'string',
                    'Description': 'string',
                    'HelpfulResource': {
                        'DisplayText': 'string',
                        'Url': 'string'
                    },
                    'ImprovementPlan': {
                        'DisplayText': 'string',
                        'Url': 'string'
                    },
                    'AdditionalResources': [
                        {
                            'Type': 'HELPFUL_RESOURCE'|'IMPROVEMENT_PLAN',
                            'Content': [
                                {
                                    'DisplayText': 'string',
                                    'Url': 'string'
                                },
                            ]
                        },
                    ]
                },
            ],
            'SelectedChoices': [
                'string',
            ],
            'ChoiceAnswerSummaries': [
                {
                    'ChoiceId': 'string',
                    'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
                    'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
                },
            ],
            'IsApplicable': True|False,
            'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
            'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Output of a list answers call.

  • WorkloadId (string) –

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

  • MilestoneNumber (integer) –

    The milestone number.

    A workload can have a maximum of 100 milestones.

  • LensAlias (string) –

    The alias of the lens.

    For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

    Each lens is identified by its LensSummary$LensAlias.

  • LensArn (string) –

    The ARN for the lens.

  • AnswerSummaries (list) –

    List of answer summaries of lens review in a workload.

    • (dict) –

      An answer summary of a lens review in a workload.

      • QuestionId (string) –

        The ID of the question.

      • PillarId (string) –

        The ID used to identify a pillar, for example, security.

        A pillar is identified by its PillarReviewSummary$PillarId.

      • QuestionTitle (string) –

        The title of the question.

      • Choices (list) –

        List of choices available for a question.

        • (dict) –

          A choice available to answer question.

          • ChoiceId (string) –

            The ID of a choice.

          • Title (string) –

            The title of a choice.

          • Description (string) –

            The description of a choice.

          • HelpfulResource (dict) –

            The helpful resource (both text and URL) for a particular choice.

            This field only applies to custom lenses. Each choice can have only one helpful resource.

            • DisplayText (string) –

              The display text for the choice content.

            • Url (string) –

              The URL for the choice content.

          • ImprovementPlan (dict) –

            The improvement plan (both text and URL) for a particular choice.

            This field only applies to custom lenses. Each choice can have only one improvement plan.

            • DisplayText (string) –

              The display text for the choice content.

            • Url (string) –

              The URL for the choice content.

          • AdditionalResources (list) –

            The additional resources for a choice in a custom lens.

            A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.

            • (dict) –

              The choice level additional resources for a custom lens.

              This field does not apply to Amazon Web Services official lenses.

              • Type (string) –

                Type of additional resource for a custom lens.

              • Content (list) –

                The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.

                • (dict) –

                  The choice content.

                  • DisplayText (string) –

                    The display text for the choice content.

                  • Url (string) –

                    The URL for the choice content.

      • SelectedChoices (list) –

        List of selected choice IDs in a question answer.

        The values entered replace the previously selected choices.

        • (string) –

          The ID of a choice.

      • ChoiceAnswerSummaries (list) –

        A list of selected choices to a question in your workload.

        • (dict) –

          A choice summary that has been answered on a question in your workload.

          • ChoiceId (string) –

            The ID of a choice.

          • Status (string) –

            The status of a choice.

          • Reason (string) –

            The reason why a choice is non-applicable to a question in your workload.

      • IsApplicable (boolean) –

        Defines whether this question is applicable to a lens review.

      • Risk (string) –

        The risk for a given workload, lens review, pillar, or question.

      • Reason (string) –

        The reason why a choice is non-applicable to a question in your workload.

  • NextToken (string) –

    The token to use to retrieve the next set of results.

Exceptions

• WellArchitected.Client.exceptions.ValidationException

• WellArchitected.Client.exceptions.InternalServerException

• WellArchitected.Client.exceptions.ResourceNotFoundException

• WellArchitected.Client.exceptions.AccessDeniedException

• WellArchitected.Client.exceptions.ThrottlingException