Skip to content

Commit 01552b0

Browse files
author
awstools
committed
docs(client-workspaces): Removing multi-session as it isn't supported for pools
1 parent 65290c8 commit 01552b0

File tree

3 files changed

+23
-11
lines changed

3 files changed

+23
-11
lines changed

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

+7
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,13 @@ export interface CreateWorkspacesCommandOutput extends CreateWorkspacesResult, _
4646
* <p>User-decoupled WorkSpaces are only supported by Amazon WorkSpaces
4747
* Core.</p>
4848
* </li>
49+
* <li>
50+
* <p>Review your running mode to ensure you are using one that is optimal for your needs and budget.
51+
* For more information on switching running modes, see
52+
* <a href="http://aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F">
53+
* Can I switch between hourly and monthly billing?</a>
54+
* </p>
55+
* </li>
4956
* </ul>
5057
* </note>
5158
* @example

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

+10-5
Original file line numberDiff line numberDiff line change
@@ -1168,8 +1168,7 @@ export interface BundleResourceAssociation {
11681168
*/
11691169
export interface Capacity {
11701170
/**
1171-
* <p>The desired number of user sessions for a multi-session pool.
1172-
* This is not allowed for single-session pools.</p>
1171+
* <p>The desired number of user sessions for the WorkSpaces in the pool.</p>
11731172
* @public
11741173
*/
11751174
DesiredUserSessions: number | undefined;
@@ -1181,7 +1180,8 @@ export interface Capacity {
11811180
*/
11821181
export interface CapacityStatus {
11831182
/**
1184-
* <p>The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.</p>
1183+
* <p>The number of user sessions currently available for streaming from your pool.</p>
1184+
* <p>AvailableUserSessions = ActualUserSessions - ActiveUserSessions</p>
11851185
* @public
11861186
*/
11871187
AvailableUserSessions: number | undefined;
@@ -1195,13 +1195,15 @@ export interface CapacityStatus {
11951195
DesiredUserSessions: number | undefined;
11961196

11971197
/**
1198-
* <p>The total number of session slots that are available for a pool of WorkSpaces.</p>
1198+
* <p>The total number of user sessions that are available for streaming or are currently
1199+
* streaming in your pool.</p>
1200+
* <p>ActualUserSessions = AvailableUserSessions + ActiveUserSessions</p>
11991201
* @public
12001202
*/
12011203
ActualUserSessions: number | undefined;
12021204

12031205
/**
1204-
* <p>The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.</p>
1206+
* <p>The number of user sessions currently being used for your pool.</p>
12051207
* @public
12061208
*/
12071209
ActiveUserSessions: number | undefined;
@@ -2244,6 +2246,9 @@ export interface WorkspaceProperties {
22442246
* your account team to be allow-listed to use this value. For more information, see
22452247
* <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p>
22462248
* </note>
2249+
* <p>Review your running mode to ensure you are using one that is optimal for your needs and
2250+
* 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>
2251+
* </p>
22472252
* @public
22482253
*/
22492254
RunningMode?: RunningMode;

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

+6-6
Original file line numberDiff line numberDiff line change
@@ -1076,7 +1076,7 @@
10761076
"DesiredUserSessions": {
10771077
"target": "com.amazonaws.workspaces#DesiredUserSessions",
10781078
"traits": {
1079-
"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>",
1079+
"smithy.api#documentation": "<p>The desired number of user sessions for the WorkSpaces in the pool.</p>",
10801080
"smithy.api#required": {}
10811081
}
10821082
}
@@ -1091,7 +1091,7 @@
10911091
"AvailableUserSessions": {
10921092
"target": "com.amazonaws.workspaces#AvailableUserSessions",
10931093
"traits": {
1094-
"smithy.api#documentation": "<p>The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.</p>",
1094+
"smithy.api#documentation": "<p>The number of user sessions currently available for streaming from your pool.</p>\n <p>AvailableUserSessions = ActualUserSessions - ActiveUserSessions</p>",
10951095
"smithy.api#required": {}
10961096
}
10971097
},
@@ -1105,14 +1105,14 @@
11051105
"ActualUserSessions": {
11061106
"target": "com.amazonaws.workspaces#ActualUserSessions",
11071107
"traits": {
1108-
"smithy.api#documentation": "<p>The total number of session slots that are available for a pool of WorkSpaces.</p>",
1108+
"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>",
11091109
"smithy.api#required": {}
11101110
}
11111111
},
11121112
"ActiveUserSessions": {
11131113
"target": "com.amazonaws.workspaces#ActiveUserSessions",
11141114
"traits": {
1115-
"smithy.api#documentation": "<p>The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.</p>",
1115+
"smithy.api#documentation": "<p>The number of user sessions currently being used for your pool.</p>",
11161116
"smithy.api#required": {}
11171117
}
11181118
}
@@ -2478,7 +2478,7 @@
24782478
}
24792479
],
24802480
"traits": {
2481-
"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>"
2481+
"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>"
24822482
}
24832483
},
24842484
"com.amazonaws.workspaces#CreateWorkspacesPool": {
@@ -10799,7 +10799,7 @@
1079910799
"RunningMode": {
1080010800
"target": "com.amazonaws.workspaces#RunningMode",
1080110801
"traits": {
10802-
"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>"
10802+
"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>"
1080310803
}
1080410804
},
1080510805
"RunningModeAutoStopTimeoutInMinutes": {

0 commit comments

Comments
 (0)