Connect / Client / list_contact_evaluations

list_contact_evaluations#

Connect.Client.list_contact_evaluations(**kwargs)#

Lists contact evaluations in the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

response = client.list_contact_evaluations(
    InstanceId='string',
    ContactId='string',
    NextToken='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.

  • ContactId (string) –

    [REQUIRED]

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

  • NextToken (string) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'EvaluationSummaryList': [
        {
            'EvaluationId': 'string',
            'EvaluationArn': 'string',
            'EvaluationFormTitle': 'string',
            'EvaluationFormId': 'string',
            'Status': 'DRAFT'|'SUBMITTED',
            'EvaluatorArn': 'string',
            'Score': {
                'Percentage': 123.0,
                'NotApplicable': True|False,
                'AutomaticFail': True|False
            },
            'CreatedTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    '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.

        • Status (string) –

          The status of the contact 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.

        • CreatedTime (datetime) –

          The timestamp for when the evaluation was created.

        • LastModifiedTime (datetime) –

          The timestamp for when the evaluation was last updated.

    • 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