AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lexv2-models ]

describe-test-set-generation

Description

Gets metadata information about the test set generation.

See also: AWS API Documentation

Synopsis

  describe-test-set-generation
--test-set-generation-id <value>
[--cli-input-json <value>]
[--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>]

Options

--test-set-generation-id (string)

The unique identifier of the test set generation.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

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

Output

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 -> (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 of the test set used 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 of the test set used for the test set generation.

creationDateTime -> (timestamp)

The creation date and time for the test set generation.

lastUpdatedDateTime -> (timestamp)

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