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

************************
describe_evaluation_form
************************



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

  

  Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.

  

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


  **Request Syntax**
  ::

    response = client.describe_evaluation_form(
        InstanceId='string',
        EvaluationFormId='string',
        EvaluationFormVersion=123
    )
    
  :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 EvaluationFormId: string
  :param EvaluationFormId: **[REQUIRED]** 

    A unique identifier for the contact evaluation.

    

  
  :type EvaluationFormVersion: integer
  :param EvaluationFormVersion: 

    A version of the evaluation form.

    

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

    
    ::

      {
          'EvaluationForm': {
              'EvaluationFormId': 'string',
              'EvaluationFormVersion': 123,
              'Locked': True|False,
              'EvaluationFormArn': 'string',
              'Title': 'string',
              'Description': 'string',
              'Status': 'DRAFT'|'ACTIVE',
              'Items': [
                  {
                      'Section': {
                          'Title': 'string',
                          'RefId': 'string',
                          'Instructions': 'string',
                          'Items': {'... recursive ...'},
                          'Weight': 123.0
                      },
                      'Question': {
                          'Title': 'string',
                          'Instructions': 'string',
                          'RefId': 'string',
                          'NotApplicableEnabled': True|False,
                          'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC'|'MULTISELECT'|'DATETIME',
                          'QuestionTypeProperties': {
                              'Numeric': {
                                  'MinValue': 123,
                                  'MaxValue': 123,
                                  'Options': [
                                      {
                                          'MinValue': 123,
                                          'MaxValue': 123,
                                          'Score': 123,
                                          'AutomaticFail': True|False,
                                          'AutomaticFailConfiguration': {
                                              'TargetSection': 'string'
                                          }
                                      },
                                  ],
                                  'Automation': {
                                      'PropertyValue': {
                                          'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'
                                      },
                                      'AnswerSource': {
                                          'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
                                      }
                                  }
                              },
                              'SingleSelect': {
                                  'Options': [
                                      {
                                          'RefId': 'string',
                                          'Text': 'string',
                                          'Score': 123,
                                          'AutomaticFail': True|False,
                                          'AutomaticFailConfiguration': {
                                              'TargetSection': 'string'
                                          }
                                      },
                                  ],
                                  'DisplayAs': 'DROPDOWN'|'RADIO',
                                  'Automation': {
                                      'Options': [
                                          {
                                              'RuleCategory': {
                                                  'Category': 'string',
                                                  'Condition': 'PRESENT'|'NOT_PRESENT',
                                                  'OptionRefId': 'string'
                                              }
                                          },
                                      ],
                                      'DefaultOptionRefId': 'string',
                                      'AnswerSource': {
                                          'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
                                      }
                                  }
                              },
                              'Text': {
                                  'Automation': {
                                      'AnswerSource': {
                                          'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
                                      }
                                  }
                              },
                              'MultiSelect': {
                                  'Options': [
                                      {
                                          'RefId': 'string',
                                          'Text': 'string'
                                      },
                                  ],
                                  'DisplayAs': 'DROPDOWN'|'CHECKBOX',
                                  'Automation': {
                                      'Options': [
                                          {
                                              'RuleCategory': {
                                                  'Category': 'string',
                                                  'Condition': 'PRESENT'|'NOT_PRESENT',
                                                  'OptionRefIds': [
                                                      'string',
                                                  ]
                                              }
                                          },
                                      ],
                                      'DefaultOptionRefIds': [
                                          'string',
                                      ],
                                      'AnswerSource': {
                                          'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
                                      }
                                  }
                              }
                          },
                          'Enablement': {
                              'Condition': {
                                  'Operands': [
                                      {
                                          'Expression': {
                                              'Source': {
                                                  'Type': 'QUESTION_REF_ID',
                                                  'RefId': 'string'
                                              },
                                              'Values': [
                                                  {
                                                      'Type': 'OPTION_REF_ID',
                                                      'RefId': 'string'
                                                  },
                                              ],
                                              'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'
                                          },
                                          'Condition': {'... recursive ...'}
                                      },
                                  ],
                                  'Operator': 'OR'|'AND'
                              },
                              'Action': 'DISABLE'|'ENABLE',
                              'DefaultAction': 'DISABLE'|'ENABLE'
                          },
                          'Weight': 123.0
                      }
                  },
              ],
              'ScoringStrategy': {
                  'Mode': 'QUESTION_ONLY'|'SECTION_ONLY',
                  'Status': 'ENABLED'|'DISABLED'
              },
              'CreatedTime': datetime(2015, 1, 1),
              'CreatedBy': 'string',
              'LastModifiedTime': datetime(2015, 1, 1),
              'LastModifiedBy': 'string',
              'AutoEvaluationConfiguration': {
                  'Enabled': True|False
              },
              'ReviewConfiguration': {
                  'ReviewNotificationRecipients': [
                      {
                          'Type': 'USER_ID',
                          'Value': {
                              'UserId': 'string'
                          }
                      },
                  ],
                  'EligibilityDays': 123
              },
              'Tags': {
                  'string': 'string'
              },
              'TargetConfiguration': {
                  'ContactInteractionType': 'AGENT'|'AUTOMATED'
              },
              'LanguageConfiguration': {
                  'FormLanguage': 'de-DE'|'en-US'|'es-ES'|'fr-FR'|'it-IT'|'pt-BR'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **EvaluationForm** *(dict) --* 

        Information about the evaluation form.

        
        

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

          The unique identifier for the evaluation form.

          
        

        - **EvaluationFormVersion** *(integer) --* 

          A version of the evaluation form.

          
        

        - **Locked** *(boolean) --* 

          The flag indicating whether the evaluation form is locked for changes.

          
        

        - **EvaluationFormArn** *(string) --* 

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

          
        

        - **Title** *(string) --* 

          A title of the evaluation form.

          
        

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

          The description of the evaluation form.

          
        

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

          The status of the evaluation form.

          
        

        - **Items** *(list) --* 

          Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

          
          

          - *(dict) --* 

            Information about an item from an evaluation form. The item must be either a section or a question.

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``Section``, ``Question``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


          
            

            - **Section** *(dict) --* 

              The information of the section.

              
              

              - **Title** *(string) --* 

                The title of the section.

                
              

              - **RefId** *(string) --* 

                The identifier of the section. An identifier must be unique within the evaluation form.

                
              

              - **Instructions** *(string) --* 

                The instructions of the section.

                
              

              - **Items** *(list) --* 

                The items of the section.

                
              

              - **Weight** *(float) --* 

                The scoring weight of the section.

                
          
            

            - **Question** *(dict) --* 

              The information of the question.

              
              

              - **Title** *(string) --* 

                The title of the question.

                
              

              - **Instructions** *(string) --* 

                The instructions of the section.

                
              

              - **RefId** *(string) --* 

                The identifier of the question. An identifier must be unique within the evaluation form.

                
              

              - **NotApplicableEnabled** *(boolean) --* 

                The flag to enable not applicable answers to the question.

                
              

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

                The type of the question.

                
              

              - **QuestionTypeProperties** *(dict) --* 

                The properties of the type of question. Text questions do not have to define question type properties.

                .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``Numeric``, ``SingleSelect``, ``Text``, ``MultiSelect``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


              
                

                - **Numeric** *(dict) --* 

                  The properties of the numeric question.

                  
                  

                  - **MinValue** *(integer) --* 

                    The minimum answer value.

                    
                  

                  - **MaxValue** *(integer) --* 

                    The maximum answer value.

                    
                  

                  - **Options** *(list) --* 

                    The scoring options of the numeric question.

                    
                    

                    - *(dict) --* 

                      Information about the option range used for scoring in numeric questions.

                      
                      

                      - **MinValue** *(integer) --* 

                        The minimum answer value of the range option.

                        
                      

                      - **MaxValue** *(integer) --* 

                        The maximum answer value of the range option.

                        
                      

                      - **Score** *(integer) --* 

                        The score assigned to answer values within the range option.

                        
                      

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

                        The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

                        
                      

                      - **AutomaticFailConfiguration** *(dict) --* 

                        A configuration for automatic fail.

                        
                        

                        - **TargetSection** *(string) --* 

                          The referenceId of the target section for auto failure.

                          
                    
                  
                
                  

                  - **Automation** *(dict) --* 

                    The automation properties of the numeric question.

                    .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``PropertyValue``, ``AnswerSource``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                                        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


                  
                    

                    - **PropertyValue** *(dict) --* 

                      The property value of the automation.

                      
                      

                      - **Label** *(string) --* 

                        The property label of the automation.

                        
                  
                    

                    - **AnswerSource** *(dict) --* 

                      A source of automation answer for numeric question.

                      
                      

                      - **SourceType** *(string) --* 

                        The automation answer source type.

                        
                  
                
              
                

                - **SingleSelect** *(dict) --* 

                  The properties of the numeric question.

                  
                  

                  - **Options** *(list) --* 

                    The answer options of the single select question.

                    
                    

                    - *(dict) --* 

                      Information about the automation configuration in single select questions.

                      
                      

                      - **RefId** *(string) --* 

                        The identifier of the answer option. An identifier must be unique within the question.

                        
                      

                      - **Text** *(string) --* 

                        The title of the answer option.

                        
                      

                      - **Score** *(integer) --* 

                        The score assigned to the answer option.

                        
                      

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

                        The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

                        
                      

                      - **AutomaticFailConfiguration** *(dict) --* 

                        Whether automatic fail is configured on a single select question.

                        
                        

                        - **TargetSection** *(string) --* 

                          The referenceId of the target section for auto failure.

                          
                    
                  
                
                  

                  - **DisplayAs** *(string) --* 

                    The display mode of the single select question.

                    
                  

                  - **Automation** *(dict) --* 

                    The display mode of the single select question.

                    
                    

                    - **Options** *(list) --* 

                      The automation options of the single select question.

                      
                      

                      - *(dict) --* 

                        Information about the automation option of a single select question.

                        .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``RuleCategory``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                                                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


                      
                        

                        - **RuleCategory** *(dict) --* 

                          The automation option based on a rule category for the single select question.

                          
                          

                          - **Category** *(string) --* 

                            The category name, as defined in Rules.

                            
                          

                          - **Condition** *(string) --* 

                            The condition to apply for the automation option. If the condition is ``PRESENT``, then the option is applied when the contact data includes the category. Similarly, if the condition is ``NOT_PRESENT``, then the option is applied when the contact data does not include the category.

                            
                          

                          - **OptionRefId** *(string) --* 

                            The identifier of the answer option.

                            
                      
                    
                  
                    

                    - **DefaultOptionRefId** *(string) --* 

                      The identifier of the default answer option, when none of the automation options match the criteria.

                      
                    

                    - **AnswerSource** *(dict) --* 

                      Automation answer source.

                      
                      

                      - **SourceType** *(string) --* 

                        The automation answer source type.

                        
                  
                
              
                

                - **Text** *(dict) --* 

                  The properties of the text question.

                  
                  

                  - **Automation** *(dict) --* 

                    The automation properties of the text question.

                    
                    

                    - **AnswerSource** *(dict) --* 

                      Automation answer source.

                      
                      

                      - **SourceType** *(string) --* 

                        The automation answer source type.

                        
                  
                
              
                

                - **MultiSelect** *(dict) --* 

                  Properties for multi-select question types.

                  
                  

                  - **Options** *(list) --* 

                    Options available for this multi-select question.

                    
                    

                    - *(dict) --* 

                      An option for a multi-select question in an evaluation form.

                      
                      

                      - **RefId** *(string) --* 

                        Reference identifier for this option.

                        
                      

                      - **Text** *(string) --* 

                        Display text for this option.

                        
                  
                
                  

                  - **DisplayAs** *(string) --* 

                    Display format for the multi-select question.

                    
                  

                  - **Automation** *(dict) --* 

                    Automation configuration for this multi-select question.

                    
                    

                    - **Options** *(list) --* 

                      Automation options for the multi-select question.

                      
                      

                      - *(dict) --* 

                        An automation option for a multi-select question.

                        .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``RuleCategory``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                                                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


                      
                        

                        - **RuleCategory** *(dict) --* 

                          Rule category configuration for this automation option.

                          
                          

                          - **Category** *(string) --* 

                            The category name for this automation rule.

                            
                          

                          - **Condition** *(string) --* 

                            The condition for this automation rule.

                            
                          

                          - **OptionRefIds** *(list) --* 

                            Reference IDs of options for this automation rule.

                            
                            

                            - *(string) --* 
                        
                      
                    
                  
                    

                    - **DefaultOptionRefIds** *(list) --* 

                      Reference IDs of default options.

                      
                      

                      - *(string) --* 
                  
                    

                    - **AnswerSource** *(dict) --* 

                      A question automation answer.

                      
                      

                      - **SourceType** *(string) --* 

                        The automation answer source type.

                        
                  
                
              
            
              

              - **Enablement** *(dict) --* 

                A question conditional enablement.

                
                

                - **Condition** *(dict) --* 

                  A condition for item enablement configuration.

                  
                  

                  - **Operands** *(list) --* 

                    Operands of the enablement condition.

                    
                    

                    - *(dict) --* 

                      An operand of the enablement condition.

                      .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``Expression``, ``Condition``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                                            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


                    
                      

                      - **Expression** *(dict) --* 

                        An expression of the enablement condition.

                        
                        

                        - **Source** *(dict) --* 

                          A source item of enablement expression.

                          
                          

                          - **Type** *(string) --* 

                            A type of source item.

                            
                          

                          - **RefId** *(string) --* 

                            A referenceId of the source item.

                            
                      
                        

                        - **Values** *(list) --* 

                          A list of values from source item.

                          
                          

                          - *(dict) --* 

                            An enablement expression source value.

                            
                            

                            - **Type** *(string) --* 

                              A type of source item value.

                              
                            

                            - **RefId** *(string) --* 

                              A referenceId of the source value.

                              
                        
                      
                        

                        - **Comparator** *(string) --* 

                          A comparator to be used against list of values.

                          
                    
                      

                      - **Condition** *(dict) --* 

                        A condition for item enablement.

                        
                  
                
                  

                  - **Operator** *(string) --* 

                    The operator to be used to be applied to operands if more than one provided.

                    
              
                

                - **Action** *(string) --* 

                  An enablement action that if condition is satisfied.

                  
                

                - **DefaultAction** *(string) --* 

                  An enablement action that if condition is not satisfied.

                  
            
              

              - **Weight** *(float) --* 

                The scoring weight of the section.

                
          
        
      
        

        - **ScoringStrategy** *(dict) --* 

          A scoring strategy of the evaluation form.

          
          

          - **Mode** *(string) --* 

            The scoring mode of the evaluation form.

            
          

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

            The scoring status of the evaluation form.

            
      
        

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

          The timestamp for when the evaluation form was created.

          
        

        - **CreatedBy** *(string) --* 

          The Amazon Resource Name (ARN) of the user who created the evaluation form.

          
        

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

          The timestamp for when the evaluation form was last updated.

          
        

        - **LastModifiedBy** *(string) --* 

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

          
        

        - **AutoEvaluationConfiguration** *(dict) --* 

          The automatic evaluation configuration of an evaluation form.

          
          

          - **Enabled** *(boolean) --* 

            When automated evaluation is enabled.

            
      
        

        - **ReviewConfiguration** *(dict) --* 

          Configuration for evaluation review settings of this evaluation form.

          
          

          - **ReviewNotificationRecipients** *(list) --* 

            List of recipients who should be notified when a review is requested.

            
            

            - *(dict) --* 

              Information about a recipient who should be notified when an evaluation review is requested.

              
              

              - **Type** *(string) --* 

                The type of notification recipient.

                
              

              - **Value** *(dict) --* 

                The value associated with the notification recipient type.

                
                

                - **UserId** *(string) --* 

                  The user identifier for the notification recipient.

                  
            
          
        
          

          - **EligibilityDays** *(integer) --* 

            Number of days during which a request for review can be submitted for evaluations created from this form.

            
      
        

        - **Tags** *(dict) --* 

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

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

        - **TargetConfiguration** *(dict) --* 

          Configuration that specifies the target for this evaluation form.

          
          

          - **ContactInteractionType** *(string) --* 

            The contact interaction type for this evaluation form.

            
      
        

        - **LanguageConfiguration** *(dict) --* 

          Configuration for language settings of this evaluation form.

          
          

          - **FormLanguage** *(string) --* 

            The language for the evaluation form.

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

  