docs(client-workspaces): Removing multi-session as it isn't supported…

… for pools
aws · Jul 30, 2024 · 01552b0 · 01552b0
1 parent 65290c8
commit 01552b0
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 11 deletions.
diff --git a/clients/client-workspaces/src/commands/CreateWorkspacesCommand.ts b/clients/client-workspaces/src/commands/CreateWorkspacesCommand.ts
@@ -46,6 +46,13 @@ export interface CreateWorkspacesCommandOutput extends CreateWorkspacesResult, _
  *                   <p>User-decoupled WorkSpaces are only supported by Amazon WorkSpaces
  *                Core.</p>
  *                </li>
+ *                <li>
+ *                   <p>Review your running mode to ensure you are using one that is optimal for your needs and budget.
+ *                   For more information on switching running modes, see
+ *                   <a href="http://aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F">
+ *                      Can I switch between hourly and monthly billing?</a>
+ *                   </p>
+ *                </li>
  *             </ul>
  *          </note>
  * @example

diff --git a/clients/client-workspaces/src/models/models_0.ts b/clients/client-workspaces/src/models/models_0.ts
@@ -1168,8 +1168,7 @@ export interface BundleResourceAssociation {
  */
 export interface Capacity {
   /**
-   * <p>The desired number of user sessions for a multi-session pool.
-   *          This is not allowed for single-session pools.</p>
+   * <p>The desired number of user sessions for the WorkSpaces in the pool.</p>
    * @public
    */
   DesiredUserSessions: number | undefined;
@@ -1181,7 +1180,8 @@ export interface Capacity {
  */
 export interface CapacityStatus {
   /**
-   * <p>The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.</p>
+   * <p>The number of user sessions currently available for streaming from your pool.</p>
+   *          <p>AvailableUserSessions = ActualUserSessions - ActiveUserSessions</p>
    * @public
    */
   AvailableUserSessions: number | undefined;
@@ -1195,13 +1195,15 @@ export interface CapacityStatus {
   DesiredUserSessions: number | undefined;
 
   /**
-   * <p>The total number of session slots that are available for a pool of WorkSpaces.</p>
+   * <p>The total number of user sessions that are available for streaming or are currently
+   *          streaming in your pool.</p>
+   *          <p>ActualUserSessions = AvailableUserSessions + ActiveUserSessions</p>
    * @public
    */
   ActualUserSessions: number | undefined;
 
   /**
-   * <p>The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.</p>
+   * <p>The number of user sessions currently being used for your pool.</p>
    * @public
    */
   ActiveUserSessions: number | undefined;
@@ -2244,6 +2246,9 @@ export interface WorkspaceProperties {
    *             your account team to be allow-listed to use this value. For more information, see
    *             <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p>
    *          </note>
+   *          <p>Review your running mode to ensure you are using one that is optimal for your needs and
+   *          budget. For more information on switching running modes, see <a href="http://aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F"> Can I switch between hourly and monthly billing?</a>
+   *          </p>
    * @public
    */
   RunningMode?: RunningMode;

diff --git a/codegen/sdk-codegen/aws-models/workspaces.json b/codegen/sdk-codegen/aws-models/workspaces.json
@@ -1076,7 +1076,7 @@
         "DesiredUserSessions": {
           "target": "com.amazonaws.workspaces#DesiredUserSessions",
           "traits": {
-            "smithy.api#documentation": "<p>The desired number of user sessions for a multi-session pool. \n         This is not allowed for single-session pools.</p>",
+            "smithy.api#documentation": "<p>The desired number of user sessions for the WorkSpaces in the pool.</p>",
             "smithy.api#required": {}
           }
         }
@@ -1091,7 +1091,7 @@
         "AvailableUserSessions": {
           "target": "com.amazonaws.workspaces#AvailableUserSessions",
           "traits": {
-            "smithy.api#documentation": "<p>The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.</p>",
+            "smithy.api#documentation": "<p>The number of user sessions currently available for streaming from your pool.</p>\n         <p>AvailableUserSessions = ActualUserSessions - ActiveUserSessions</p>",
             "smithy.api#required": {}
           }
         },
@@ -1105,14 +1105,14 @@
         "ActualUserSessions": {
           "target": "com.amazonaws.workspaces#ActualUserSessions",
           "traits": {
-            "smithy.api#documentation": "<p>The total number of session slots that are available for a pool of WorkSpaces.</p>",
+            "smithy.api#documentation": "<p>The total number of user sessions that are available for streaming or are currently \n         streaming in your pool.</p>\n         <p>ActualUserSessions = AvailableUserSessions + ActiveUserSessions</p>",
             "smithy.api#required": {}
           }
         },
         "ActiveUserSessions": {
           "target": "com.amazonaws.workspaces#ActiveUserSessions",
           "traits": {
-            "smithy.api#documentation": "<p>The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.</p>",
+            "smithy.api#documentation": "<p>The number of user sessions currently being used for your pool.</p>",
             "smithy.api#required": {}
           }
         }
@@ -2478,7 +2478,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               <li>\n                  <p>User-decoupled WorkSpaces are only supported by Amazon WorkSpaces\n               Core.</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               <li>\n                  <p>Review your running mode to ensure you are using one that is optimal for your needs and budget.\n                  For more information on switching running modes, see \n                  <a href=\"http://aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F\">\n                     Can I switch between hourly and monthly billing?</a>\n                  </p>\n               </li>\n            </ul>\n         </note>"
       }
     },
     "com.amazonaws.workspaces#CreateWorkspacesPool": {
@@ -10799,7 +10799,7 @@
         "RunningMode": {
           "target": "com.amazonaws.workspaces#RunningMode",
           "traits": {
-            "smithy.api#documentation": "<p>The running mode. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html\">Manage the WorkSpace Running\n         Mode</a>.</p>\n         <note>\n            <p>The <code>MANUAL</code> value is only supported by Amazon WorkSpaces Core. Contact\n            your account team to be allow-listed to use this value. For more information, see\n            <a href=\"http://aws.amazon.com/workspaces/core/\">Amazon WorkSpaces Core</a>.</p>\n         </note>"
+            "smithy.api#documentation": "<p>The running mode. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html\">Manage the WorkSpace Running\n         Mode</a>.</p>\n         <note>\n            <p>The <code>MANUAL</code> value is only supported by Amazon WorkSpaces Core. Contact\n            your account team to be allow-listed to use this value. For more information, see\n            <a href=\"http://aws.amazon.com/workspaces/core/\">Amazon WorkSpaces Core</a>.</p>\n         </note>\n         <p>Review your running mode to ensure you are using one that is optimal for your needs and\n         budget. For more information on switching running modes, see <a href=\"http://aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F\"> Can I switch between hourly and monthly billing?</a>\n         </p>"
           }
         },
         "RunningModeAutoStopTimeoutInMinutes": {