CreateRoom
Creates a room with the specified details.
Request Syntax
{
"ClientRequestToken": "string",
"Description": "string",
"ProfileArn": "string",
"ProviderCalendarId": "string",
"RoomName": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientRequestToken
-
A unique, user-specified identifier for this request that ensures idempotency.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 150.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]*Required: No
- Description
-
The description for the room.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*Required: No
- ProfileArn
-
The profile ARN for the room. This is required.
Type: String
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}Required: No
- ProviderCalendarId
-
The calendar ARN for the room.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 100.
Required: No
- RoomName
-
The name for the room.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*Required: Yes
- Tags
-
The tags for the room.
Type: Array of Tag objects
Required: No
Response Syntax
{
"RoomArn": "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.
- RoomArn
-
The ARN of the newly created room in the response.
Type: String
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
Errors
For information about the errors that are common to all actions, see Common Errors.
- AlreadyExistsException
-
The resource being created already exists.
HTTP Status Code: 400
- LimitExceededException
-
You are performing an action that would put you beyond your account's limits.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
