Skip to content

Commit 29d33ec

Browse files
author
awstools
committed
docs(client-workspaces): Added definitions of various WorkSpace states
1 parent 0872087 commit 29d33ec

File tree

2 files changed

+71
-1
lines changed

2 files changed

+71
-1
lines changed

‎clients/client-workspaces/src/models/models_0.ts

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2265,6 +2265,76 @@ export interface Workspace {
22652265
/**
22662266
* @public
22672267
* <p>The operational state of the WorkSpace.</p>
2268+
* <ul>
2269+
* <li>
2270+
* <p>
2271+
* <code>PENDING</code> – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).</p>
2272+
* </li>
2273+
* <li>
2274+
* <p>
2275+
* <code>AVAILABLE</code> – The WorkSpace is running and has passed the health checks.</p>
2276+
* </li>
2277+
* <li>
2278+
* <p>
2279+
* <code>IMPAIRED</code> – Refer to <code>UNHEALTHY</code> state.</p>
2280+
* </li>
2281+
* <li>
2282+
* <p>
2283+
* <code>UNHEALTHY</code> – The WorkSpace is not responding to health checks.</p>
2284+
* </li>
2285+
* <li>
2286+
* <p>
2287+
* <code>REBOOTING</code> – The WorkSpace is being rebooted (restarted).</p>
2288+
* </li>
2289+
* <li>
2290+
* <p>
2291+
* <code>STARTING</code> – The WorkSpace is starting up and health checks are being run.</p>
2292+
* </li>
2293+
* <li>
2294+
* <p>
2295+
* <code>REBUILDING</code> – The WorkSpace is being rebuilt.</p>
2296+
* </li>
2297+
* <li>
2298+
* <p>
2299+
* <code>RESTORING</code> – The WorkSpace is being restored.</p>
2300+
* </li>
2301+
* <li>
2302+
* <p>
2303+
* <code>MAINTENANCE</code> – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.</p>
2304+
* </li>
2305+
* <li>
2306+
* <p>
2307+
* <code>ADMIN_MAINTENANCE</code> – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.</p>
2308+
* </li>
2309+
* <li>
2310+
* <p>
2311+
* <code>TERMINATING</code> – The WorkSpace is being deleted.</p>
2312+
* </li>
2313+
* <li>
2314+
* <p>
2315+
* <code>TERMINATED</code> – The WorkSpace has been deleted.</p>
2316+
* </li>
2317+
* <li>
2318+
* <p>
2319+
* <code>SUSPENDED</code> – The WorkSpace has been suspended for image creation.</p>
2320+
* </li>
2321+
* <li>
2322+
* <p>
2323+
* <code>UPDATING</code> – The WorkSpace is undergoing an update.</p>
2324+
* </li>
2325+
* <li>
2326+
* <p>
2327+
* <code>STOPPING</code> – The WorkSpace is being stopped.</p>
2328+
* </li>
2329+
* <li>
2330+
* <p>
2331+
* <code>STOPPED</code> – The WorkSpace has been stopped.</p>
2332+
* </li>
2333+
* <li>
2334+
* <p>
2335+
* <code>ERROR </code> – The WorkSpace is an error state (for example, an error occurred during startup).</p>
2336+
* </li>
2337+
* </ul>
22682338
* <note>
22692339
* <p>After a WorkSpace is terminated, the <code>TERMINATED</code> state is returned only
22702340
* briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely

‎codegen/sdk-codegen/aws-models/workspaces.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7909,7 +7909,7 @@
79097909
"State": {
79107910
"target": "com.amazonaws.workspaces#WorkspaceState",
79117911
"traits": {
7912-
"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>"
7912+
"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>"
79137913
}
79147914
},
79157915
"BundleId": {

0 commit comments

Comments
 (0)