UpdateBot - Amazon Chime

UpdateBot

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

Request Syntax

POST /accounts/accountId/bots/botId HTTP/1.1 Content-type: application/json { "Disabled": boolean }

URI Request Parameters

The request uses the following URI parameters.

accountId

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

botId

The bot ID.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

Disabled

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

Type: Boolean

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Bot": { "BotEmail": "string", "BotId": "string", "BotType": "string", "CreatedTimestamp": number, "Disabled": boolean, "DisplayName": "string", "SecurityToken": "string", "UpdatedTimestamp": number, "UserId": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Bot

The updated bot details.

Type: Bot object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported Region.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

Examples

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example updates the status of the specified bot to stop it from running.

Sample Request

Update Bot API POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/bots/123abcd4-5ef6-789g-0h12-34j56789012k HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T173150Z Authorization: AUTHPARAMS Content-Length: 18 {"Disabled": true}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 7848d673-79fd-4d76-b723-846eb238aeb6 Content-Type: application/json Content-Length: 373 Date: Wed, 18 Sep 2019 17:31:51 GMT Connection: keep-alive {"Bot":{"BotEmail":"myBot@example.com","BotId":"123abcd4-5ef6-789g-0h12-34j56789012k","BotType":"ChatBot","CreatedTimestamp":"2019-09-18T17:24:39.534Z","Disabled":true,"DisplayName":"myBot (Bot)","SecurityToken":"je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY","UpdatedTimestamp":"2019-09-18T17:31:51.516Z","UserId":"123abcd4-5ef6-789g-0h12-34j56789012k"}}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: