Creates a workplace.
Request SyntaxPOST /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.
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
The request accepts the following data in JSON format.
The description of the workspace.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: .*
Required: No
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
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
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.
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_\-\.:]+
The date and time when the workspace was created.
Type: Timestamp
For information about the errors that are common to all actions, see Common Errors.
Access is denied.
HTTP Status Code: 403
A conflict occurred.
HTTP Status Code: 409
An unexpected error has occurred.
HTTP Status Code: 500
The service quota was exceeded.
HTTP Status Code: 402
The rate exceeds the limit.
HTTP Status Code: 429
Failed
HTTP Status Code: 400
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4