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

******************
list_check_details
******************



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

  

  List of Trusted Advisor check details by account related to the workload.

  

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


  **Request Syntax**
  ::

    response = client.list_check_details(
        WorkloadId='string',
        NextToken='string',
        MaxResults=123,
        LensArn='string',
        PillarId='string',
        QuestionId='string',
        ChoiceId='string'
    )
    
  :type WorkloadId: string
  :param WorkloadId: **[REQUIRED]** 

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

    

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

    

  
  :type LensArn: string
  :param LensArn: **[REQUIRED]** 

    Well-Architected Lens ARN.

    

  
  :type PillarId: string
  :param PillarId: **[REQUIRED]** 

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

     

    A pillar is identified by its  PillarReviewSummary$PillarId.

    

  
  :type QuestionId: string
  :param QuestionId: **[REQUIRED]** 

    The ID of the question.

    

  
  :type ChoiceId: string
  :param ChoiceId: **[REQUIRED]** 

    The ID of a choice.

    

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

    
    ::

      {
          'CheckDetails': [
              {
                  'Id': 'string',
                  'Name': 'string',
                  'Description': 'string',
                  'Provider': 'TRUSTED_ADVISOR',
                  'LensArn': 'string',
                  'PillarId': 'string',
                  'QuestionId': 'string',
                  'ChoiceId': 'string',
                  'Status': 'OKAY'|'WARNING'|'ERROR'|'NOT_AVAILABLE'|'FETCH_FAILED',
                  'AccountId': 'string',
                  'FlaggedResources': 123,
                  'Reason': 'ASSUME_ROLE_ERROR'|'ACCESS_DENIED'|'UNKNOWN_ERROR'|'PREMIUM_SUPPORT_REQUIRED',
                  'UpdatedAt': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **CheckDetails** *(list) --* 

        The details about the Trusted Advisor checks related to the Well-Architected best practice.

        
        

        - *(dict) --* 

          Account details for a Well-Architected best practice in relation to Trusted Advisor checks.

          
          

          - **Id** *(string) --* 

            Trusted Advisor check ID.

            
          

          - **Name** *(string) --* 

            Trusted Advisor check name.

            
          

          - **Description** *(string) --* 

            Trusted Advisor check description.

            
          

          - **Provider** *(string) --* 

            Provider of the check related to the best practice.

            
          

          - **LensArn** *(string) --* 

            Well-Architected Lens ARN associated to the check.

            
          

          - **PillarId** *(string) --* 

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

             

            A pillar is identified by its  PillarReviewSummary$PillarId.

            
          

          - **QuestionId** *(string) --* 

            The ID of the question.

            
          

          - **ChoiceId** *(string) --* 

            The ID of a choice.

            
          

          - **Status** *(string) --* 

            Status associated to the check.

            
          

          - **AccountId** *(string) --* 

            An Amazon Web Services account ID.

            
          

          - **FlaggedResources** *(integer) --* 

            Count of flagged resources associated to the check.

            
          

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

            Reason associated to the check.

            
          

          - **UpdatedAt** *(datetime) --* 

            The date and time recorded.

            
      
    
      

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

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

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

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

  