Skip to content

Commit

Permalink
docs(client-workspaces): Added definitions of various WorkSpace states
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Feb 5, 2024
1 parent 0872087 commit 29d33ec
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 1 deletion.
70 changes: 70 additions & 0 deletions clients/client-workspaces/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2265,6 +2265,76 @@ export interface Workspace {
/**
* @public
* <p>The operational state of the WorkSpace.</p>
* <ul>
* <li>
* <p>
* <code>PENDING</code> – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).</p>
* </li>
* <li>
* <p>
* <code>AVAILABLE</code> – The WorkSpace is running and has passed the health checks.</p>
* </li>
* <li>
* <p>
* <code>IMPAIRED</code> – Refer to <code>UNHEALTHY</code> state.</p>
* </li>
* <li>
* <p>
* <code>UNHEALTHY</code> – The WorkSpace is not responding to health checks.</p>
* </li>
* <li>
* <p>
* <code>REBOOTING</code> – The WorkSpace is being rebooted (restarted).</p>
* </li>
* <li>
* <p>
* <code>STARTING</code> – The WorkSpace is starting up and health checks are being run.</p>
* </li>
* <li>
* <p>
* <code>REBUILDING</code> – The WorkSpace is being rebuilt.</p>
* </li>
* <li>
* <p>
* <code>RESTORING</code> – The WorkSpace is being restored.</p>
* </li>
* <li>
* <p>
* <code>MAINTENANCE</code> – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.</p>
* </li>
* <li>
* <p>
* <code>ADMIN_MAINTENANCE</code> – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.</p>
* </li>
* <li>
* <p>
* <code>TERMINATING</code> – The WorkSpace is being deleted.</p>
* </li>
* <li>
* <p>
* <code>TERMINATED</code> – The WorkSpace has been deleted.</p>
* </li>
* <li>
* <p>
* <code>SUSPENDED</code> – The WorkSpace has been suspended for image creation.</p>
* </li>
* <li>
* <p>
* <code>UPDATING</code> – The WorkSpace is undergoing an update.</p>
* </li>
* <li>
* <p>
* <code>STOPPING</code> – The WorkSpace is being stopped.</p>
* </li>
* <li>
* <p>
* <code>STOPPED</code> – The WorkSpace has been stopped.</p>
* </li>
* <li>
* <p>
* <code>ERROR </code> – The WorkSpace is an error state (for example, an error occurred during startup).</p>
* </li>
* </ul>
* <note>
* <p>After a WorkSpace is terminated, the <code>TERMINATED</code> state is returned only
* briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely
Expand Down
2 changes: 1 addition & 1 deletion codegen/sdk-codegen/aws-models/workspaces.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7909,7 +7909,7 @@
"State": {
"target": "com.amazonaws.workspaces#WorkspaceState",
"traits": {
"smithy.api#documentation": "<p>The operational state of the WorkSpace.</p>\n <note>\n <p>After a WorkSpace is terminated, the <code>TERMINATED</code> state is returned only\n briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely\n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using\n <a href=\"https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html\">\n DescribeWorkSpaces</a>. If the WorkSpace ID isn't returned, then the WorkSpace\n has been successfully terminated.</p>\n </note>"
"smithy.api#documentation": "<p>The operational state of the WorkSpace.</p>\n <ul>\n <li>\n <p>\n <code>PENDING</code> – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).</p>\n </li>\n <li>\n <p>\n <code>AVAILABLE</code> – The WorkSpace is running and has passed the health checks.</p>\n </li>\n <li>\n <p>\n <code>IMPAIRED</code> – Refer to <code>UNHEALTHY</code> state.</p>\n </li>\n <li>\n <p>\n <code>UNHEALTHY</code> – The WorkSpace is not responding to health checks.</p>\n </li>\n <li>\n <p>\n <code>REBOOTING</code> – The WorkSpace is being rebooted (restarted).</p>\n </li>\n <li>\n <p>\n <code>STARTING</code> – The WorkSpace is starting up and health checks are being run.</p>\n </li>\n <li>\n <p>\n <code>REBUILDING</code> – The WorkSpace is being rebuilt.</p>\n </li>\n <li>\n <p>\n <code>RESTORING</code> – The WorkSpace is being restored.</p>\n </li>\n <li>\n <p>\n <code>MAINTENANCE</code> – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.</p>\n </li>\n <li>\n <p>\n <code>ADMIN_MAINTENANCE</code> – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.</p>\n </li>\n <li>\n <p>\n <code>TERMINATING</code> – The WorkSpace is being deleted.</p>\n </li>\n <li>\n <p>\n <code>TERMINATED</code> – The WorkSpace has been deleted.</p>\n </li>\n <li>\n <p>\n <code>SUSPENDED</code> – The WorkSpace has been suspended for image creation.</p>\n </li>\n <li>\n <p>\n <code>UPDATING</code> – The WorkSpace is undergoing an update.</p>\n </li>\n <li>\n <p>\n <code>STOPPING</code> – The WorkSpace is being stopped.</p>\n </li>\n <li>\n <p>\n <code>STOPPED</code> – The WorkSpace has been stopped.</p>\n </li>\n <li>\n <p>\n <code>ERROR </code> – The WorkSpace is an error state (for example, an error occurred during startup).</p>\n </li>\n </ul>\n <note>\n <p>After a WorkSpace is terminated, the <code>TERMINATED</code> state is returned only\n briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely\n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using\n <a href=\"https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html\">\n DescribeWorkSpaces</a>. If the WorkSpace ID isn't returned, then the WorkSpace\n has been successfully terminated.</p>\n </note>"
}
},
"BundleId": {
Expand Down

0 comments on commit 29d33ec

Please sign in to comment.