LexModelsV2 / Client / describe_test_set

describe_test_set

LexModelsV2.Client.describe_test_set(**kwargs)

Gets metadata information about the test set.

See also: AWS API Documentation

Request Syntax

response = client.describe_test_set(
    testSetId='string'
)

Parameters:

testSetId (string) –

[REQUIRED]

The test set Id for the test set request.

Return type:

dict

Returns:

Response Syntax

{
    'testSetId': 'string',
    'testSetName': 'string',
    'description': 'string',
    'modality': 'Text'|'Audio',
    'status': 'Importing'|'PendingAnnotation'|'Deleting'|'ValidationError'|'Ready',
    'roleArn': 'string',
    'numTurns': 123,
    'storageLocation': {
        's3BucketName': 'string',
        's3Path': 'string',
        'kmsKeyArn': 'string'
    },
    'creationDateTime': datetime(2015, 1, 1),
    'lastUpdatedDateTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • testSetId (string) –

    The test set Id for the test set response.

  • testSetName (string) –

    The test set name of the test set.

  • description (string) –

    The description of the test set.

  • modality (string) –

    Indicates whether the test set is audio or text data.

  • status (string) –

    The status of the test set.

  • roleArn (string) –

    The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.

  • numTurns (integer) –

    The total number of agent and user turn in the test set.

  • storageLocation (dict) –

    The Amazon S3 storage location for the test set data.

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

  • creationDateTime (datetime) –

    The creation date and time for the test set data.

  • lastUpdatedDateTime (datetime) –

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

Exceptions

• LexModelsV2.Client.exceptions.ThrottlingException

• LexModelsV2.Client.exceptions.ServiceQuotaExceededException

• LexModelsV2.Client.exceptions.ValidationException

• LexModelsV2.Client.exceptions.ResourceNotFoundException

• LexModelsV2.Client.exceptions.InternalServerException