LexModelsV2 / Client / describe_test_set_generation

describe_test_set_generation#

LexModelsV2.Client.describe_test_set_generation(**kwargs)#

Gets metadata information about the test set generation.

See also: AWS API Documentation

Request Syntax

response = client.describe_test_set_generation(
    testSetGenerationId='string'
)
Parameters:

testSetGenerationId (string) –

[REQUIRED]

The unique identifier of the test set generation.

Return type:

dict

Returns:

Response Syntax

{
    'testSetGenerationId': 'string',
    'testSetGenerationStatus': 'Generating'|'Ready'|'Failed'|'Pending',
    'failureReasons': [
        'string',
    ],
    'testSetId': 'string',
    'testSetName': 'string',
    'description': 'string',
    'storageLocation': {
        's3BucketName': 'string',
        's3Path': 'string',
        'kmsKeyArn': 'string'
    },
    'generationDataSource': {
        'conversationLogsDataSource': {
            'botId': 'string',
            'botAliasId': 'string',
            'localeId': 'string',
            'filter': {
                'startTime': datetime(2015, 1, 1),
                'endTime': datetime(2015, 1, 1),
                'inputMode': 'Speech'|'Text'
            }
        }
    },
    'roleArn': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'lastUpdatedDateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • testSetGenerationId (string) –

      The unique identifier of the test set generation.

    • testSetGenerationStatus (string) –

      The status for the test set generation.

    • failureReasons (list) –

      The reasons the test set generation failed.

      • (string) –

    • testSetId (string) –

      The unique identifier for the test set created for the generated test set.

    • testSetName (string) –

      The test set name for the generated test set.

    • description (string) –

      The test set description for the test set generation.

    • storageLocation (dict) –

      The Amazon S3 storage location for the test set generation.

      • s3BucketName (string) –

        The name of the Amazon S3 bucket in which the test set is stored.

      • s3Path (string) –

        The path inside the Amazon S3 bucket where the test set is stored.

      • kmsKeyArn (string) –

        The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.

    • generationDataSource (dict) –

      The data source of the test set used for the test set generation.

      • conversationLogsDataSource (dict) –

        Contains information about the bot from which the conversation logs are sourced.

        • botId (string) –

          The bot Id from the conversation logs.

        • botAliasId (string) –

          The bot alias Id from the conversation logs.

        • localeId (string) –

          The locale Id of the conversation log.

        • filter (dict) –

          The filter for the data source of the conversation log.

          • startTime (datetime) –

            The start time for the conversation log.

          • endTime (datetime) –

            The end time for the conversation log.

          • inputMode (string) –

            The selection to filter by input mode for the conversation logs.

    • roleArn (string) –

      The roleARN of the test set used for the test set generation.

    • creationDateTime (datetime) –

      The creation date and time for the test set generation.

    • lastUpdatedDateTime (datetime) –

      The date and time of the last update for the test set generation.

Exceptions

  • LexModelsV2.Client.exceptions.ThrottlingException

  • LexModelsV2.Client.exceptions.ServiceQuotaExceededException

  • LexModelsV2.Client.exceptions.ValidationException

  • LexModelsV2.Client.exceptions.ResourceNotFoundException

  • LexModelsV2.Client.exceptions.InternalServerException