@aws-sdk/client-workspaces 3.323.0 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/dist-types/commands/AssociateConnectionAliasCommand.d.ts +6 -0
  2. package/dist-types/commands/AssociateIpGroupsCommand.d.ts +4 -0
  3. package/dist-types/commands/AuthorizeIpRulesCommand.d.ts +4 -0
  4. package/dist-types/commands/CopyWorkspaceImageCommand.d.ts +6 -0
  5. package/dist-types/commands/CreateConnectClientAddInCommand.d.ts +6 -0
  6. package/dist-types/commands/CreateConnectionAliasCommand.d.ts +6 -0
  7. package/dist-types/commands/CreateIpGroupCommand.d.ts +6 -0
  8. package/dist-types/commands/CreateStandbyWorkspacesCommand.d.ts +30 -0
  9. package/dist-types/commands/CreateTagsCommand.d.ts +4 -0
  10. package/dist-types/commands/CreateUpdatedWorkspaceImageCommand.d.ts +6 -0
  11. package/dist-types/commands/CreateWorkspaceBundleCommand.d.ts +25 -0
  12. package/dist-types/commands/CreateWorkspaceImageCommand.d.ts +15 -0
  13. package/dist-types/commands/CreateWorkspacesCommand.d.ts +76 -0
  14. package/dist-types/commands/DeleteClientBrandingCommand.d.ts +4 -0
  15. package/dist-types/commands/DeleteConnectClientAddInCommand.d.ts +4 -0
  16. package/dist-types/commands/DeleteConnectionAliasCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteIpGroupCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteTagsCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteWorkspaceBundleCommand.d.ts +4 -0
  20. package/dist-types/commands/DeleteWorkspaceImageCommand.d.ts +4 -0
  21. package/dist-types/commands/DeregisterWorkspaceDirectoryCommand.d.ts +4 -0
  22. package/dist-types/commands/DescribeAccountCommand.d.ts +7 -0
  23. package/dist-types/commands/DescribeAccountModificationsCommand.d.ts +16 -0
  24. package/dist-types/commands/DescribeClientBrandingCommand.d.ts +59 -0
  25. package/dist-types/commands/DescribeClientPropertiesCommand.d.ts +14 -0
  26. package/dist-types/commands/DescribeConnectClientAddInsCommand.d.ts +14 -0
  27. package/dist-types/commands/DescribeConnectionAliasPermissionsCommand.d.ts +13 -0
  28. package/dist-types/commands/DescribeConnectionAliasesCommand.d.ts +22 -0
  29. package/dist-types/commands/DescribeIpGroupsCommand.d.ts +19 -0
  30. package/dist-types/commands/DescribeTagsCommand.d.ts +11 -0
  31. package/dist-types/commands/DescribeWorkspaceBundlesCommand.d.ts +28 -0
  32. package/dist-types/commands/DescribeWorkspaceDirectoriesCommand.d.ts +63 -0
  33. package/dist-types/commands/DescribeWorkspaceImagePermissionsCommand.d.ts +12 -0
  34. package/dist-types/commands/DescribeWorkspaceImagesCommand.d.ts +26 -0
  35. package/dist-types/commands/DescribeWorkspaceSnapshotsCommand.d.ts +15 -0
  36. package/dist-types/commands/DescribeWorkspacesCommand.d.ts +47 -0
  37. package/dist-types/commands/DescribeWorkspacesConnectionStatusCommand.d.ts +14 -0
  38. package/dist-types/commands/DisassociateConnectionAliasCommand.d.ts +4 -0
  39. package/dist-types/commands/DisassociateIpGroupsCommand.d.ts +4 -0
  40. package/dist-types/commands/ImportClientBrandingCommand.d.ts +59 -0
  41. package/dist-types/commands/ImportWorkspaceImageCommand.d.ts +6 -0
  42. package/dist-types/commands/ListAvailableManagementCidrRangesCommand.d.ts +9 -0
  43. package/dist-types/commands/MigrateWorkspaceCommand.d.ts +7 -0
  44. package/dist-types/commands/ModifyAccountCommand.d.ts +4 -0
  45. package/dist-types/commands/ModifyCertificateBasedAuthPropertiesCommand.d.ts +4 -0
  46. package/dist-types/commands/ModifyClientPropertiesCommand.d.ts +4 -0
  47. package/dist-types/commands/ModifySamlPropertiesCommand.d.ts +4 -0
  48. package/dist-types/commands/ModifySelfservicePermissionsCommand.d.ts +4 -0
  49. package/dist-types/commands/ModifyWorkspaceAccessPropertiesCommand.d.ts +4 -0
  50. package/dist-types/commands/ModifyWorkspaceCreationPropertiesCommand.d.ts +4 -0
  51. package/dist-types/commands/ModifyWorkspacePropertiesCommand.d.ts +4 -0
  52. package/dist-types/commands/ModifyWorkspaceStateCommand.d.ts +4 -0
  53. package/dist-types/commands/RebootWorkspacesCommand.d.ts +12 -0
  54. package/dist-types/commands/RebuildWorkspacesCommand.d.ts +12 -0
  55. package/dist-types/commands/RegisterWorkspaceDirectoryCommand.d.ts +4 -0
  56. package/dist-types/commands/RestoreWorkspaceCommand.d.ts +4 -0
  57. package/dist-types/commands/RevokeIpRulesCommand.d.ts +4 -0
  58. package/dist-types/commands/StartWorkspacesCommand.d.ts +12 -0
  59. package/dist-types/commands/StopWorkspacesCommand.d.ts +12 -0
  60. package/dist-types/commands/TerminateWorkspacesCommand.d.ts +12 -0
  61. package/dist-types/commands/UpdateConnectClientAddInCommand.d.ts +4 -0
  62. package/dist-types/commands/UpdateConnectionAliasPermissionCommand.d.ts +4 -0
  63. package/dist-types/commands/UpdateRulesOfIpGroupCommand.d.ts +4 -0
  64. package/dist-types/commands/UpdateWorkspaceBundleCommand.d.ts +4 -0
  65. package/dist-types/commands/UpdateWorkspaceImagePermissionCommand.d.ts +4 -0
  66. package/package.json +16 -16
@@ -112,6 +112,63 @@ export interface ImportClientBrandingCommandOutput extends ImportClientBrandingR
112
112
  * };
113
113
  * const command = new ImportClientBrandingCommand(input);
114
114
  * const response = await client.send(command);
115
+ * // { // ImportClientBrandingResult
116
+ * // DeviceTypeWindows: { // DefaultClientBrandingAttributes
117
+ * // LogoUrl: "STRING_VALUE",
118
+ * // SupportEmail: "STRING_VALUE",
119
+ * // SupportLink: "STRING_VALUE",
120
+ * // ForgotPasswordLink: "STRING_VALUE",
121
+ * // LoginMessage: { // LoginMessage
122
+ * // "<keys>": "STRING_VALUE",
123
+ * // },
124
+ * // },
125
+ * // DeviceTypeOsx: {
126
+ * // LogoUrl: "STRING_VALUE",
127
+ * // SupportEmail: "STRING_VALUE",
128
+ * // SupportLink: "STRING_VALUE",
129
+ * // ForgotPasswordLink: "STRING_VALUE",
130
+ * // LoginMessage: {
131
+ * // "<keys>": "STRING_VALUE",
132
+ * // },
133
+ * // },
134
+ * // DeviceTypeAndroid: {
135
+ * // LogoUrl: "STRING_VALUE",
136
+ * // SupportEmail: "STRING_VALUE",
137
+ * // SupportLink: "STRING_VALUE",
138
+ * // ForgotPasswordLink: "STRING_VALUE",
139
+ * // LoginMessage: {
140
+ * // "<keys>": "STRING_VALUE",
141
+ * // },
142
+ * // },
143
+ * // DeviceTypeIos: { // IosClientBrandingAttributes
144
+ * // LogoUrl: "STRING_VALUE",
145
+ * // Logo2xUrl: "STRING_VALUE",
146
+ * // Logo3xUrl: "STRING_VALUE",
147
+ * // SupportEmail: "STRING_VALUE",
148
+ * // SupportLink: "STRING_VALUE",
149
+ * // ForgotPasswordLink: "STRING_VALUE",
150
+ * // LoginMessage: {
151
+ * // "<keys>": "STRING_VALUE",
152
+ * // },
153
+ * // },
154
+ * // DeviceTypeLinux: {
155
+ * // LogoUrl: "STRING_VALUE",
156
+ * // SupportEmail: "STRING_VALUE",
157
+ * // SupportLink: "STRING_VALUE",
158
+ * // ForgotPasswordLink: "STRING_VALUE",
159
+ * // LoginMessage: {
160
+ * // "<keys>": "STRING_VALUE",
161
+ * // },
162
+ * // },
163
+ * // DeviceTypeWeb: {
164
+ * // LogoUrl: "STRING_VALUE",
165
+ * // SupportEmail: "STRING_VALUE",
166
+ * // SupportLink: "STRING_VALUE",
167
+ * // ForgotPasswordLink: "STRING_VALUE",
168
+ * // LoginMessage: "<LoginMessage>",
169
+ * // },
170
+ * // };
171
+ *
115
172
  * ```
116
173
  *
117
174
  * @param ImportClientBrandingCommandInput - {@link ImportClientBrandingCommandInput}
@@ -132,6 +189,8 @@ export interface ImportClientBrandingCommandOutput extends ImportClientBrandingR
132
189
  * @throws {@link ResourceNotFoundException} (client fault)
133
190
  * <p>The resource could not be found.</p>
134
191
  *
192
+ * @throws {@link WorkSpacesServiceException}
193
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
135
194
  *
136
195
  */
137
196
  export declare class ImportClientBrandingCommand extends $Command<ImportClientBrandingCommandInput, ImportClientBrandingCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -47,6 +47,10 @@ export interface ImportWorkspaceImageCommandOutput extends ImportWorkspaceImageR
47
47
  * };
48
48
  * const command = new ImportWorkspaceImageCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // { // ImportWorkspaceImageResult
51
+ * // ImageId: "STRING_VALUE",
52
+ * // };
53
+ *
50
54
  * ```
51
55
  *
52
56
  * @param ImportWorkspaceImageCommandInput - {@link ImportWorkspaceImageCommandInput}
@@ -73,6 +77,8 @@ export interface ImportWorkspaceImageCommandOutput extends ImportWorkspaceImageR
73
77
  * @throws {@link ResourceNotFoundException} (client fault)
74
78
  * <p>The resource could not be found.</p>
75
79
  *
80
+ * @throws {@link WorkSpacesServiceException}
81
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
76
82
  *
77
83
  */
78
84
  export declare class ImportWorkspaceImageCommand extends $Command<ImportWorkspaceImageCommandInput, ImportWorkspaceImageCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -40,6 +40,13 @@ export interface ListAvailableManagementCidrRangesCommandOutput extends ListAvai
40
40
  * };
41
41
  * const command = new ListAvailableManagementCidrRangesCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // ListAvailableManagementCidrRangesResult
44
+ * // ManagementCidrRanges: [ // DedicatedTenancyCidrRangeList
45
+ * // "STRING_VALUE",
46
+ * // ],
47
+ * // NextToken: "STRING_VALUE",
48
+ * // };
49
+ *
43
50
  * ```
44
51
  *
45
52
  * @param ListAvailableManagementCidrRangesCommandInput - {@link ListAvailableManagementCidrRangesCommandInput}
@@ -54,6 +61,8 @@ export interface ListAvailableManagementCidrRangesCommandOutput extends ListAvai
54
61
  * @throws {@link InvalidParameterValuesException} (client fault)
55
62
  * <p>One or more parameter values are not valid.</p>
56
63
  *
64
+ * @throws {@link WorkSpacesServiceException}
65
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
57
66
  *
58
67
  */
59
68
  export declare class ListAvailableManagementCidrRangesCommand extends $Command<ListAvailableManagementCidrRangesCommandInput, ListAvailableManagementCidrRangesCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -42,6 +42,11 @@ export interface MigrateWorkspaceCommandOutput extends MigrateWorkspaceResult, _
42
42
  * };
43
43
  * const command = new MigrateWorkspaceCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // MigrateWorkspaceResult
46
+ * // SourceWorkspaceId: "STRING_VALUE",
47
+ * // TargetWorkspaceId: "STRING_VALUE",
48
+ * // };
49
+ *
45
50
  * ```
46
51
  *
47
52
  * @param MigrateWorkspaceCommandInput - {@link MigrateWorkspaceCommandInput}
@@ -68,6 +73,8 @@ export interface MigrateWorkspaceCommandOutput extends MigrateWorkspaceResult, _
68
73
  * @throws {@link ResourceUnavailableException} (client fault)
69
74
  * <p>The specified resource is not available.</p>
70
75
  *
76
+ * @throws {@link WorkSpacesServiceException}
77
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
71
78
  *
72
79
  */
73
80
  export declare class MigrateWorkspaceCommand extends $Command<MigrateWorkspaceCommandInput, MigrateWorkspaceCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface ModifyAccountCommandOutput extends ModifyAccountResult, __Metad
33
33
  * };
34
34
  * const command = new ModifyAccountCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param ModifyAccountCommandInput - {@link ModifyAccountCommandInput}
@@ -56,6 +58,8 @@ export interface ModifyAccountCommandOutput extends ModifyAccountResult, __Metad
56
58
  * @throws {@link ResourceUnavailableException} (client fault)
57
59
  * <p>The specified resource is not available.</p>
58
60
  *
61
+ * @throws {@link WorkSpacesServiceException}
62
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
59
63
  *
60
64
  */
61
65
  export declare class ModifyAccountCommand extends $Command<ModifyAccountCommandInput, ModifyAccountCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -39,6 +39,8 @@ export interface ModifyCertificateBasedAuthPropertiesCommandOutput extends Modif
39
39
  * };
40
40
  * const command = new ModifyCertificateBasedAuthPropertiesCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // {};
43
+ *
42
44
  * ```
43
45
  *
44
46
  * @param ModifyCertificateBasedAuthPropertiesCommandInput - {@link ModifyCertificateBasedAuthPropertiesCommandInput}
@@ -59,6 +61,8 @@ export interface ModifyCertificateBasedAuthPropertiesCommandOutput extends Modif
59
61
  * @throws {@link ResourceNotFoundException} (client fault)
60
62
  * <p>The resource could not be found.</p>
61
63
  *
64
+ * @throws {@link WorkSpacesServiceException}
65
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
62
66
  *
63
67
  */
64
68
  export declare class ModifyCertificateBasedAuthPropertiesCommand extends $Command<ModifyCertificateBasedAuthPropertiesCommandInput, ModifyCertificateBasedAuthPropertiesCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface ModifyClientPropertiesCommandOutput extends ModifyClientPropert
35
35
  * };
36
36
  * const command = new ModifyClientPropertiesCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param ModifyClientPropertiesCommandInput - {@link ModifyClientPropertiesCommandInput}
@@ -52,6 +54,8 @@ export interface ModifyClientPropertiesCommandOutput extends ModifyClientPropert
52
54
  * @throws {@link ResourceNotFoundException} (client fault)
53
55
  * <p>The resource could not be found.</p>
54
56
  *
57
+ * @throws {@link WorkSpacesServiceException}
58
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
55
59
  *
56
60
  */
57
61
  export declare class ModifyClientPropertiesCommand extends $Command<ModifyClientPropertiesCommandInput, ModifyClientPropertiesCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -41,6 +41,8 @@ export interface ModifySamlPropertiesCommandOutput extends ModifySamlPropertiesR
41
41
  * };
42
42
  * const command = new ModifySamlPropertiesCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // {};
45
+ *
44
46
  * ```
45
47
  *
46
48
  * @param ModifySamlPropertiesCommandInput - {@link ModifySamlPropertiesCommandInput}
@@ -61,6 +63,8 @@ export interface ModifySamlPropertiesCommandOutput extends ModifySamlPropertiesR
61
63
  * @throws {@link ResourceNotFoundException} (client fault)
62
64
  * <p>The resource could not be found.</p>
63
65
  *
66
+ * @throws {@link WorkSpacesServiceException}
67
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
64
68
  *
65
69
  */
66
70
  export declare class ModifySamlPropertiesCommand extends $Command<ModifySamlPropertiesCommandInput, ModifySamlPropertiesCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -39,6 +39,8 @@ export interface ModifySelfservicePermissionsCommandOutput extends ModifySelfser
39
39
  * };
40
40
  * const command = new ModifySelfservicePermissionsCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // {};
43
+ *
42
44
  * ```
43
45
  *
44
46
  * @param ModifySelfservicePermissionsCommandInput - {@link ModifySelfservicePermissionsCommandInput}
@@ -56,6 +58,8 @@ export interface ModifySelfservicePermissionsCommandOutput extends ModifySelfser
56
58
  * @throws {@link ResourceNotFoundException} (client fault)
57
59
  * <p>The resource could not be found.</p>
58
60
  *
61
+ * @throws {@link WorkSpacesServiceException}
62
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
59
63
  *
60
64
  */
61
65
  export declare class ModifySelfservicePermissionsCommand extends $Command<ModifySelfservicePermissionsCommandInput, ModifySelfservicePermissionsCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -43,6 +43,8 @@ export interface ModifyWorkspaceAccessPropertiesCommandOutput extends ModifyWork
43
43
  * };
44
44
  * const command = new ModifyWorkspaceAccessPropertiesCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // {};
47
+ *
46
48
  * ```
47
49
  *
48
50
  * @param ModifyWorkspaceAccessPropertiesCommandInput - {@link ModifyWorkspaceAccessPropertiesCommandInput}
@@ -57,6 +59,8 @@ export interface ModifyWorkspaceAccessPropertiesCommandOutput extends ModifyWork
57
59
  * @throws {@link ResourceNotFoundException} (client fault)
58
60
  * <p>The resource could not be found.</p>
59
61
  *
62
+ * @throws {@link WorkSpacesServiceException}
63
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
60
64
  *
61
65
  */
62
66
  export declare class ModifyWorkspaceAccessPropertiesCommand extends $Command<ModifyWorkspaceAccessPropertiesCommandInput, ModifyWorkspaceAccessPropertiesCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -39,6 +39,8 @@ export interface ModifyWorkspaceCreationPropertiesCommandOutput extends ModifyWo
39
39
  * };
40
40
  * const command = new ModifyWorkspaceCreationPropertiesCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // {};
43
+ *
42
44
  * ```
43
45
  *
44
46
  * @param ModifyWorkspaceCreationPropertiesCommandInput - {@link ModifyWorkspaceCreationPropertiesCommandInput}
@@ -59,6 +61,8 @@ export interface ModifyWorkspaceCreationPropertiesCommandOutput extends ModifyWo
59
61
  * @throws {@link ResourceNotFoundException} (client fault)
60
62
  * <p>The resource could not be found.</p>
61
63
  *
64
+ * @throws {@link WorkSpacesServiceException}
65
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
62
66
  *
63
67
  */
64
68
  export declare class ModifyWorkspaceCreationPropertiesCommand extends $Command<ModifyWorkspaceCreationPropertiesCommandInput, ModifyWorkspaceCreationPropertiesCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -49,6 +49,8 @@ export interface ModifyWorkspacePropertiesCommandOutput extends ModifyWorkspaceP
49
49
  * };
50
50
  * const command = new ModifyWorkspacePropertiesCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // {};
53
+ *
52
54
  * ```
53
55
  *
54
56
  * @param ModifyWorkspacePropertiesCommandInput - {@link ModifyWorkspacePropertiesCommandInput}
@@ -80,6 +82,8 @@ export interface ModifyWorkspacePropertiesCommandOutput extends ModifyWorkspaceP
80
82
  * <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/required-service-components.html">Required
81
83
  * Configuration and Service Components for WorkSpaces </a>.</p>
82
84
  *
85
+ * @throws {@link WorkSpacesServiceException}
86
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
83
87
  *
84
88
  */
85
89
  export declare class ModifyWorkspacePropertiesCommand extends $Command<ModifyWorkspacePropertiesCommandInput, ModifyWorkspacePropertiesCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -37,6 +37,8 @@ export interface ModifyWorkspaceStateCommandOutput extends ModifyWorkspaceStateR
37
37
  * };
38
38
  * const command = new ModifyWorkspaceStateCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param ModifyWorkspaceStateCommandInput - {@link ModifyWorkspaceStateCommandInput}
@@ -57,6 +59,8 @@ export interface ModifyWorkspaceStateCommandOutput extends ModifyWorkspaceStateR
57
59
  * @throws {@link ResourceNotFoundException} (client fault)
58
60
  * <p>The resource could not be found.</p>
59
61
  *
62
+ * @throws {@link WorkSpacesServiceException}
63
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
60
64
  *
61
65
  */
62
66
  export declare class ModifyWorkspaceStateCommand extends $Command<ModifyWorkspaceStateCommandInput, ModifyWorkspaceStateCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -38,6 +38,16 @@ export interface RebootWorkspacesCommandOutput extends RebootWorkspacesResult, _
38
38
  * };
39
39
  * const command = new RebootWorkspacesCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // RebootWorkspacesResult
42
+ * // FailedRequests: [ // FailedRebootWorkspaceRequests
43
+ * // { // FailedWorkspaceChangeRequest
44
+ * // WorkspaceId: "STRING_VALUE",
45
+ * // ErrorCode: "STRING_VALUE",
46
+ * // ErrorMessage: "STRING_VALUE",
47
+ * // },
48
+ * // ],
49
+ * // };
50
+ *
41
51
  * ```
42
52
  *
43
53
  * @param RebootWorkspacesCommandInput - {@link RebootWorkspacesCommandInput}
@@ -49,6 +59,8 @@ export interface RebootWorkspacesCommandOutput extends RebootWorkspacesResult, _
49
59
  * @throws {@link OperationNotSupportedException} (client fault)
50
60
  * <p>This operation is not supported.</p>
51
61
  *
62
+ * @throws {@link WorkSpacesServiceException}
63
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
52
64
  *
53
65
  */
54
66
  export declare class RebootWorkspacesCommand extends $Command<RebootWorkspacesCommandInput, RebootWorkspacesCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -43,6 +43,16 @@ export interface RebuildWorkspacesCommandOutput extends RebuildWorkspacesResult,
43
43
  * };
44
44
  * const command = new RebuildWorkspacesCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // RebuildWorkspacesResult
47
+ * // FailedRequests: [ // FailedRebuildWorkspaceRequests
48
+ * // { // FailedWorkspaceChangeRequest
49
+ * // WorkspaceId: "STRING_VALUE",
50
+ * // ErrorCode: "STRING_VALUE",
51
+ * // ErrorMessage: "STRING_VALUE",
52
+ * // },
53
+ * // ],
54
+ * // };
55
+ *
46
56
  * ```
47
57
  *
48
58
  * @param RebuildWorkspacesCommandInput - {@link RebuildWorkspacesCommandInput}
@@ -54,6 +64,8 @@ export interface RebuildWorkspacesCommandOutput extends RebuildWorkspacesResult,
54
64
  * @throws {@link OperationNotSupportedException} (client fault)
55
65
  * <p>This operation is not supported.</p>
56
66
  *
67
+ * @throws {@link WorkSpacesServiceException}
68
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
57
69
  *
58
70
  */
59
71
  export declare class RebuildWorkspacesCommand extends $Command<RebuildWorkspacesCommandInput, RebuildWorkspacesCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -47,6 +47,8 @@ export interface RegisterWorkspaceDirectoryCommandOutput extends RegisterWorkspa
47
47
  * };
48
48
  * const command = new RegisterWorkspaceDirectoryCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // {};
51
+ *
50
52
  * ```
51
53
  *
52
54
  * @param RegisterWorkspaceDirectoryCommandInput - {@link RegisterWorkspaceDirectoryCommandInput}
@@ -83,6 +85,8 @@ export interface RegisterWorkspaceDirectoryCommandOutput extends RegisterWorkspa
83
85
  * <p>The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you
84
86
  * will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role">Creating the workspaces_DefaultRole Role</a>.</p>
85
87
  *
88
+ * @throws {@link WorkSpacesServiceException}
89
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
86
90
  *
87
91
  */
88
92
  export declare class RegisterWorkspaceDirectoryCommand extends $Command<RegisterWorkspaceDirectoryCommandInput, RegisterWorkspaceDirectoryCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -38,6 +38,8 @@ export interface RestoreWorkspaceCommandOutput extends RestoreWorkspaceResult, _
38
38
  * };
39
39
  * const command = new RestoreWorkspaceCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // {};
42
+ *
41
43
  * ```
42
44
  *
43
45
  * @param RestoreWorkspaceCommandInput - {@link RestoreWorkspaceCommandInput}
@@ -58,6 +60,8 @@ export interface RestoreWorkspaceCommandOutput extends RestoreWorkspaceResult, _
58
60
  * @throws {@link ResourceNotFoundException} (client fault)
59
61
  * <p>The resource could not be found.</p>
60
62
  *
63
+ * @throws {@link WorkSpacesServiceException}
64
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
61
65
  *
62
66
  */
63
67
  export declare class RestoreWorkspaceCommand extends $Command<RestoreWorkspaceCommandInput, RestoreWorkspaceCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface RevokeIpRulesCommandOutput extends RevokeIpRulesResult, __Metad
34
34
  * };
35
35
  * const command = new RevokeIpRulesCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param RevokeIpRulesCommandInput - {@link RevokeIpRulesCommandInput}
@@ -54,6 +56,8 @@ export interface RevokeIpRulesCommandOutput extends RevokeIpRulesResult, __Metad
54
56
  * @throws {@link ResourceNotFoundException} (client fault)
55
57
  * <p>The resource could not be found.</p>
56
58
  *
59
+ * @throws {@link WorkSpacesServiceException}
60
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
57
61
  *
58
62
  */
59
63
  export declare class RevokeIpRulesCommand extends $Command<RevokeIpRulesCommandInput, RevokeIpRulesCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -37,6 +37,16 @@ export interface StartWorkspacesCommandOutput extends StartWorkspacesResult, __M
37
37
  * };
38
38
  * const command = new StartWorkspacesCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // StartWorkspacesResult
41
+ * // FailedRequests: [ // FailedStartWorkspaceRequests
42
+ * // { // FailedWorkspaceChangeRequest
43
+ * // WorkspaceId: "STRING_VALUE",
44
+ * // ErrorCode: "STRING_VALUE",
45
+ * // ErrorMessage: "STRING_VALUE",
46
+ * // },
47
+ * // ],
48
+ * // };
49
+ *
40
50
  * ```
41
51
  *
42
52
  * @param StartWorkspacesCommandInput - {@link StartWorkspacesCommandInput}
@@ -45,6 +55,8 @@ export interface StartWorkspacesCommandOutput extends StartWorkspacesResult, __M
45
55
  * @see {@link StartWorkspacesCommandOutput} for command's `response` shape.
46
56
  * @see {@link WorkSpacesClientResolvedConfig | config} for WorkSpacesClient's `config` shape.
47
57
  *
58
+ * @throws {@link WorkSpacesServiceException}
59
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
48
60
  *
49
61
  */
50
62
  export declare class StartWorkspacesCommand extends $Command<StartWorkspacesCommandInput, StartWorkspacesCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -38,6 +38,16 @@ export interface StopWorkspacesCommandOutput extends StopWorkspacesResult, __Met
38
38
  * };
39
39
  * const command = new StopWorkspacesCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // StopWorkspacesResult
42
+ * // FailedRequests: [ // FailedStopWorkspaceRequests
43
+ * // { // FailedWorkspaceChangeRequest
44
+ * // WorkspaceId: "STRING_VALUE",
45
+ * // ErrorCode: "STRING_VALUE",
46
+ * // ErrorMessage: "STRING_VALUE",
47
+ * // },
48
+ * // ],
49
+ * // };
50
+ *
41
51
  * ```
42
52
  *
43
53
  * @param StopWorkspacesCommandInput - {@link StopWorkspacesCommandInput}
@@ -46,6 +56,8 @@ export interface StopWorkspacesCommandOutput extends StopWorkspacesResult, __Met
46
56
  * @see {@link StopWorkspacesCommandOutput} for command's `response` shape.
47
57
  * @see {@link WorkSpacesClientResolvedConfig | config} for WorkSpacesClient's `config` shape.
48
58
  *
59
+ * @throws {@link WorkSpacesServiceException}
60
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
49
61
  *
50
62
  */
51
63
  export declare class StopWorkspacesCommand extends $Command<StopWorkspacesCommandInput, StopWorkspacesCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -59,6 +59,16 @@ export interface TerminateWorkspacesCommandOutput extends TerminateWorkspacesRes
59
59
  * };
60
60
  * const command = new TerminateWorkspacesCommand(input);
61
61
  * const response = await client.send(command);
62
+ * // { // TerminateWorkspacesResult
63
+ * // FailedRequests: [ // FailedTerminateWorkspaceRequests
64
+ * // { // FailedWorkspaceChangeRequest
65
+ * // WorkspaceId: "STRING_VALUE",
66
+ * // ErrorCode: "STRING_VALUE",
67
+ * // ErrorMessage: "STRING_VALUE",
68
+ * // },
69
+ * // ],
70
+ * // };
71
+ *
62
72
  * ```
63
73
  *
64
74
  * @param TerminateWorkspacesCommandInput - {@link TerminateWorkspacesCommandInput}
@@ -67,6 +77,8 @@ export interface TerminateWorkspacesCommandOutput extends TerminateWorkspacesRes
67
77
  * @see {@link TerminateWorkspacesCommandOutput} for command's `response` shape.
68
78
  * @see {@link WorkSpacesClientResolvedConfig | config} for WorkSpacesClient's `config` shape.
69
79
  *
80
+ * @throws {@link WorkSpacesServiceException}
81
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
70
82
  *
71
83
  */
72
84
  export declare class TerminateWorkspacesCommand extends $Command<TerminateWorkspacesCommandInput, TerminateWorkspacesCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface UpdateConnectClientAddInCommandOutput extends UpdateConnectClie
35
35
  * };
36
36
  * const command = new UpdateConnectClientAddInCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param UpdateConnectClientAddInCommandInput - {@link UpdateConnectClientAddInCommandInput}
@@ -52,6 +54,8 @@ export interface UpdateConnectClientAddInCommandOutput extends UpdateConnectClie
52
54
  * @throws {@link ResourceNotFoundException} (client fault)
53
55
  * <p>The resource could not be found.</p>
54
56
  *
57
+ * @throws {@link WorkSpacesServiceException}
58
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
55
59
  *
56
60
  */
57
61
  export declare class UpdateConnectClientAddInCommand extends $Command<UpdateConnectClientAddInCommandInput, UpdateConnectClientAddInCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -56,6 +56,8 @@ export interface UpdateConnectionAliasPermissionCommandOutput extends UpdateConn
56
56
  * };
57
57
  * const command = new UpdateConnectionAliasPermissionCommand(input);
58
58
  * const response = await client.send(command);
59
+ * // {};
60
+ *
59
61
  * ```
60
62
  *
61
63
  * @param UpdateConnectionAliasPermissionCommandInput - {@link UpdateConnectionAliasPermissionCommandInput}
@@ -85,6 +87,8 @@ export interface UpdateConnectionAliasPermissionCommandOutput extends UpdateConn
85
87
  * @throws {@link ResourceNotFoundException} (client fault)
86
88
  * <p>The resource could not be found.</p>
87
89
  *
90
+ * @throws {@link WorkSpacesServiceException}
91
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
88
92
  *
89
93
  */
90
94
  export declare class UpdateConnectionAliasPermissionCommand extends $Command<UpdateConnectionAliasPermissionCommandInput, UpdateConnectionAliasPermissionCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -38,6 +38,8 @@ export interface UpdateRulesOfIpGroupCommandOutput extends UpdateRulesOfIpGroupR
38
38
  * };
39
39
  * const command = new UpdateRulesOfIpGroupCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // {};
42
+ *
41
43
  * ```
42
44
  *
43
45
  * @param UpdateRulesOfIpGroupCommandInput - {@link UpdateRulesOfIpGroupCommandInput}
@@ -61,6 +63,8 @@ export interface UpdateRulesOfIpGroupCommandOutput extends UpdateRulesOfIpGroupR
61
63
  * @throws {@link ResourceNotFoundException} (client fault)
62
64
  * <p>The resource could not be found.</p>
63
65
  *
66
+ * @throws {@link WorkSpacesServiceException}
67
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
64
68
  *
65
69
  */
66
70
  export declare class UpdateRulesOfIpGroupCommand extends $Command<UpdateRulesOfIpGroupCommandInput, UpdateRulesOfIpGroupCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -39,6 +39,8 @@ export interface UpdateWorkspaceBundleCommandOutput extends UpdateWorkspaceBundl
39
39
  * };
40
40
  * const command = new UpdateWorkspaceBundleCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // {};
43
+ *
42
44
  * ```
43
45
  *
44
46
  * @param UpdateWorkspaceBundleCommandInput - {@link UpdateWorkspaceBundleCommandInput}
@@ -62,6 +64,8 @@ export interface UpdateWorkspaceBundleCommandOutput extends UpdateWorkspaceBundl
62
64
  * @throws {@link ResourceUnavailableException} (client fault)
63
65
  * <p>The specified resource is not available.</p>
64
66
  *
67
+ * @throws {@link WorkSpacesServiceException}
68
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
65
69
  *
66
70
  */
67
71
  export declare class UpdateWorkspaceBundleCommand extends $Command<UpdateWorkspaceBundleCommandInput, UpdateWorkspaceBundleCommandOutput, WorkSpacesClientResolvedConfig> {
@@ -55,6 +55,8 @@ export interface UpdateWorkspaceImagePermissionCommandOutput extends UpdateWorks
55
55
  * };
56
56
  * const command = new UpdateWorkspaceImagePermissionCommand(input);
57
57
  * const response = await client.send(command);
58
+ * // {};
59
+ *
58
60
  * ```
59
61
  *
60
62
  * @param UpdateWorkspaceImagePermissionCommandInput - {@link UpdateWorkspaceImagePermissionCommandInput}
@@ -78,6 +80,8 @@ export interface UpdateWorkspaceImagePermissionCommandOutput extends UpdateWorks
78
80
  * @throws {@link ResourceUnavailableException} (client fault)
79
81
  * <p>The specified resource is not available.</p>
80
82
  *
83
+ * @throws {@link WorkSpacesServiceException}
84
+ * <p>Base exception class for all service exceptions from WorkSpaces service.</p>
81
85
  *
82
86
  */
83
87
  export declare class UpdateWorkspaceImagePermissionCommand extends $Command<UpdateWorkspaceImagePermissionCommandInput, UpdateWorkspaceImagePermissionCommandOutput, WorkSpacesClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-workspaces",
3
3
  "description": "AWS SDK for JavaScript Workspaces Client for Node.js, Browser and React Native",
4
- "version": "3.323.0",
4
+ "version": "3.326.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,33 +21,33 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.321.1",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.321.1",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
30
- "@aws-sdk/middleware-content-length": "3.310.0",
31
- "@aws-sdk/middleware-endpoint": "3.310.0",
32
- "@aws-sdk/middleware-host-header": "3.310.0",
33
- "@aws-sdk/middleware-logger": "3.310.0",
34
- "@aws-sdk/middleware-recursion-detection": "3.310.0",
35
- "@aws-sdk/middleware-retry": "3.310.0",
36
- "@aws-sdk/middleware-serde": "3.310.0",
37
- "@aws-sdk/middleware-signing": "3.310.0",
38
- "@aws-sdk/middleware-stack": "3.310.0",
39
- "@aws-sdk/middleware-user-agent": "3.319.0",
30
+ "@aws-sdk/middleware-content-length": "3.325.0",
31
+ "@aws-sdk/middleware-endpoint": "3.325.0",
32
+ "@aws-sdk/middleware-host-header": "3.325.0",
33
+ "@aws-sdk/middleware-logger": "3.325.0",
34
+ "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.325.0",
36
+ "@aws-sdk/middleware-serde": "3.325.0",
37
+ "@aws-sdk/middleware-signing": "3.325.0",
38
+ "@aws-sdk/middleware-stack": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.325.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.316.0",
43
+ "@aws-sdk/smithy-client": "3.325.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.316.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
51
  "@aws-sdk/util-endpoints": "3.319.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",