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 ]

create-bot

Description

Creates an Amazon Lex conversational bot.

See also: AWS API Documentation

Synopsis

  create-bot
--bot-name <value>
[--description <value>]
--role-arn <value>
--data-privacy <value>
--idle-session-ttl-in-seconds <value>
[--bot-tags <value>]
[--test-bot-alias-tags <value>]
[--bot-type <value>]
[--bot-members <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-name (string)

The name of the bot. The bot name must be unique in the account that creates the bot.

--description (string)

A description of the bot. It appears in lists to help you identify a particular bot.

--role-arn (string)

The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

--data-privacy (structure)

Provides information on additional privacy protections Amazon Lex should use with the bot's data.

childDirected -> (boolean)

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .

Shorthand Syntax:

childDirected=boolean

JSON Syntax:

{
  "childDirected": true|false
}

--idle-session-ttl-in-seconds (integer)

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

--bot-tags (map)

A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot 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"
  ...}

--test-bot-alias-tags (map)

A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--bot-type (string)

The type of a bot to create.

Possible values:

  • Bot
  • BotNetwork

--bot-members (list)

The list of bot members in a network to be created.

(structure)

A bot that is a member of a network of bots.

botMemberId -> (string)

The unique ID of a bot that is a member of this network of bots.

botMemberName -> (string)

The unique name of a bot that is a member of this network of bots.

botMemberAliasId -> (string)

The alias ID of a bot that is a member of this network of bots.

botMemberAliasName -> (string)

The alias name of a bot that is a member of this network of bots.

botMemberVersion -> (string)

The version of a bot that is a member of this network of bots.

Shorthand Syntax:

botMemberId=string,botMemberName=string,botMemberAliasId=string,botMemberAliasName=string,botMemberVersion=string ...

JSON Syntax:

[
  {
    "botMemberId": "string",
    "botMemberName": "string",
    "botMemberAliasId": "string",
    "botMemberAliasName": "string",
    "botMemberVersion": "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)

A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.

botName -> (string)

The name specified for the bot.

description -> (string)

The description specified for the bot.

roleArn -> (string)

The IAM role specified for the bot.

dataPrivacy -> (structure)

The data privacy settings specified for the bot.

childDirected -> (boolean)

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .

idleSessionTTLInSeconds -> (integer)

The session idle time specified for the bot.

botStatus -> (string)

Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the DRAFT version of the bot.

creationDateTime -> (timestamp)

A timestamp indicating the date and time that the bot was created.

botTags -> (map)

A list of tags associated with the bot.

key -> (string)

value -> (string)

testBotAliasTags -> (map)

A list of tags associated with the test alias for the bot.

key -> (string)

value -> (string)

botType -> (string)

The type of a bot that was created.

botMembers -> (list)

The list of bots in a network that was created.

(structure)

A bot that is a member of a network of bots.

botMemberId -> (string)

The unique ID of a bot that is a member of this network of bots.

botMemberName -> (string)

The unique name of a bot that is a member of this network of bots.

botMemberAliasId -> (string)

The alias ID of a bot that is a member of this network of bots.

botMemberAliasName -> (string)

The alias name of a bot that is a member of this network of bots.

botMemberVersion -> (string)

The version of a bot that is a member of this network of bots.