Connect / Paginator / ListEvaluationFormAIVersions

ListEvaluationFormAIVersions

class Connect.Paginator.ListEvaluationFormAIVersions
paginator = client.get_paginator('list_evaluation_form_ai_versions')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    ContactInteractionType='AGENT'|'AUTOMATED'|'CUSTOMER',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • ContactInteractionType (string) –

    [REQUIRED]

    The contact interaction type 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

{
    'AIVersionSummaries': [
        {
            'AIVersionName': 'string',
            'AIVersionLifecycle': {
                'Status': 'LATEST'|'PREVIEW'|'ACTIVE'|'DEPRECATED',
                'StartOfLifeTime': datetime(2015, 1, 1),
                'EndOfLifeTime': datetime(2015, 1, 1)
            }
        },
    ],

}

Response Structure

  • (dict) –

    • AIVersionSummaries (list) –

      The list of AI version summaries.

      • (dict) –

        Contains the name and lifecycle information for an AI version that you can use when creating or updating an evaluation form.

        • AIVersionName (string) –

          The name of the AI version.

        • AIVersionLifecycle (dict) –

          The lifecycle information for this AI version, including its status and availability dates.

          • Status (string) –

            The status of the AI version. Valid values:

            • Latest - The most recent AI version.

            • Preview - An AI version available for preview.

            • Active - An AI version that is currently available.

            • Deprecated - An AI version that is no longer recommended for use.

            • Removed - An AI version that is no longer available.

          • StartOfLifeTime (datetime) –

            The timestamp for when this AI version became available.

          • EndOfLifeTime (datetime) –

            The timestamp when this AI version reaches or reached end of life.