Connect / Paginator / ListContactEvaluations

ListContactEvaluations

class Connect.Paginator.ListContactEvaluations

paginator = client.get_paginator('list_contact_evaluations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_contact_evaluations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    ContactId='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': '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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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.