Connect / Paginator / ListEvaluationForms

ListEvaluationForms#

class Connect.Paginator.ListEvaluationForms#
paginator = client.get_paginator('list_evaluation_forms')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

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

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'EvaluationFormSummaryList': [
        {
            'EvaluationFormId': 'string',
            'EvaluationFormArn': 'string',
            'Title': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedBy': 'string',
            'LastActivatedTime': datetime(2015, 1, 1),
            'LastActivatedBy': 'string',
            'LatestVersion': 123,
            'ActiveVersion': 123
        },
    ],

}

Response Structure

  • (dict) –

    • EvaluationFormSummaryList (list) –

      Provides details about a list of evaluation forms belonging to an instance.

      • (dict) –

        Summary information about an evaluation form.

        • EvaluationFormId (string) –

          The unique identifier for the evaluation form.

        • EvaluationFormArn (string) –

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

        • Title (string) –

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

        • LastActivatedTime (datetime) –

          The timestamp for when the evaluation form was last activated.

        • LastActivatedBy (string) –

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

        • LatestVersion (integer) –

          The version number of the latest evaluation form version.

        • ActiveVersion (integer) –

          The version of the active evaluation form version.