:doc:`WellArchitected <../../wellarchitected>` / Client / list_review_template_answers

****************************
list_review_template_answers
****************************



.. py:method:: WellArchitected.Client.list_review_template_answers(**kwargs)

  

  List the answers of a review template.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListReviewTemplateAnswers>`_  


  **Request Syntax**
  ::

    response = client.list_review_template_answers(
        TemplateArn='string',
        LensAlias='string',
        PillarId='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type TemplateArn: string
  :param TemplateArn: **[REQUIRED]** 

    The ARN of the review template.

    

  
  :type LensAlias: string
  :param LensAlias: **[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.

    

  
  :type PillarId: string
  :param PillarId: 

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

     

    A pillar is identified by its  PillarReviewSummary$PillarId.

    

  
  :type NextToken: string
  :param NextToken: 

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

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return for this request.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'TemplateArn': 'string',
          'LensAlias': '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,
                  'AnswerStatus': 'UNANSWERED'|'ANSWERED',
                  'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
                  'QuestionType': 'PRIORITIZED'|'NON_PRIORITIZED'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **TemplateArn** *(string) --* 

        The ARN of the review template.

        
      

      - **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.

        
      

      - **AnswerSummaries** *(list) --* 

        List of answer summaries of a lens review in a review template.

        
        

        - *(dict) --* 

          The summary of review template answers.

          
          

          - **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 the review template.

            
            

            - *(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.

            
          

          - **AnswerStatus** *(string) --* 

            The status of whether or not this question has been answered.

            
          

          - **Reason** *(string) --* 

            The reason why a choice is not-applicable to a question in the review template.

            
          

          - **QuestionType** *(string) --* 

            The type of question.

            
      
    
      

      - **NextToken** *(string) --* 

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

        
  
  **Exceptions**
  
  *   :py:class:`WellArchitected.Client.exceptions.ValidationException`

  
  *   :py:class:`WellArchitected.Client.exceptions.InternalServerException`

  
  *   :py:class:`WellArchitected.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`WellArchitected.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`WellArchitected.Client.exceptions.ThrottlingException`

  