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 ]

batch-create-custom-vocabulary-item

Description

Batch create custom vocabulary item for the specified locale in the specified bot.

See also: AWS API Documentation

Synopsis

  batch-create-custom-vocabulary-item
--bot-id <value>
--bot-version <value>
--locale-id <value>
--custom-vocabulary-item-list <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

--bot-id (string)

The unique identifier of the bot to batch create the custom vocabulary item for.

--bot-version (string)

The bot version of the bot to batch create the custom vocabulary item for.

--locale-id (string)

The unique locale identifier of the bot to batch create the custom vocabulary item for.

--custom-vocabulary-item-list (list)

The custom vocabulary item list of the bot to batch create the custom vocabulary item for.

(structure)

The new custom vocabulary item from the custom vocabulary list.

phrase -> (string)

The unique phrase for the new custom vocabulary item from the custom vocabulary list.

weight -> (integer)

The weight assigned to the new custom vocabulary item from the custom vocabulary list.

displayAs -> (string)

The display as value assigned to the new custom vocabulary item from the custom vocabulary list.

Shorthand Syntax:

phrase=string,weight=integer,displayAs=string ...

JSON Syntax:

[
  {
    "phrase": "string",
    "weight": integer,
    "displayAs": "string"
  }
  ...
]

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

botId -> (string)

The unique identifier of the bot to batch create response for the custom vocabulary item.

botVersion -> (string)

The bot version of the bot to batch create the custom vocabulary item response for.

localeId -> (string)

The unique locale identifier of the bot to batch create the custom vocabulary item response for.

errors -> (list)

The errors of the action to batch create the custom vocabulary item response for a bot.

(structure)

The unique failed custom vocabulary item from the custom vocabulary list.

itemId -> (string)

The unique item identifer for the failed custom vocabulary item from the custom vocabulary list.

errorMessage -> (string)

The error message for the failed custom vocabulary item from the custom vocabulary list.

errorCode -> (string)

The unique error code for the failed custom vocabulary item from the custom vocabulary list.

resources -> (list)

The resources of the action to batch create the custom vocabulary item response for a bot.

(structure)

The unique custom vocabulary item from the custom vocabulary list.

itemId -> (string)

The unique item identifer for the custom vocabulary item from the custom vocabulary list.

phrase -> (string)

The unique phrase for the custom vocabulary item from the custom vocabulary list.

weight -> (integer)

The weight assigned for the custom vocabulary item from the custom vocabulary list.

displayAs -> (string)

The display as value for the custom vocabulary item from the custom vocabulary list.