docs(client-workspaces): Added note for user decoupling

awstools · awstools · commit c7a2f3f9d7fd · 2024-03-07T19:22:29.000Z
diff --git a/clients/client-workspaces/src/commands/CreateWorkspacesCommand.ts b/clients/client-workspaces/src/commands/CreateWorkspacesCommand.ts
@@ -42,6 +42,10 @@ export interface CreateWorkspacesCommandOutput extends CreateWorkspacesResult, _
  *                   <p>You don't need to specify the <code>PCOIP</code> protocol for Linux bundles
  *                   because <code>WSP</code> is the default protocol for those bundles.</p>
  *                </li>
+ *                <li>
+ *                   <p>User-decoupled WorkSpaces are only supported by Amazon WorkSpaces
+ *                Core.</p>
+ *                </li>
  *             </ul>
  *          </note>
  * @example
diff --git a/clients/client-workspaces/src/commands/RebootWorkspacesCommand.ts b/clients/client-workspaces/src/commands/RebootWorkspacesCommand.ts
@@ -29,8 +29,9 @@ export interface RebootWorkspacesCommandOutput extends RebootWorkspacesResult, _
 /**
  * @public
  * <p>Reboots the specified WorkSpaces.</p>
- *          <p>You cannot reboot a WorkSpace unless its state is <code>AVAILABLE</code> or
- *             <code>UNHEALTHY</code>.</p>
+ *          <p>You cannot reboot a WorkSpace unless its state is <code>AVAILABLE</code>,
+ *          <code>UNHEALTHY</code>, or <code>REBOOTING</code>. Reboot a WorkSpace in the <code>REBOOTING</code>
+ *          state only if your WorkSpace has been stuck in the <code>REBOOTING</code> state for over 20 minutes.</p>
  *          <p>This operation is asynchronous and returns before the WorkSpaces have rebooted.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
diff --git a/clients/client-workspaces/src/models/models_0.ts b/clients/client-workspaces/src/models/models_0.ts
@@ -2272,6 +2272,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
diff --git a/codegen/sdk-codegen/aws-models/workspaces.json b/codegen/sdk-codegen/aws-models/workspaces.json
@@ -2089,7 +2089,7 @@
         }
       ],
       "traits": {
-        "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>"
+        "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>"
       }
     },
     "com.amazonaws.workspaces#CreateWorkspacesRequest": {
@@ -6244,7 +6244,7 @@
         }
       ],
       "traits": {
-        "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>"
+        "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>"
       }
     },
     "com.amazonaws.workspaces#RebootWorkspacesRequest": {
@@ -7915,7 +7915,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": {

Original file line number	Diff line number	Diff line change
`@@ -2089,7 +2089,7 @@`
`2089`	`2089`	`}`
`2090`	`2090`	`],`
`2091`	`2091`	`"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>"
`2093`	`2093`	`}`
`2094`	`2094`	`},`
`2095`	`2095`	`"com.amazonaws.workspaces#CreateWorkspacesRequest": {`
`@@ -6244,7 +6244,7 @@`
`6244`	`6244`	`}`
`6245`	`6245`	`],`
`6246`	`6246`	`"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>"`
`6248`	`6248`	`}`
`6249`	`6249`	`},`
`6250`	`6250`	`"com.amazonaws.workspaces#RebootWorkspacesRequest": {`
`@@ -7915,7 +7915,7 @@`
`7915`	`7915`	`"State": {`
`7916`	`7916`	`"target": "com.amazonaws.workspaces#WorkspaceState",`
`7917`	`7917`	`"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>"
`7919`	`7919`	`}`
`7920`	`7920`	`},`
`7921`	`7921`	`"BundleId": {`