LexModelsV2 / Client / list_test_executions

list_test_executions#

LexModelsV2.Client.list_test_executions(**kwargs)#

The list of test set executions.

See also: AWS API Documentation

Request Syntax

response = client.list_test_executions(
    sortBy={
        'attribute': 'TestSetName'|'CreationDateTime',
        'order': 'Ascending'|'Descending'
    },
    maxResults=123,
    nextToken='string'
)
Parameters:

  • sortBy (dict) –

    The sort order of the test set executions.

    • attribute (string) – [REQUIRED]

      Specifies whether to sort the test set executions by the date and time at which the test sets were created.

    • order (string) – [REQUIRED]

      Specifies whether to sort in ascending or descending order.

  • maxResults (integer) – The maximum number of test executions to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.

  • nextToken (string) – If the response from the ListTestExecutions operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'testExecutions': [
        {
            'testExecutionId': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'testExecutionStatus': 'Pending'|'Waiting'|'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
            'testSetId': 'string',
            'testSetName': 'string',
            'target': {
                'botAliasTarget': {
                    'botId': 'string',
                    'botAliasId': 'string',
                    'localeId': 'string'
                }
            },
            'apiMode': 'Streaming'|'NonStreaming',
            'testExecutionModality': 'Text'|'Audio'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • testExecutions (list) –

      The list of test executions.

      • (dict) –

        Summarizes metadata about the test execution.

        • testExecutionId (string) –

          The unique identifier of the test execution.

        • creationDateTime (datetime) –

          The date and time at which the test execution was created.

        • lastUpdatedDateTime (datetime) –

          The date and time at which the test execution was last updated.

        • testExecutionStatus (string) –

          The current status of the test execution.

        • testSetId (string) –

          The unique identifier of the test set used in the test execution.

        • testSetName (string) –

          The name of the test set used in the test execution.

        • target (dict) –

          Contains information about the bot used for the test execution..

          • botAliasTarget (dict) –

            Contains information about the bot alias used for the test execution.

            • botId (string) –

              The bot Id of the bot alias used in the test set execution.

            • botAliasId (string) –

              The bot alias Id of the bot alias used in the test set execution.

            • localeId (string) –

              The locale Id of the bot alias used in the test set execution.

        • apiMode (string) –

          Specifies whether the API mode for the test execution is streaming or non-streaming.

        • testExecutionModality (string) –

          Specifies whether the data used for the test execution is written or spoken.

    • nextToken (string) –

      A token that indicates whether there are more results to return in a response to the ListTestExecutions operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestExecutions operation request to get the next page of results.

Exceptions