Skip to content

Commit 0f0b785

Browse files
author
awstools
committed
docs(client-workspaces): Added AWS Workspaces RebootWorkspaces API - Extended Reboot documentation update
1 parent dd0cdf2 commit 0f0b785

File tree

4 files changed

+9
-26
lines changed

4 files changed

+9
-26
lines changed

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

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,6 @@ 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>Ensure you review your running mode to ensure you are using a running mode that is optimal for your needs and budget.
47-
* For more information on switching running modes, see
48-
* <a href="https://aws.amazon.com/workspaces/faqs/#:~:text=Q%3A%20Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%3F">
49-
* Can I switch between hourly and monthly billing?</a>
50-
* </p>
51-
* </li>
5245
* </ul>
5346
* </note>
5447
* @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: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1939,20 +1939,9 @@ export interface WorkspaceProperties {
19391939
* <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
19401940
* Mode</a>.</p>
19411941
* <note>
1942-
* <ul>
1943-
* <li>
1944-
* <p>The <code>MANUAL</code> value is only supported by Amazon WorkSpaces Core. Contact
1945-
* your account team to be allow-listed to use this value. For more information, see
1946-
* <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p>
1947-
* </li>
1948-
* <li>
1949-
* <p>Ensure you review your running mode to ensure you are using a running mode that is optimal for your needs and budget.
1950-
* For more information on switching running modes, see
1951-
* <a href="https://aws.amazon.com/workspaces/faqs/#:~:text=Q%3A%20Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%3F">
1952-
* Can I switch between hourly and monthly billing?</a>
1953-
* </p>
1954-
* </li>
1955-
* </ul>
1942+
* <p>The <code>MANUAL</code> value is only supported by Amazon WorkSpaces Core. Contact
1943+
* your account team to be allow-listed to use this value. For more information, see
1944+
* <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p>
19561945
* </note>
19571946
*/
19581947
RunningMode?: RunningMode;

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 <li>\n <p>Ensure you review your running mode to ensure you are using a running mode that is optimal for your needs and budget.\n For more information on switching running modes, see \n <a href=\"https://aws.amazon.com/workspaces/faqs/#:~:text=Q%3A%20Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%3F\">\n Can I switch between hourly and monthly billing?</a>\n </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 </ul>\n </note>"
20932093
}
20942094
},
20952095
"com.amazonaws.workspaces#CreateWorkspacesRequest": {
@@ -6238,7 +6238,7 @@
62386238
}
62396239
],
62406240
"traits": {
6241-
"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>"
6241+
"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>"
62426242
}
62436243
},
62446244
"com.amazonaws.workspaces#RebootWorkspacesRequest": {
@@ -8832,7 +8832,7 @@
88328832
"RunningMode": {
88338833
"target": "com.amazonaws.workspaces#RunningMode",
88348834
"traits": {
8835-
"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 <ul>\n <li>\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 </li>\n <li>\n <p>Ensure you review your running mode to ensure you are using a running mode that is optimal for your needs and budget.\n For more information on switching running modes, see \n <a href=\"https://aws.amazon.com/workspaces/faqs/#:~:text=Q%3A%20Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%3F\">\n Can I switch between hourly and monthly billing?</a>\n </p>\n </li>\n </ul>\n </note>"
8835+
"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>"
88368836
}
88378837
},
88388838
"RunningModeAutoStopTimeoutInMinutes": {

0 commit comments

Comments
 (0)