Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateRoom

Creates a chat room for the specified Amazon Chime Enterprise account.

Request Syntax


POST /accounts/accountId/rooms HTTP/1.1
Content-type: application/json

{
   "ClientRequestToken": "string",
   "Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accountId

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

ClientRequestToken

The idempotency token for the request.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: No

Name

The room name.

Type: String

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "Room": { 
      "AccountId": "string",
      "CreatedBy": "string",
      "CreatedTimestamp": "string",
      "Name": "string",
      "RoomId": "string",
      "UpdatedTimestamp": "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.

Room

The room details.

Type: Room 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.

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

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