:doc:`Connect <../../connect>` / Client / list_contact_evaluations

************************
list_contact_evaluations
************************



.. py:method:: Connect.Client.list_contact_evaluations(**kwargs)

  

  Lists contact evaluations in the specified Amazon Connect instance.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactEvaluations>`_  


  **Request Syntax**
  ::

    response = client.list_contact_evaluations(
        InstanceId='string',
        ContactId='string',
        NextToken='string'
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

    

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

    The identifier of the contact in this instance of Amazon Connect.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

     

    .. warning::

       

      This is not expected to be set because the value returned in the previous response is always null.

      

    

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

    
    ::

      {
          'EvaluationSummaryList': [
              {
                  'EvaluationId': 'string',
                  'EvaluationArn': 'string',
                  'EvaluationFormTitle': 'string',
                  'EvaluationFormId': 'string',
                  'CalibrationSessionId': 'string',
                  'Status': 'DRAFT'|'SUBMITTED'|'REVIEW_REQUESTED'|'UNDER_REVIEW',
                  'AutoEvaluationEnabled': True|False,
                  'AutoEvaluationStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
                  'EvaluatorArn': 'string',
                  'Score': {
                      'Percentage': 123.0,
                      'NotApplicable': True|False,
                      'AutomaticFail': True|False,
                      'AppliedWeight': 123.0
                  },
                  'Acknowledgement': {
                      'AcknowledgedTime': datetime(2015, 1, 1),
                      'AcknowledgedBy': 'string',
                      'AcknowledgerComment': 'string'
                  },
                  'EvaluationType': 'STANDARD'|'CALIBRATION',
                  'CreatedTime': datetime(2015, 1, 1),
                  'LastModifiedTime': datetime(2015, 1, 1),
                  'ContactParticipant': {
                      'ContactParticipantRole': 'AGENT'|'SYSTEM'|'CUSTOM_BOT',
                      'ContactParticipantId': 'string'
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **EvaluationSummaryList** *(list) --* 

        Provides details about a list of contact evaluations belonging to an instance.

        
        

        - *(dict) --* 

          Summary information about a contact evaluation.

          
          

          - **EvaluationId** *(string) --* 

            A unique identifier for the contact evaluation.

            
          

          - **EvaluationArn** *(string) --* 

            The Amazon Resource Name (ARN) for the contact evaluation resource.

            
          

          - **EvaluationFormTitle** *(string) --* 

            A title of the evaluation form.

            
          

          - **EvaluationFormId** *(string) --* 

            The unique identifier for the evaluation form.

            
          

          - **CalibrationSessionId** *(string) --* 

            The calibration session ID that this evaluation belongs to.

            
          

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

            The status of the contact evaluation.

            
          

          - **AutoEvaluationEnabled** *(boolean) --* 

            Whether automated evaluation is enabled.

            
          

          - **AutoEvaluationStatus** *(string) --* 

            The status of the contact auto evaluation.

            
          

          - **EvaluatorArn** *(string) --* 

            The Amazon Resource Name (ARN) of the user who last updated the evaluation.

            
          

          - **Score** *(dict) --* 

            The overall score of the contact evaluation.

            
            

            - **Percentage** *(float) --* 

              The score percentage for an item in a contact evaluation.

              
            

            - **NotApplicable** *(boolean) --* 

              The flag to mark the item as not applicable for scoring.

              
            

            - **AutomaticFail** *(boolean) --* 

              The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.

              
            

            - **AppliedWeight** *(float) --* 

              Weight applied to this evaluation score.

              
        
          

          - **Acknowledgement** *(dict) --* 

            Information related to evaluation acknowledgement.

            
            

            - **AcknowledgedTime** *(datetime) --* 

              The time when an agent acknowledged the evaluation.

              
            

            - **AcknowledgedBy** *(string) --* 

              The agent who acknowledged the evaluation.

              
            

            - **AcknowledgerComment** *(string) --* 

              A comment from the agent when they confirmed they acknowledged the evaluation.

              
        
          

          - **EvaluationType** *(string) --* 

            Type of the evaluation.

            
          

          - **CreatedTime** *(datetime) --* 

            The timestamp for when the evaluation was created.

            
          

          - **LastModifiedTime** *(datetime) --* 

            The timestamp for when the evaluation was last updated.

            
          

          - **ContactParticipant** *(dict) --* 

            Information about a contact participant in the evaluation.

            
            

            - **ContactParticipantRole** *(string) --* 

              The role of the contact participant.

              
            

            - **ContactParticipantId** *(string) --* 

              The identifier for the contact participant.

              
        
      
    
      

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

        If there are additional results, this is the token for the next set of results.

         

        .. warning::

           

          This is always returned as null in the response.

          

        
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidParameterException`

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

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

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  