Skip to content

Commit c7a2f3f

Browse files
author
awstools
committed
docs(client-workspaces): Added note for user decoupling
1 parent 9159ba2 commit c7a2f3f

File tree

4 files changed

+80
-5
lines changed

4 files changed

+80
-5
lines changed

‎clients/client-workspaces/src/commands/CreateWorkspacesCommand.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ export interface CreateWorkspacesCommandOutput extends CreateWorkspacesResult, _
4242
* <p>You don't need to specify the <code>PCOIP</code> protocol for Linux bundles
4343
* because <code>WSP</code> is the default protocol for those bundles.</p>
4444
* </li>
45+
* <li>
46+
* <p>User-decoupled WorkSpaces are only supported by Amazon WorkSpaces
47+
* Core.</p>
48+
* </li>
4549
* </ul>
4650
* </note>
4751
* @example

‎clients/client-workspaces/src/commands/RebootWorkspacesCommand.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ export interface RebootWorkspacesCommandOutput extends RebootWorkspacesResult, _
2929
/**
3030
* @public
3131
* <p>Reboots the specified WorkSpaces.</p>
32-
* <p>You cannot reboot a WorkSpace unless its state is <code>AVAILABLE</code> or
33-
* <code>UNHEALTHY</code>.</p>
32+
* <p>You cannot reboot a WorkSpace unless its state is <code>AVAILABLE</code>,
33+
* <code>UNHEALTHY</code>, or <code>REBOOTING</code>. Reboot a WorkSpace in the <code>REBOOTING</code>
34+
* state only if your WorkSpace has been stuck in the <code>REBOOTING</code> state for over 20 minutes.</p>
3435
* <p>This operation is asynchronous and returns before the WorkSpaces have rebooted.</p>
3536
* @example
3637
* Use a bare-bones client and the command you need to make an API call.

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

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

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2089,7 +2089,7 @@
20892089
}
20902090
],
20912091
"traits": {
2092-
"smithy.api#documentation": "<p>Creates one or more WorkSpaces.</p>\n <p>This operation is asynchronous and returns before the WorkSpaces are created.</p>\n <note>\n <ul>\n <li>\n <p>The <code>MANUAL</code> running mode value is only supported by Amazon WorkSpaces\n Core. Contact your account team to be allow-listed to use this value. For more\n information, see <a href=\"http://aws.amazon.com/workspaces/core/\">Amazon WorkSpaces\n Core</a>.</p>\n </li>\n <li>\n <p>You don't need to specify the <code>PCOIP</code> protocol for Linux bundles\n because <code>WSP</code> is the default protocol for those bundles.</p>\n </li>\n </ul>\n </note>"
2092+
"smithy.api#documentation": "<p>Creates one or more WorkSpaces.</p>\n <p>This operation is asynchronous and returns before the WorkSpaces are created.</p>\n <note>\n <ul>\n <li>\n <p>The <code>MANUAL</code> running mode value is only supported by Amazon WorkSpaces\n Core. Contact your account team to be allow-listed to use this value. For more\n information, see <a href=\"http://aws.amazon.com/workspaces/core/\">Amazon WorkSpaces\n Core</a>.</p>\n </li>\n <li>\n <p>You don't need to specify the <code>PCOIP</code> protocol for Linux bundles\n because <code>WSP</code> is the default protocol for those bundles.</p>\n </li>\n <li>\n <p>User-decoupled WorkSpaces are only supported by Amazon WorkSpaces\n Core.</p>\n </li>\n </ul>\n </note>"
20932093
}
20942094
},
20952095
"com.amazonaws.workspaces#CreateWorkspacesRequest": {
@@ -6244,7 +6244,7 @@
62446244
}
62456245
],
62466246
"traits": {
6247-
"smithy.api#documentation": "<p>Reboots the specified WorkSpaces.</p>\n <p>You cannot reboot a WorkSpace unless its state is <code>AVAILABLE</code> or\n <code>UNHEALTHY</code>.</p>\n <p>This operation is asynchronous and returns before the WorkSpaces have rebooted.</p>"
6247+
"smithy.api#documentation": "<p>Reboots the specified WorkSpaces.</p>\n <p>You cannot reboot a WorkSpace unless its state is <code>AVAILABLE</code>,\n <code>UNHEALTHY</code>, or <code>REBOOTING</code>. Reboot a WorkSpace in the <code>REBOOTING</code> \n state only if your WorkSpace has been stuck in the <code>REBOOTING</code> state for over 20 minutes.</p>\n <p>This operation is asynchronous and returns before the WorkSpaces have rebooted.</p>"
62486248
}
62496249
},
62506250
"com.amazonaws.workspaces#RebootWorkspacesRequest": {
@@ -7915,7 +7915,7 @@
79157915
"State": {
79167916
"target": "com.amazonaws.workspaces#WorkspaceState",
79177917
"traits": {
7918-
"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>"
7918+
"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>"
79197919
}
79207920
},
79217921
"BundleId": {

0 commit comments

Comments
 (0)