[ aws . chime-sdk-identity ]

create-app-instance-bot

Description

Creates a bot under an Amazon Chime AppInstance . The request consists of a unique Configuration and Name for that bot.

See also: AWS API Documentation

Synopsis

  create-app-instance-bot
--app-instance-arn <value>
[--name <value>]
[--metadata <value>]
[--client-request-token <value>]
[--tags <value>]
--configuration <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

--app-instance-arn (string)

The ARN of the AppInstance request.

--name (string)

The user’s name.

--metadata (string)

The request metadata. Limited to a 1KB string in UTF-8.

--client-request-token (string)

The unique ID for the client making the request. Use different tokens for different AppInstanceBots .

--tags (list)

The tags assigned to the AppInstanceBot .

(structure)

A tag object containing a key-value pair.

Key -> (string)

The key in a tag.

Value -> (string)

The value in a tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--configuration (structure)

Configuration information about the Amazon Lex V2 V2 bot.

Lex -> (structure)

The configuration for an Amazon Lex V2 bot.

RespondsTo -> (string)

Warning

Deprecated . Use InvokedBy instead.

Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.

InvokedBy -> (structure)

Specifies the type of message that triggers a bot.

StandardMessages -> (string)

Sets standard messages as the bot trigger. For standard messages:

  • ALL : The bot processes all standard messages.
  • AUTO : The bot responds to ALL messages when the channel has one other non-hidden member, and responds to MENTIONS when the channel has more than one other non-hidden member.
  • MENTIONS : The bot processes all standard messages that have a message attribute with CHIME.mentions and a value of the bot ARN.
  • NONE : The bot processes no standard messages.

TargetedMessages -> (string)

Sets targeted messages as the bot trigger. For targeted messages:

  • ALL : The bot processes all TargetedMessages sent to it. The bot then responds with a targeted message back to the sender.
  • NONE : The bot processes no targeted messages.

LexBotAliasArn -> (string)

The ARN of the Amazon Lex V2 bot’s alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS

LocaleId -> (string)

Identifies the Amazon Lex V2 bot’s language and locale. The string must match one of the supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages in the Amazon Lex V2 Developer Guide .

WelcomeIntent -> (string)

The name of the welcome intent configured in the Amazon Lex V2 bot.

Shorthand Syntax:

Lex={RespondsTo=string,InvokedBy={StandardMessages=string,TargetedMessages=string},LexBotAliasArn=string,LocaleId=string,WelcomeIntent=string}

JSON Syntax:

{
  "Lex": {
    "RespondsTo": "STANDARD_MESSAGES",
    "InvokedBy": {
      "StandardMessages": "AUTO"|"ALL"|"MENTIONS"|"NONE",
      "TargetedMessages": "ALL"|"NONE"
    },
    "LexBotAliasArn": "string",
    "LocaleId": "string",
    "WelcomeIntent": "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.

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

AppInstanceBotArn -> (string)

The ARN of the AppinstanceBot .