Connect / Paginator / ListEvaluationFormVersions

ListEvaluationFormVersions#

class Connect.Paginator.ListEvaluationFormVersions#

paginator = client.get_paginator('list_evaluation_form_versions')

paginate(**kwargs)#

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

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    EvaluationFormId='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.
EvaluationFormId (string) –
[REQUIRED]

The unique identifier for the evaluation form.
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

{
    'EvaluationFormVersionSummaryList': [
        {
            'EvaluationFormArn': 'string',
            'EvaluationFormId': 'string',
            'EvaluationFormVersion': 123,
            'Locked': True|False,
            'Status': 'DRAFT'|'ACTIVE',
            'CreatedTime': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedBy': 'string'
        },
    ],

}

Response Structure

(dict) –
- EvaluationFormVersionSummaryList (list) –
  
  Provides details about a list of evaluation forms belonging to an instance.
  - (dict) –
    
    Summary information about an evaluation form.
    - EvaluationFormArn (string) –
      
      The Amazon Resource Name (ARN) for the evaluation form resource.
    - 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.
    - Status (string) –
      
      The 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.