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

************************
start_contact_evaluation
************************



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

  

  Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.

   

  .. note::

    

    Evaluations created through the public API do not contain answer values suggested from automation.

    

  

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


  **Request Syntax**
  ::

    response = client.start_contact_evaluation(
        InstanceId='string',
        ContactId='string',
        EvaluationFormId='string',
        AutoEvaluationConfiguration={
            'Enabled': True|False
        },
        ClientToken='string',
        Tags={
            'string': '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 EvaluationFormId: string
  :param EvaluationFormId: **[REQUIRED]** 

    The unique identifier for the evaluation form.

    

  
  :type AutoEvaluationConfiguration: dict
  :param AutoEvaluationConfiguration: 

    Whether automated evaluations are enabled.

    

  
    - **Enabled** *(boolean) --* **[REQUIRED]** 

      Whether automated evaluations are enabled.

      

    
  
  :type ClientToken: string
  :param ClientToken: 

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see `Making retries safe with idempotent APIs <https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/>`__.

    This field is autopopulated if not provided.

  
  :type Tags: dict
  :param Tags: 

    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


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

    
    ::

      {
          'EvaluationId': 'string',
          'EvaluationArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        A unique identifier for the contact evaluation.

        
      

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

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

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

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

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

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

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

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

  