UpdateWorkspace - Amazon IoT TwinMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Updates a workspace.

Request Syntax

PUT /workspaces/workspaceId HTTP/1.1 Content-type: application/json { "description": "string", "role": "string", "s3Location": "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

Request Body

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 S3 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

Response Syntax

HTTP/1.1 200 Content-type: application/json { "updateDateTime": 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 date and time of the current update.

Type: Timestamp


For information about the errors that are common to all actions, see Common Errors.


Access is denied.

HTTP Status Code: 403


An unexpected error has occurred.

HTTP Status Code: 500


The resource wasn't found.

HTTP Status Code: 404


The service quota was exceeded.

HTTP Status Code: 402


The rate exceeds the limit.

HTTP Status Code: 429



HTTP Status Code: 400

See Also

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