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 ]

start-test-execution

Description

The action to start test set execution.

See also: AWS API Documentation

Synopsis

  start-test-execution
--test-set-id <value>
--target <value>
--api-mode <value>
[--test-execution-modality <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-id (string)

The test set Id for the test set execution.

--target (structure)

The target bot for the test set execution.

botAliasTarget -> (structure)

Contains information about the bot alias used for the test execution.

botId -> (string)

The bot Id of the bot alias used in the test set execution.

botAliasId -> (string)

The bot alias Id of the bot alias used in the test set execution.

localeId -> (string)

The locale Id of the bot alias used in the test set execution.

Shorthand Syntax:

botAliasTarget={botId=string,botAliasId=string,localeId=string}

JSON Syntax:

{
  "botAliasTarget": {
    "botId": "string",
    "botAliasId": "string",
    "localeId": "string"
  }
}

--api-mode (string)

Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Runtime API is used. Whereas, for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.

Possible values:

  • Streaming
  • NonStreaming

--test-execution-modality (string)

Indicates whether audio or text is used.

Possible values:

  • Text
  • Audio

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

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

testExecutionId -> (string)

The unique identifier of the test set execution.

creationDateTime -> (timestamp)

The creation date and time for the test set execution.

testSetId -> (string)

The test set Id for the test set execution.

target -> (structure)

The target bot for the test set execution.

botAliasTarget -> (structure)

Contains information about the bot alias used for the test execution.

botId -> (string)

The bot Id of the bot alias used in the test set execution.

botAliasId -> (string)

The bot alias Id of the bot alias used in the test set execution.

localeId -> (string)

The locale Id of the bot alias used in the test set execution.

apiMode -> (string)

Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.

testExecutionModality -> (string)

Indicates whether audio or text is used.