LexModelsV2 / Client / describe_test_execution

describe_test_execution

LexModelsV2.Client.describe_test_execution(**kwargs)

Gets metadata information about the test execution.

See also: AWS API Documentation

Request Syntax

response = client.describe_test_execution(
    testExecutionId='string'
)

Parameters:

testExecutionId (string) –

[REQUIRED]

The execution Id of the test set execution.

Return type:

dict

Returns:

Response Syntax

{
    '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',
    'failureReasons': [
        'string',
    ]
}

Response Structure

• (dict) –

  • testExecutionId (string) –

    The execution Id for the test set execution.

  • creationDateTime (datetime) –

    The execution creation date and time for the test set execution.

  • lastUpdatedDateTime (datetime) –

    The date and time of the last update for the execution.

  • testExecutionStatus (string) –

    The test execution status for the test execution.

  • testSetId (string) –

    The test set Id for the test set execution.

  • testSetName (string) –

    The test set name of the test set execution.

  • target (dict) –

    The target bot for the test set execution details.

    • 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) –

    Indicates whether we use streaming or non-streaming APIs are used for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API is used.

  • testExecutionModality (string) –

    Indicates whether test set is audio or text.

  • failureReasons (list) –

    Reasons for the failure of the test set execution.

    • (string) –

Exceptions

• LexModelsV2.Client.exceptions.ThrottlingException

• LexModelsV2.Client.exceptions.ServiceQuotaExceededException

• LexModelsV2.Client.exceptions.ValidationException

• LexModelsV2.Client.exceptions.ResourceNotFoundException

• LexModelsV2.Client.exceptions.InternalServerException