GetWorkspace - AWS IoT TwinMaker

GetWorkspace

Retrieves information about a workspace.

Request Syntax

GET /workspaces/workspaceId HTTP/1.1

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 2048.

Pattern: [a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+$|^arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "arn": "string", "creationDateTime": number, "description": "string", "linkedServices": [ "string" ], "role": "string", "s3Location": "string", "updateDateTime": number, "workspaceId": "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.

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

description

The description of the workspace.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

linkedServices

A list of services that are linked to the workspace.

Type: Array of strings

Pattern: [a-zA-Z_0-9]+

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/.*

s3Location

The ARN of the Amazon 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_-]+$).*

updateDateTime

The date and time when the workspace was last updated.

Type: Timestamp

workspaceId

The ID of the workspace.

Type: String

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]+

Errors

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

InternalServerException

An unexpected error has occurred.

HTTP Status Code: 500

ResourceNotFoundException

The resource wasn't found.

HTTP Status Code: 404

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: