CreateWorkspace
Creates a workplace.
Request Syntax
POST /workspaces/workspaceId HTTP/1.1
Content-type: application/json
{
"description": "string",
"role": "string",
"s3Location": "string",
"tags": {
"string" : "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- workspaceId
-
The ID of the workspace.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+Required: Yes
Request Body
The request accepts the following data in JSON format.
- description
-
The description of the workspace.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
.*Required: No
- role
-
The ARN of the execution role associated with the workspace.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*Required: No
- s3Location
-
The ARN of the Amazon Simple Storage Service bucket where resources associated with the workspace are stored.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
.*(^arn:((aws)|(aws-cn)|(aws-us-gov)):s3:::)([a-zA-Z0-9_-]+$).*Required: No
-
Metadata that you can use to manage the workspace
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)Value Length Constraints: Minimum length of 1. Maximum length of 256.
Value Pattern:
.*Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"creationDateTime": number
}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.
- arn
-
The ARN of the workspace.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+ - creationDateTime
-
The date and time when the workspace was created.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access is denied.
HTTP Status Code: 403
- ConflictException
-
A conflict occurred.
HTTP Status Code: 409
- InternalServerException
-
An unexpected error has occurred.
HTTP Status Code: 500
- ServiceQuotaExceededException
-
The service quota was exceeded.
HTTP Status Code: 402
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 429
- ValidationException
-
Failed
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
