Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . chime ]

update-bot

Description

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-bot
--account-id <value>
--bot-id <value>
[--disabled | --no-disabled]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

The Amazon Chime account ID.

--bot-id (string)

The bot ID.

--disabled | --no-disabled (boolean)

When true, stops the specified bot from running in your account.

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

See 'aws help' for descriptions of global parameters.

Output

Bot -> (structure)

The updated bot details.

BotId -> (string)

The bot ID.

UserId -> (string)

The unique ID for the bot user.

DisplayName -> (string)

The bot display name.

BotType -> (string)

The bot type.

Disabled -> (boolean)

When true, the bot is stopped from running in your account.

CreatedTimestamp -> (timestamp)

The bot creation timestamp, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

The updated bot timestamp, in ISO 8601 format.

BotEmail -> (string)

The bot email address.

SecurityToken -> (string)

The security token used to authenticate Amazon Chime with the outgoing event endpoint.