test_set_discrepancy_reports

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

Overview

Name	test_set_discrepancy_reports
Type	Resource
Id	aws.lexv2_models.test_set_discrepancy_reports

Fields

The following fields are returned by SELECT queries:

describe_test_set_discrepancy_report

Name	Datatype	Description
creation_date_time	string (date-time)	The time and date of creation for the test set discrepancy report.
failure_reasons	array	The failure report for the test set discrepancy report generation action.
last_updated_data_time	string (date-time)	The date and time of the last update for the test set discrepancy report.
target	object	Contains information about the resource used for the test set discrepancy report.
test_set_discrepancy_raw_output_url	string	Pre-signed Amazon S3 URL to download the test set discrepancy report.
test_set_discrepancy_report_id	string	The unique identifier of the test set discrepancy report to describe. (pattern: <code>^[0-9a-zA-Z]+$</code>)
test_set_discrepancy_report_status	string	The status for the test set discrepancy report. (InProgress, Completed, Failed)
test_set_discrepancy_top_errors	object	The top 200 error results from the test set discrepancy report.
test_set_id	string	The test set Id for the test set discrepancy report. (pattern: <code>^[0-9a-zA-Z]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_test_set_discrepancy_report	select	test_set_discrepancy_report_id, region		Gets metadata information about the test set discrepancy report.
create_test_set_discrepancy_report	insert	test_set_id, region, target		Create a report that describes the differences between the bot and the 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_discrepancy_report_id	string	The unique identifier of the test set discrepancy report.
test_set_id	string	The test set Id for the test set discrepancy report.

SELECT examples

describe_test_set_discrepancy_report

Gets metadata information about the test set discrepancy report.

SELECT
creation_date_time,
failure_reasons,
last_updated_data_time,
target,
test_set_discrepancy_raw_output_url,
test_set_discrepancy_report_id,
test_set_discrepancy_report_status,
test_set_discrepancy_top_errors,
test_set_id
FROM aws.lexv2_models.test_set_discrepancy_reports
WHERE test_set_discrepancy_report_id = '{{ test_set_discrepancy_report_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_test_set_discrepancy_report

Create a report that describes the differences between the bot and the test set.

INSERT INTO aws.lexv2_models.test_set_discrepancy_reports (
target,
test_set_id,
region
)
SELECT 
'{{ target }}' /* required */,
'{{ test_set_id }}',
'{{ region }}'
RETURNING
creation_date_time,
target,
test_set_discrepancy_report_id,
test_set_id
;

Manifest

# Description fields are for documentation purposes
- name: test_set_discrepancy_reports
props:
  - name: test_set_id
    value: "{{ test_set_id }}"
    description: Required parameter for the test_set_discrepancy_reports resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the test_set_discrepancy_reports resource.
  - name: target
    description: |
      Contains information about the resource used for the test set discrepancy report.
    value:
      botAliasTarget:
        botId: "{{ botId }}"
        botAliasId: "{{ botAliasId }}"
        localeId: "{{ localeId }}"