Connect / Client / describe_evaluation_form

describe_evaluation_form

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

Request Syntax

response = client.describe_evaluation_form(
    InstanceId='string',
    EvaluationFormId='string',
    EvaluationFormVersion=123
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

  The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

• EvaluationFormId (string) –

  [REQUIRED]

  A unique identifier for the contact evaluation.

• EvaluationFormVersion (integer) – A version of the evaluation form.

Return type:

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',
                    'QuestionTypeProperties': {
                        'Numeric': {
                            'MinValue': 123,
                            'MaxValue': 123,
                            'Options': [
                                {
                                    'MinValue': 123,
                                    'MaxValue': 123,
                                    'Score': 123,
                                    'AutomaticFail': True|False
                                },
                            ],
                            'Automation': {
                                'PropertyValue': {
                                    'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'
                                }
                            }
                        },
                        'SingleSelect': {
                            'Options': [
                                {
                                    'RefId': 'string',
                                    'Text': 'string',
                                    'Score': 123,
                                    'AutomaticFail': True|False
                                },
                            ],
                            'DisplayAs': 'DROPDOWN'|'RADIO',
                            'Automation': {
                                'Options': [
                                    {
                                        'RuleCategory': {
                                            'Category': 'string',
                                            'Condition': 'PRESENT'|'NOT_PRESENT',
                                            'OptionRefId': 'string'
                                        }
                                    },
                                ],
                                'DefaultOptionRefId': 'string'
                            }
                        }
                    },
                    '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',
        'Tags': {
            'string': 'string'
        }
    }
}

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

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

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

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

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

    • Tags (dict) –

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

      • (string) –

        • (string) –

Exceptions

• Connect.Client.exceptions.InvalidParameterException

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.InternalServiceException