Skip to content

Commit

Permalink
docs(client-workspaces): Added AWS Workspaces RebootWorkspaces API - …
Browse files Browse the repository at this point in the history 
…Extended Reboot documentation update
  • Loading branch information
awstools committed Jan 11, 2024
1 parent dd0cdf2 commit 0f0b785
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 26 deletions.
7 changes: 0 additions & 7 deletions clients/client-workspaces/src/commands/CreateWorkspacesCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,6 @@ 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>Ensure you review your running mode to ensure you are using a running mode that is optimal for your needs and budget.
* For more information on switching running modes, see
* <a href="https://aws.amazon.com/workspaces/faqs/#:~:text=Q%3A%20Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%3F">
* Can I switch between hourly and monthly billing?</a>
* </p>
* </li>
* </ul>
* </note>
* @example
Expand Down
5 changes: 3 additions & 2 deletions clients/client-workspaces/src/commands/RebootWorkspacesCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
17 changes: 3 additions & 14 deletions clients/client-workspaces/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1939,20 +1939,9 @@ export interface WorkspaceProperties {
* <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
* Mode</a>.</p>
* <note>
* <ul>
* <li>
* <p>The <code>MANUAL</code> value is only supported by Amazon WorkSpaces Core. Contact
* 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>
* </li>
* <li>
* <p>Ensure you review your running mode to ensure you are using a running mode that is optimal for your needs and budget.
* For more information on switching running modes, see
* <a href="https://aws.amazon.com/workspaces/faqs/#:~:text=Q%3A%20Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%3F">
* Can I switch between hourly and monthly billing?</a>
* </p>
* </li>
* </ul>
* <p>The <code>MANUAL</code> value is only supported by Amazon WorkSpaces Core. Contact
* 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>
*/
RunningMode?: RunningMode;
Expand Down
6 changes: 3 additions & 3 deletions codegen/sdk-codegen/aws-models/workspaces.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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>"
"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>"
}
},
"com.amazonaws.workspaces#CreateWorkspacesRequest": {
Expand Down Expand Up @@ -6238,7 +6238,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": {
Expand Down Expand Up @@ -8832,7 +8832,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 <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>"
"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>"
}
},
"RunningModeAutoStopTimeoutInMinutes": {
Expand Down

0 comments on commit 0f0b785

Please sign in to comment.