Connect / Client / list_evaluation_form_ai_versions

list_evaluation_form_ai_versions

Connect.Client.list_evaluation_form_ai_versions(**kwargs)

Lists the available AI versions for evaluation forms in the specified Connect Customer instance.

See also: AWS API Documentation

Request Syntax

response = client.list_evaluation_form_ai_versions(
    InstanceId='string',
    ContactInteractionType='AGENT'|'AUTOMATED'|'CUSTOMER',
    MaxResults=123,
    NextToken='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.

  • MaxResults (integer) – The maximum number of results to return per page.

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

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)
            }
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException