Skip to content

Commit 2162019

Browse files
author
awstools
committed
docs(client-workspaces): Documentation-only update that clarifies the StartWorkspaces and StopWorkspaces actions, and a few other minor edits.
1 parent 950682d commit 2162019

File tree

4 files changed

+16
-9
lines changed

4 files changed

+16
-9
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ export interface StartWorkspacesCommandOutput extends StartWorkspacesResult, __M
2929

3030
/**
3131
* <p>Starts the specified WorkSpaces.</p>
32-
* <p>You cannot start a WorkSpace unless it has a running mode of <code>AutoStop</code> and a
33-
* state of <code>STOPPED</code>.</p>
32+
* <p>You cannot start a WorkSpace unless it has a running mode of <code>AutoStop</code> or
33+
* <code>Manual</code> and a state of <code>STOPPED</code>.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ export interface StopWorkspacesCommandInput extends StopWorkspacesRequest {}
2828
export interface StopWorkspacesCommandOutput extends StopWorkspacesResult, __MetadataBearer {}
2929

3030
/**
31-
* <p> Stops the specified WorkSpaces.</p>
32-
* <p>You cannot stop a WorkSpace unless it has a running mode of <code>AutoStop</code> and a
33-
* state of <code>AVAILABLE</code>, <code>IMPAIRED</code>, <code>UNHEALTHY</code>, or
34-
* <code>ERROR</code>.</p>
31+
* <p>Stops the specified WorkSpaces.</p>
32+
* <p>You cannot stop a WorkSpace unless it has a running mode of <code>AutoStop</code> or
33+
* <code>Manual</code> and a state of <code>AVAILABLE</code>, <code>IMPAIRED</code>,
34+
* <code>UNHEALTHY</code>, or <code>ERROR</code>.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2369,6 +2369,13 @@ export interface WorkspaceRequest {
23692369

23702370
/**
23712371
* <p>The name of the user-decoupled WorkSpace.</p>
2372+
* <note>
2373+
* <p>
2374+
* <code>WorkspaceName</code> is required if <code>UserName</code> is
2375+
* <code>[UNDEFINED]</code> for user-decoupled WorkSpaces.
2376+
* <code>WorkspaceName</code> is not applicable if <code>UserName</code> is specified
2377+
* for user-assigned WorkSpaces.</p>
2378+
* </note>
23722379
* @public
23732380
*/
23742381
WorkspaceName?: string;

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8489,7 +8489,7 @@
84898489
"target": "com.amazonaws.workspaces#StartWorkspacesResult"
84908490
},
84918491
"traits": {
8492-
"smithy.api#documentation": "<p>Starts the specified WorkSpaces.</p>\n <p>You cannot start a WorkSpace unless it has a running mode of <code>AutoStop</code> and a\n state of <code>STOPPED</code>.</p>"
8492+
"smithy.api#documentation": "<p>Starts the specified WorkSpaces.</p>\n <p>You cannot start a WorkSpace unless it has a running mode of <code>AutoStop</code> or\n <code>Manual</code> and a state of <code>STOPPED</code>.</p>"
84938493
}
84948494
},
84958495
"com.amazonaws.workspaces#StartWorkspacesPool": {
@@ -8613,7 +8613,7 @@
86138613
"target": "com.amazonaws.workspaces#StopWorkspacesResult"
86148614
},
86158615
"traits": {
8616-
"smithy.api#documentation": "<p> Stops the specified WorkSpaces.</p>\n <p>You cannot stop a WorkSpace unless it has a running mode of <code>AutoStop</code> and a\n state of <code>AVAILABLE</code>, <code>IMPAIRED</code>, <code>UNHEALTHY</code>, or\n <code>ERROR</code>.</p>"
8616+
"smithy.api#documentation": "<p>Stops the specified WorkSpaces.</p>\n <p>You cannot stop a WorkSpace unless it has a running mode of <code>AutoStop</code> or\n <code>Manual</code> and a state of <code>AVAILABLE</code>, <code>IMPAIRED</code>,\n <code>UNHEALTHY</code>, or <code>ERROR</code>.</p>"
86178617
}
86188618
},
86198619
"com.amazonaws.workspaces#StopWorkspacesPool": {
@@ -11063,7 +11063,7 @@
1106311063
"WorkspaceName": {
1106411064
"target": "com.amazonaws.workspaces#WorkspaceName",
1106511065
"traits": {
11066-
"smithy.api#documentation": "<p>The name of the user-decoupled WorkSpace.</p>"
11066+
"smithy.api#documentation": "<p>The name of the user-decoupled WorkSpace.</p>\n <note>\n <p>\n <code>WorkspaceName</code> is required if <code>UserName</code> is\n <code>[UNDEFINED]</code> for user-decoupled WorkSpaces.\n <code>WorkspaceName</code> is not applicable if <code>UserName</code> is specified\n for user-assigned WorkSpaces.</p>\n </note>"
1106711067
}
1106811068
}
1106911069
},

0 commit comments

Comments
 (0)