test_sets

Creates, updates, deletes, gets or lists a test_sets resource.

Overview

Name	test_sets
Type	Resource
Id	aws.lexv2_models.test_sets

Fields

The following fields are returned by SELECT queries:

describe_test_set

Name	Datatype	Description
creation_date_time	string (date-time)	The creation date and time for the test set data.
description	string	The description of the test set.
last_updated_date_time	string (date-time)	The date and time for the last update of the test set data.
modality	string	Indicates whether the test set is audio or text data. (Text, Audio)
num_turns	integer	The total number of agent and user turn in the test set.
role_arn	string	The roleARN used for any operation in the test set to access resources in the Amazon Web Services account. (pattern: <code>^arn:aws:iam::[0-9]{12}:role/.*$</code>)
status	string	The status of the test set. (Importing, PendingAnnotation, Deleting, ValidationError, Ready)
storage_location	object	The Amazon S3 storage location for the test set data.
test_set_id	string	The test set Id for the test set response. (pattern: <code>^[0-9a-zA-Z]+$</code>)
test_set_name	string	The test set name of the test set. (pattern: <code>^([0-9a-zA-Z][_-]?){1,100}$</code>)

list_test_sets

Name	Datatype	Description
next_token	string	A token that indicates whether there are more results to return in a response to the ListTestSets operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestSets operation request to get the next page of results.
test_sets	array	The selected test sets in a list of test sets.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_test_set	select	test_set_id, region		Gets metadata information about the test set.
list_test_sets	select	region		The list of the test sets
update_test_set	update	test_set_id, region, testSetName		The action to update the test set.
delete_test_set	delete	test_set_id, region		The action to delete the selected test set.
start_test_execution	exec	test_set_id, region, target, apiMode		The action to start test set execution.
start_test_set_generation	exec	region, testSetName, storageLocation, generationDataSource, roleArn		The action to start the generation of test set.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
test_set_id	string	The test set Id for the test set execution.

SELECT examples

describe_test_set

Gets metadata information about the test set.

SELECT
creation_date_time,
description,
last_updated_date_time,
modality,
num_turns,
role_arn,
status,
storage_location,
test_set_id,
test_set_name
FROM aws.lexv2_models.test_sets
WHERE test_set_id = '{{ test_set_id }}' -- required
AND region = '{{ region }}' -- required
;

list_test_sets

The list of the test sets

SELECT
next_token,
test_sets
FROM aws.lexv2_models.test_sets
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_test_set

The action to update the test set.

UPDATE aws.lexv2_models.test_sets
SET 
testSetName = '{{ testSetName }}',
description = '{{ description }}'
WHERE 
test_set_id = '{{ test_set_id }}' --required
AND region = '{{ region }}' --required
AND testSetName = '{{ testSetName }}' --required
RETURNING
creation_date_time,
description,
last_updated_date_time,
modality,
num_turns,
role_arn,
status,
storage_location,
test_set_id,
test_set_name;

DELETE examples

delete_test_set

The action to delete the selected test set.

DELETE FROM aws.lexv2_models.test_sets
WHERE test_set_id = '{{ test_set_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

start_test_execution

The action to start test set execution.

EXEC aws.lexv2_models.test_sets.start_test_execution 
@test_set_id='{{ test_set_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"target": "{{ target }}", 
"apiMode": "{{ apiMode }}", 
"testExecutionModality": "{{ testExecutionModality }}"
}'
;

start_test_set_generation

The action to start the generation of test set.

EXEC aws.lexv2_models.test_sets.start_test_set_generation 
@region='{{ region }}' --required 
@@json=
'{
"testSetName": "{{ testSetName }}", 
"description": "{{ description }}", 
"storageLocation": "{{ storageLocation }}", 
"generationDataSource": "{{ generationDataSource }}", 
"roleArn": "{{ roleArn }}", 
"testSetTags": "{{ testSetTags }}"
}'
;