start-test-set-generation¶

Description¶

The action to start the generation of test set.

Synopsis¶

  start-test-set-generation
--test-set-name <value>
[--description <value>]
--storage-location <value>
--generation-data-source <value>
--role-arn <value>
[--test-set-tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--test-set-name (string)

The test set name for the test set generation request.

--description (string)

The test set description for the test set generation request.

--storage-location (structure)

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.

Shorthand Syntax:

s3BucketName=string,s3Path=string,kmsKeyArn=string

JSON Syntax:

{
  "s3BucketName": "string",
  "s3Path": "string",
  "kmsKeyArn": "string"
}

--generation-data-source (structure)

The data source for the test set generation.

conversationLogsDataSource -> (structure)

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 -> (structure)

The filter for the data source of the conversation log.

startTime -> (timestamp)

The start time for the conversation log.

endTime -> (timestamp)

The end time for the conversation log.

inputMode -> (string)

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

Shorthand Syntax:

conversationLogsDataSource={botId=string,botAliasId=string,localeId=string,filter={startTime=timestamp,endTime=timestamp,inputMode=string}}

JSON Syntax:

{
  "conversationLogsDataSource": {
    "botId": "string",
    "botAliasId": "string",
    "localeId": "string",
    "filter": {
      "startTime": timestamp,
      "endTime": timestamp,
      "inputMode": "Speech"|"Text"
    }
  }
}

--role-arn (string)

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

--test-set-tags (map)

A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can’t use the UpdateTestSet operation to update tags. To update tags, use the TagResource operation.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

testSetGenerationId -> (string)

The unique identifier of the test set generation to describe.

creationDateTime -> (timestamp)

The creation date and time for the test set generation.

testSetGenerationStatus -> (string)

The status for the test set generation.

testSetName -> (string)

The test set name used for the test set generation.

description -> (string)

The description used for the test set generation.

storageLocation -> (structure)

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 -> (structure)

The data source for the test set generation.

conversationLogsDataSource -> (structure)

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 -> (structure)

The filter for the data source of the conversation log.

startTime -> (timestamp)

The start time for the conversation log.

endTime -> (timestamp)

The end time for the conversation log.

inputMode -> (string)

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

roleArn -> (string)

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

testSetTags -> (map)

A list of tags that was used for the test set that is being generated.

key -> (string)

value -> (string)

Table of Contents

Feedback

User Guide

start-test-set-generation¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶