Amazon Chime
API Reference (API Version 2018-05-01)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

CreateBot

Creates a bot for an Amazon Chime Enterprise account.

Request Syntax

POST /accounts/accountId/bots HTTP/1.1 Content-type: application/json { "DisplayName": "string", "Domain": "string" }

URI Request Parameters

The request requires the following URI parameters.

accountId

The Amazon Chime account ID.

Pattern: .*\S.*

Request Body

The request accepts the following data in JSON format.

DisplayName

The bot display name.

Type: String

Required: Yes

Domain

The domain of the Amazon Chime Enterprise account.

Type: String

Pattern: .*\S.*

Required: No

Response Syntax

HTTP/1.1 201 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 201 response.

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

Bot

The 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

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also

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