View a markdown version of this page

WorkspaceSummary - Amazon IoT SiteWise
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).

WorkspaceSummary

Contains summary information about a workspace, including its name, ARN, status, and creation and update timestamps.

Contents

arn

The ARN of the workspace.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

Required: Yes

createdAt

The date the workspace was created, in Unix epoch time.

Type: Timestamp

Required: Yes

name

The name of the workspace.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

status

The status of the workspace.

Type: WorkspaceStatus object

Required: Yes

updatedAt

The date the workspace was last updated, in Unix epoch time.

Type: Timestamp

Required: Yes

See Also

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