Connect / Client / submit_contact_evaluation

submit_contact_evaluation#

Connect.Client.submit_contact_evaluation(**kwargs)#

Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ( {}) to the question identifier.

If a contact evaluation is already in submitted state, this operation will trigger a resubmission.

See also: AWS API Documentation

Request Syntax

response = client.submit_contact_evaluation(
    InstanceId='string',
    EvaluationId='string',
    Answers={
        'string': {
            'Value': {
                'StringValue': 'string',
                'NumericValue': 123.0,
                'NotApplicable': True|False
            }
        }
    },
    Notes={
        'string': {
            'Value': 'string'
        }
    }
)
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.

  • EvaluationId (string) –

    [REQUIRED]

    A unique identifier for the contact evaluation.

  • Answers (dict) –

    A map of question identifiers to answer value.

    • (string) –

      • (dict) –

        Information about input answers for a contact evaluation.

        • Value (dict) –

          The value for an answer in a contact evaluation.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: StringValue, NumericValue, NotApplicable.

          • StringValue (string) –

            The string value for an answer in a contact evaluation.

          • NumericValue (float) –

            The numeric value for an answer in a contact evaluation.

          • NotApplicable (boolean) –

            The flag to mark the question as not applicable.

  • Notes (dict) –

    A map of question identifiers to note value.

    • (string) –

      • (dict) –

        Information about notes for a contact evaluation.

        • Value (string) –

          The note for an item (section or question) in a contact evaluation.

          Note

          Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024.

Return type:

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

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.ResourceConflictException