@aws-sdk/client-workspaces 3.529.1 → 3.535.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.
- package/dist-types/WorkSpaces.d.ts +14 -1
- package/dist-types/WorkSpacesClient.d.ts +1 -1
- package/dist-types/commands/AssociateConnectionAliasCommand.d.ts +2 -1
- package/dist-types/commands/AssociateIpGroupsCommand.d.ts +2 -1
- package/dist-types/commands/AssociateWorkspaceApplicationCommand.d.ts +2 -1
- package/dist-types/commands/AuthorizeIpRulesCommand.d.ts +2 -1
- package/dist-types/commands/CopyWorkspaceImageCommand.d.ts +2 -1
- package/dist-types/commands/CreateConnectClientAddInCommand.d.ts +2 -1
- package/dist-types/commands/CreateConnectionAliasCommand.d.ts +2 -1
- package/dist-types/commands/CreateIpGroupCommand.d.ts +2 -1
- package/dist-types/commands/CreateStandbyWorkspacesCommand.d.ts +2 -1
- package/dist-types/commands/CreateTagsCommand.d.ts +2 -1
- package/dist-types/commands/CreateUpdatedWorkspaceImageCommand.d.ts +2 -1
- package/dist-types/commands/CreateWorkspaceBundleCommand.d.ts +2 -1
- package/dist-types/commands/CreateWorkspaceImageCommand.d.ts +2 -1
- package/dist-types/commands/CreateWorkspacesCommand.d.ts +2 -1
- package/dist-types/commands/DeleteClientBrandingCommand.d.ts +2 -1
- package/dist-types/commands/DeleteConnectClientAddInCommand.d.ts +2 -1
- package/dist-types/commands/DeleteConnectionAliasCommand.d.ts +2 -1
- package/dist-types/commands/DeleteIpGroupCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTagsCommand.d.ts +2 -1
- package/dist-types/commands/DeleteWorkspaceBundleCommand.d.ts +2 -1
- package/dist-types/commands/DeleteWorkspaceImageCommand.d.ts +2 -1
- package/dist-types/commands/DeployWorkspaceApplicationsCommand.d.ts +2 -1
- package/dist-types/commands/DeregisterWorkspaceDirectoryCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAccountCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAccountModificationsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeApplicationAssociationsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeApplicationsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeBundleAssociationsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeClientBrandingCommand.d.ts +2 -1
- package/dist-types/commands/DescribeClientPropertiesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeConnectClientAddInsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeConnectionAliasPermissionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeConnectionAliasesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeImageAssociationsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeIpGroupsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTagsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeWorkspaceAssociationsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeWorkspaceBundlesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeWorkspaceDirectoriesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeWorkspaceImagePermissionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeWorkspaceImagesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeWorkspaceSnapshotsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeWorkspacesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeWorkspacesConnectionStatusCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateConnectionAliasCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateIpGroupsCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateWorkspaceApplicationCommand.d.ts +2 -1
- package/dist-types/commands/ImportClientBrandingCommand.d.ts +10 -9
- package/dist-types/commands/ImportWorkspaceImageCommand.d.ts +2 -1
- package/dist-types/commands/ListAvailableManagementCidrRangesCommand.d.ts +2 -1
- package/dist-types/commands/MigrateWorkspaceCommand.d.ts +2 -1
- package/dist-types/commands/ModifyAccountCommand.d.ts +2 -1
- package/dist-types/commands/ModifyCertificateBasedAuthPropertiesCommand.d.ts +2 -1
- package/dist-types/commands/ModifyClientPropertiesCommand.d.ts +2 -1
- package/dist-types/commands/ModifySamlPropertiesCommand.d.ts +2 -1
- package/dist-types/commands/ModifySelfservicePermissionsCommand.d.ts +2 -1
- package/dist-types/commands/ModifyWorkspaceAccessPropertiesCommand.d.ts +2 -1
- package/dist-types/commands/ModifyWorkspaceCreationPropertiesCommand.d.ts +2 -1
- package/dist-types/commands/ModifyWorkspacePropertiesCommand.d.ts +2 -1
- package/dist-types/commands/ModifyWorkspaceStateCommand.d.ts +2 -1
- package/dist-types/commands/RebootWorkspacesCommand.d.ts +2 -1
- package/dist-types/commands/RebuildWorkspacesCommand.d.ts +2 -1
- package/dist-types/commands/RegisterWorkspaceDirectoryCommand.d.ts +2 -1
- package/dist-types/commands/RestoreWorkspaceCommand.d.ts +2 -1
- package/dist-types/commands/RevokeIpRulesCommand.d.ts +2 -1
- package/dist-types/commands/StartWorkspacesCommand.d.ts +2 -1
- package/dist-types/commands/StopWorkspacesCommand.d.ts +2 -1
- package/dist-types/commands/TerminateWorkspacesCommand.d.ts +2 -1
- package/dist-types/commands/UpdateConnectClientAddInCommand.d.ts +2 -1
- package/dist-types/commands/UpdateConnectionAliasPermissionCommand.d.ts +2 -1
- package/dist-types/commands/UpdateRulesOfIpGroupCommand.d.ts +2 -1
- package/dist-types/commands/UpdateWorkspaceBundleCommand.d.ts +2 -1
- package/dist-types/commands/UpdateWorkspaceImagePermissionCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +595 -595
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/WorkSpaces.d.ts +13 -0
- package/dist-types/ts3.4/commands/AssociateConnectionAliasCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateIpGroupsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AssociateWorkspaceApplicationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/AuthorizeIpRulesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CopyWorkspaceImageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateConnectClientAddInCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateConnectionAliasCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateIpGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateStandbyWorkspacesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateTagsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateUpdatedWorkspaceImageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateWorkspaceBundleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateWorkspaceImageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateWorkspacesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteClientBrandingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteConnectClientAddInCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteConnectionAliasCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteIpGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteTagsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteWorkspaceBundleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteWorkspaceImageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeployWorkspaceApplicationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeregisterWorkspaceDirectoryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeAccountCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeAccountModificationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeApplicationAssociationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeApplicationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeBundleAssociationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeClientBrandingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeClientPropertiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeConnectClientAddInsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeConnectionAliasPermissionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeConnectionAliasesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeImageAssociationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeIpGroupsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeTagsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeWorkspaceAssociationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeWorkspaceBundlesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeWorkspaceDirectoriesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeWorkspaceImagePermissionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeWorkspaceImagesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeWorkspaceSnapshotsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeWorkspacesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeWorkspacesConnectionStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateConnectionAliasCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateIpGroupsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateWorkspaceApplicationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ImportClientBrandingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ImportWorkspaceImageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAvailableManagementCidrRangesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/MigrateWorkspaceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ModifyAccountCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ModifyCertificateBasedAuthPropertiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ModifyClientPropertiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ModifySamlPropertiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ModifySelfservicePermissionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ModifyWorkspaceAccessPropertiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ModifyWorkspaceCreationPropertiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ModifyWorkspacePropertiesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ModifyWorkspaceStateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RebootWorkspacesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RebuildWorkspacesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RegisterWorkspaceDirectoryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RestoreWorkspaceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RevokeIpRulesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartWorkspacesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopWorkspacesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TerminateWorkspacesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateConnectClientAddInCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateConnectionAliasPermissionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateRulesOfIpGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateWorkspaceBundleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateWorkspaceImagePermissionCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { WorkSpacesServiceException as __BaseException } from "./WorkSpacesServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>The user is not authorized to access a resource.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -50,41 +50,41 @@ export declare const DedicatedTenancyModificationStateEnum: {
|
|
|
50
50
|
*/
|
|
51
51
|
export type DedicatedTenancyModificationStateEnum = (typeof DedicatedTenancyModificationStateEnum)[keyof typeof DedicatedTenancyModificationStateEnum];
|
|
52
52
|
/**
|
|
53
|
-
* @public
|
|
54
53
|
* <p>Describes a modification to the configuration of Bring Your Own License (BYOL) for the
|
|
55
54
|
* specified account. </p>
|
|
55
|
+
* @public
|
|
56
56
|
*/
|
|
57
57
|
export interface AccountModification {
|
|
58
58
|
/**
|
|
59
|
-
* @public
|
|
60
59
|
* <p>The state of the modification to the configuration of BYOL.</p>
|
|
60
|
+
* @public
|
|
61
61
|
*/
|
|
62
62
|
ModificationState?: DedicatedTenancyModificationStateEnum;
|
|
63
63
|
/**
|
|
64
|
-
* @public
|
|
65
64
|
* <p>The status of BYOL (whether BYOL is being enabled or disabled).</p>
|
|
65
|
+
* @public
|
|
66
66
|
*/
|
|
67
67
|
DedicatedTenancySupport?: DedicatedTenancySupportResultEnum;
|
|
68
68
|
/**
|
|
69
|
-
* @public
|
|
70
69
|
* <p>The IP address range, specified as an IPv4 CIDR block, for the management network
|
|
71
70
|
* interface used for the account.</p>
|
|
71
|
+
* @public
|
|
72
72
|
*/
|
|
73
73
|
DedicatedTenancyManagementCidrRange?: string;
|
|
74
74
|
/**
|
|
75
|
-
* @public
|
|
76
75
|
* <p>The timestamp when the modification of the BYOL configuration was started.</p>
|
|
76
|
+
* @public
|
|
77
77
|
*/
|
|
78
78
|
StartTime?: Date;
|
|
79
79
|
/**
|
|
80
|
-
* @public
|
|
81
80
|
* <p>The error code that is returned if the configuration of BYOL cannot be modified.</p>
|
|
81
|
+
* @public
|
|
82
82
|
*/
|
|
83
83
|
ErrorCode?: string;
|
|
84
84
|
/**
|
|
85
|
-
* @public
|
|
86
85
|
* <p>The text of the error message that is returned if the configuration of BYOL cannot be
|
|
87
86
|
* modified.</p>
|
|
87
|
+
* @public
|
|
88
88
|
*/
|
|
89
89
|
ErrorMessage?: string;
|
|
90
90
|
}
|
|
@@ -114,8 +114,8 @@ export declare const ApplicationAssociatedResourceType: {
|
|
|
114
114
|
*/
|
|
115
115
|
export type ApplicationAssociatedResourceType = (typeof ApplicationAssociatedResourceType)[keyof typeof ApplicationAssociatedResourceType];
|
|
116
116
|
/**
|
|
117
|
-
* @public
|
|
118
117
|
* <p>The specified application is not supported.</p>
|
|
118
|
+
* @public
|
|
119
119
|
*/
|
|
120
120
|
export declare class ApplicationNotSupportedException extends __BaseException {
|
|
121
121
|
readonly name: "ApplicationNotSupportedException";
|
|
@@ -160,59 +160,59 @@ export declare const AssociationErrorCode: {
|
|
|
160
160
|
*/
|
|
161
161
|
export type AssociationErrorCode = (typeof AssociationErrorCode)[keyof typeof AssociationErrorCode];
|
|
162
162
|
/**
|
|
163
|
-
* @public
|
|
164
163
|
* <p>Indicates the reason that the association deployment failed, including the error code and error message.</p>
|
|
164
|
+
* @public
|
|
165
165
|
*/
|
|
166
166
|
export interface AssociationStateReason {
|
|
167
167
|
/**
|
|
168
|
-
* @public
|
|
169
168
|
* <p>The error code of the association deployment failure.</p>
|
|
169
|
+
* @public
|
|
170
170
|
*/
|
|
171
171
|
ErrorCode?: AssociationErrorCode;
|
|
172
172
|
/**
|
|
173
|
-
* @public
|
|
174
173
|
* <p>The error message of the association deployment failure.</p>
|
|
174
|
+
* @public
|
|
175
175
|
*/
|
|
176
176
|
ErrorMessage?: string;
|
|
177
177
|
}
|
|
178
178
|
/**
|
|
179
|
-
* @public
|
|
180
179
|
* <p>Describes the association between an application and an application resource.</p>
|
|
180
|
+
* @public
|
|
181
181
|
*/
|
|
182
182
|
export interface ApplicationResourceAssociation {
|
|
183
183
|
/**
|
|
184
|
-
* @public
|
|
185
184
|
* <p>The identifier of the application.</p>
|
|
185
|
+
* @public
|
|
186
186
|
*/
|
|
187
187
|
ApplicationId?: string;
|
|
188
188
|
/**
|
|
189
|
-
* @public
|
|
190
189
|
* <p>The identifier of the associated resource.</p>
|
|
190
|
+
* @public
|
|
191
191
|
*/
|
|
192
192
|
AssociatedResourceId?: string;
|
|
193
193
|
/**
|
|
194
|
-
* @public
|
|
195
194
|
* <p>The resource type of the associated resource.</p>
|
|
195
|
+
* @public
|
|
196
196
|
*/
|
|
197
197
|
AssociatedResourceType?: ApplicationAssociatedResourceType;
|
|
198
198
|
/**
|
|
199
|
-
* @public
|
|
200
199
|
* <p>The time the association was created.</p>
|
|
200
|
+
* @public
|
|
201
201
|
*/
|
|
202
202
|
Created?: Date;
|
|
203
203
|
/**
|
|
204
|
-
* @public
|
|
205
204
|
* <p>The time the association status was last updated.</p>
|
|
205
|
+
* @public
|
|
206
206
|
*/
|
|
207
207
|
LastUpdatedTime?: Date;
|
|
208
208
|
/**
|
|
209
|
-
* @public
|
|
210
209
|
* <p>The status of the application resource association.</p>
|
|
210
|
+
* @public
|
|
211
211
|
*/
|
|
212
212
|
State?: AssociationState;
|
|
213
213
|
/**
|
|
214
|
-
* @public
|
|
215
214
|
* <p>The reason the association deployment failed.</p>
|
|
215
|
+
* @public
|
|
216
216
|
*/
|
|
217
217
|
StateReason?: AssociationStateReason;
|
|
218
218
|
}
|
|
@@ -221,13 +221,13 @@ export interface ApplicationResourceAssociation {
|
|
|
221
221
|
*/
|
|
222
222
|
export interface AssociateConnectionAliasRequest {
|
|
223
223
|
/**
|
|
224
|
-
* @public
|
|
225
224
|
* <p>The identifier of the connection alias.</p>
|
|
225
|
+
* @public
|
|
226
226
|
*/
|
|
227
227
|
AliasId: string | undefined;
|
|
228
228
|
/**
|
|
229
|
-
* @public
|
|
230
229
|
* <p>The identifier of the directory to associate the connection alias with.</p>
|
|
230
|
+
* @public
|
|
231
231
|
*/
|
|
232
232
|
ResourceId: string | undefined;
|
|
233
233
|
}
|
|
@@ -236,15 +236,15 @@ export interface AssociateConnectionAliasRequest {
|
|
|
236
236
|
*/
|
|
237
237
|
export interface AssociateConnectionAliasResult {
|
|
238
238
|
/**
|
|
239
|
-
* @public
|
|
240
239
|
* <p>The identifier of the connection alias association. You use the connection identifier in
|
|
241
240
|
* the DNS TXT record when you're configuring your DNS routing policies. </p>
|
|
241
|
+
* @public
|
|
242
242
|
*/
|
|
243
243
|
ConnectionIdentifier?: string;
|
|
244
244
|
}
|
|
245
245
|
/**
|
|
246
|
-
* @public
|
|
247
246
|
* <p>One or more parameter values are not valid.</p>
|
|
247
|
+
* @public
|
|
248
248
|
*/
|
|
249
249
|
export declare class InvalidParameterValuesException extends __BaseException {
|
|
250
250
|
readonly name: "InvalidParameterValuesException";
|
|
@@ -255,8 +255,8 @@ export declare class InvalidParameterValuesException extends __BaseException {
|
|
|
255
255
|
constructor(opts: __ExceptionOptionType<InvalidParameterValuesException, __BaseException>);
|
|
256
256
|
}
|
|
257
257
|
/**
|
|
258
|
-
* @public
|
|
259
258
|
* <p>The state of the resource is not valid for this operation.</p>
|
|
259
|
+
* @public
|
|
260
260
|
*/
|
|
261
261
|
export declare class InvalidResourceStateException extends __BaseException {
|
|
262
262
|
readonly name: "InvalidResourceStateException";
|
|
@@ -267,15 +267,15 @@ export declare class InvalidResourceStateException extends __BaseException {
|
|
|
267
267
|
constructor(opts: __ExceptionOptionType<InvalidResourceStateException, __BaseException>);
|
|
268
268
|
}
|
|
269
269
|
/**
|
|
270
|
-
* @public
|
|
271
270
|
* <p>This operation is not supported.</p>
|
|
271
|
+
* @public
|
|
272
272
|
*/
|
|
273
273
|
export declare class OperationNotSupportedException extends __BaseException {
|
|
274
274
|
readonly name: "OperationNotSupportedException";
|
|
275
275
|
readonly $fault: "client";
|
|
276
276
|
/**
|
|
277
|
-
* @public
|
|
278
277
|
* <p>The exception error reason.</p>
|
|
278
|
+
* @public
|
|
279
279
|
*/
|
|
280
280
|
reason?: string;
|
|
281
281
|
/**
|
|
@@ -284,8 +284,8 @@ export declare class OperationNotSupportedException extends __BaseException {
|
|
|
284
284
|
constructor(opts: __ExceptionOptionType<OperationNotSupportedException, __BaseException>);
|
|
285
285
|
}
|
|
286
286
|
/**
|
|
287
|
-
* @public
|
|
288
287
|
* <p>The resource is associated with a directory.</p>
|
|
288
|
+
* @public
|
|
289
289
|
*/
|
|
290
290
|
export declare class ResourceAssociatedException extends __BaseException {
|
|
291
291
|
readonly name: "ResourceAssociatedException";
|
|
@@ -296,15 +296,15 @@ export declare class ResourceAssociatedException extends __BaseException {
|
|
|
296
296
|
constructor(opts: __ExceptionOptionType<ResourceAssociatedException, __BaseException>);
|
|
297
297
|
}
|
|
298
298
|
/**
|
|
299
|
-
* @public
|
|
300
299
|
* <p>The resource could not be found.</p>
|
|
300
|
+
* @public
|
|
301
301
|
*/
|
|
302
302
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
303
303
|
readonly name: "ResourceNotFoundException";
|
|
304
304
|
readonly $fault: "client";
|
|
305
305
|
/**
|
|
306
|
-
* @public
|
|
307
306
|
* <p>The ID of the resource that could not be found.</p>
|
|
307
|
+
* @public
|
|
308
308
|
*/
|
|
309
309
|
ResourceId?: string;
|
|
310
310
|
/**
|
|
@@ -317,13 +317,13 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
317
317
|
*/
|
|
318
318
|
export interface AssociateIpGroupsRequest {
|
|
319
319
|
/**
|
|
320
|
-
* @public
|
|
321
320
|
* <p>The identifier of the directory.</p>
|
|
321
|
+
* @public
|
|
322
322
|
*/
|
|
323
323
|
DirectoryId: string | undefined;
|
|
324
324
|
/**
|
|
325
|
-
* @public
|
|
326
325
|
* <p>The identifiers of one or more IP access control groups.</p>
|
|
326
|
+
* @public
|
|
327
327
|
*/
|
|
328
328
|
GroupIds: string[] | undefined;
|
|
329
329
|
}
|
|
@@ -333,8 +333,8 @@ export interface AssociateIpGroupsRequest {
|
|
|
333
333
|
export interface AssociateIpGroupsResult {
|
|
334
334
|
}
|
|
335
335
|
/**
|
|
336
|
-
* @public
|
|
337
336
|
* <p>Your resource limits have been exceeded.</p>
|
|
337
|
+
* @public
|
|
338
338
|
*/
|
|
339
339
|
export declare class ResourceLimitExceededException extends __BaseException {
|
|
340
340
|
readonly name: "ResourceLimitExceededException";
|
|
@@ -349,13 +349,13 @@ export declare class ResourceLimitExceededException extends __BaseException {
|
|
|
349
349
|
*/
|
|
350
350
|
export interface AssociateWorkspaceApplicationRequest {
|
|
351
351
|
/**
|
|
352
|
-
* @public
|
|
353
352
|
* <p>The identifier of the WorkSpace.</p>
|
|
353
|
+
* @public
|
|
354
354
|
*/
|
|
355
355
|
WorkspaceId: string | undefined;
|
|
356
356
|
/**
|
|
357
|
-
* @public
|
|
358
357
|
* <p>The identifier of the application.</p>
|
|
358
|
+
* @public
|
|
359
359
|
*/
|
|
360
360
|
ApplicationId: string | undefined;
|
|
361
361
|
}
|
|
@@ -371,43 +371,43 @@ export declare const WorkSpaceAssociatedResourceType: {
|
|
|
371
371
|
*/
|
|
372
372
|
export type WorkSpaceAssociatedResourceType = (typeof WorkSpaceAssociatedResourceType)[keyof typeof WorkSpaceAssociatedResourceType];
|
|
373
373
|
/**
|
|
374
|
-
* @public
|
|
375
374
|
* <p>Describes the association between an application and a WorkSpace resource.</p>
|
|
375
|
+
* @public
|
|
376
376
|
*/
|
|
377
377
|
export interface WorkspaceResourceAssociation {
|
|
378
378
|
/**
|
|
379
|
-
* @public
|
|
380
379
|
* <p>The identifier of the associated resource.</p>
|
|
380
|
+
* @public
|
|
381
381
|
*/
|
|
382
382
|
AssociatedResourceId?: string;
|
|
383
383
|
/**
|
|
384
|
-
* @public
|
|
385
384
|
* <p>The resource types of the associated resource.</p>
|
|
385
|
+
* @public
|
|
386
386
|
*/
|
|
387
387
|
AssociatedResourceType?: WorkSpaceAssociatedResourceType;
|
|
388
388
|
/**
|
|
389
|
-
* @public
|
|
390
389
|
* <p>The time the association is created.</p>
|
|
390
|
+
* @public
|
|
391
391
|
*/
|
|
392
392
|
Created?: Date;
|
|
393
393
|
/**
|
|
394
|
-
* @public
|
|
395
394
|
* <p>The time the association status was last updated.</p>
|
|
395
|
+
* @public
|
|
396
396
|
*/
|
|
397
397
|
LastUpdatedTime?: Date;
|
|
398
398
|
/**
|
|
399
|
-
* @public
|
|
400
399
|
* <p>The status of the WorkSpace resource association.</p>
|
|
400
|
+
* @public
|
|
401
401
|
*/
|
|
402
402
|
State?: AssociationState;
|
|
403
403
|
/**
|
|
404
|
-
* @public
|
|
405
404
|
* <p>The reason the association deployment failed.</p>
|
|
405
|
+
* @public
|
|
406
406
|
*/
|
|
407
407
|
StateReason?: AssociationStateReason;
|
|
408
408
|
/**
|
|
409
|
-
* @public
|
|
410
409
|
* <p>The identifier of the WorkSpace.</p>
|
|
410
|
+
* @public
|
|
411
411
|
*/
|
|
412
412
|
WorkspaceId?: string;
|
|
413
413
|
}
|
|
@@ -416,14 +416,14 @@ export interface WorkspaceResourceAssociation {
|
|
|
416
416
|
*/
|
|
417
417
|
export interface AssociateWorkspaceApplicationResult {
|
|
418
418
|
/**
|
|
419
|
-
* @public
|
|
420
419
|
* <p>Information about the association between the specified WorkSpace and the specified application.</p>
|
|
420
|
+
* @public
|
|
421
421
|
*/
|
|
422
422
|
Association?: WorkspaceResourceAssociation;
|
|
423
423
|
}
|
|
424
424
|
/**
|
|
425
|
-
* @public
|
|
426
425
|
* <p>The compute type of the WorkSpace is not compatible with the application.</p>
|
|
426
|
+
* @public
|
|
427
427
|
*/
|
|
428
428
|
export declare class ComputeNotCompatibleException extends __BaseException {
|
|
429
429
|
readonly name: "ComputeNotCompatibleException";
|
|
@@ -434,8 +434,8 @@ export declare class ComputeNotCompatibleException extends __BaseException {
|
|
|
434
434
|
constructor(opts: __ExceptionOptionType<ComputeNotCompatibleException, __BaseException>);
|
|
435
435
|
}
|
|
436
436
|
/**
|
|
437
|
-
* @public
|
|
438
437
|
* <p>The specified application is not compatible with the resource.</p>
|
|
438
|
+
* @public
|
|
439
439
|
*/
|
|
440
440
|
export declare class IncompatibleApplicationsException extends __BaseException {
|
|
441
441
|
readonly name: "IncompatibleApplicationsException";
|
|
@@ -446,8 +446,8 @@ export declare class IncompatibleApplicationsException extends __BaseException {
|
|
|
446
446
|
constructor(opts: __ExceptionOptionType<IncompatibleApplicationsException, __BaseException>);
|
|
447
447
|
}
|
|
448
448
|
/**
|
|
449
|
-
* @public
|
|
450
449
|
* <p>The operating system of the WorkSpace is not compatible with the application.</p>
|
|
450
|
+
* @public
|
|
451
451
|
*/
|
|
452
452
|
export declare class OperatingSystemNotCompatibleException extends __BaseException {
|
|
453
453
|
readonly name: "OperatingSystemNotCompatibleException";
|
|
@@ -458,8 +458,8 @@ export declare class OperatingSystemNotCompatibleException extends __BaseExcepti
|
|
|
458
458
|
constructor(opts: __ExceptionOptionType<OperatingSystemNotCompatibleException, __BaseException>);
|
|
459
459
|
}
|
|
460
460
|
/**
|
|
461
|
-
* @public
|
|
462
461
|
* <p>The specified resource already exists.</p>
|
|
462
|
+
* @public
|
|
463
463
|
*/
|
|
464
464
|
export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
465
465
|
readonly name: "ResourceAlreadyExistsException";
|
|
@@ -470,15 +470,15 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
470
470
|
constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
|
|
471
471
|
}
|
|
472
472
|
/**
|
|
473
|
-
* @public
|
|
474
473
|
* <p>The specified resource is currently in use.</p>
|
|
474
|
+
* @public
|
|
475
475
|
*/
|
|
476
476
|
export declare class ResourceInUseException extends __BaseException {
|
|
477
477
|
readonly name: "ResourceInUseException";
|
|
478
478
|
readonly $fault: "client";
|
|
479
479
|
/**
|
|
480
|
-
* @public
|
|
481
480
|
* <p>The ID of the resource that is in use.</p>
|
|
481
|
+
* @public
|
|
482
482
|
*/
|
|
483
483
|
ResourceId?: string;
|
|
484
484
|
/**
|
|
@@ -502,18 +502,18 @@ export declare const AssociationStatus: {
|
|
|
502
502
|
*/
|
|
503
503
|
export type AssociationStatus = (typeof AssociationStatus)[keyof typeof AssociationStatus];
|
|
504
504
|
/**
|
|
505
|
-
* @public
|
|
506
505
|
* <p>Describes a rule for an IP access control group.</p>
|
|
506
|
+
* @public
|
|
507
507
|
*/
|
|
508
508
|
export interface IpRuleItem {
|
|
509
509
|
/**
|
|
510
|
-
* @public
|
|
511
510
|
* <p>The IP address range, in CIDR notation.</p>
|
|
511
|
+
* @public
|
|
512
512
|
*/
|
|
513
513
|
ipRule?: string;
|
|
514
514
|
/**
|
|
515
|
-
* @public
|
|
516
515
|
* <p>The description.</p>
|
|
516
|
+
* @public
|
|
517
517
|
*/
|
|
518
518
|
ruleDesc?: string;
|
|
519
519
|
}
|
|
@@ -522,13 +522,13 @@ export interface IpRuleItem {
|
|
|
522
522
|
*/
|
|
523
523
|
export interface AuthorizeIpRulesRequest {
|
|
524
524
|
/**
|
|
525
|
-
* @public
|
|
526
525
|
* <p>The identifier of the group.</p>
|
|
526
|
+
* @public
|
|
527
527
|
*/
|
|
528
528
|
GroupId: string | undefined;
|
|
529
529
|
/**
|
|
530
|
-
* @public
|
|
531
530
|
* <p>The rules to add to the group.</p>
|
|
531
|
+
* @public
|
|
532
532
|
*/
|
|
533
533
|
UserRules: IpRuleItem[] | undefined;
|
|
534
534
|
}
|
|
@@ -580,24 +580,24 @@ export declare const Compute: {
|
|
|
580
580
|
*/
|
|
581
581
|
export type Compute = (typeof Compute)[keyof typeof Compute];
|
|
582
582
|
/**
|
|
583
|
-
* @public
|
|
584
583
|
* <p>Describes the compute type of the bundle.</p>
|
|
584
|
+
* @public
|
|
585
585
|
*/
|
|
586
586
|
export interface ComputeType {
|
|
587
587
|
/**
|
|
588
|
-
* @public
|
|
589
588
|
* <p>The compute type.</p>
|
|
589
|
+
* @public
|
|
590
590
|
*/
|
|
591
591
|
Name?: Compute;
|
|
592
592
|
}
|
|
593
593
|
/**
|
|
594
|
-
* @public
|
|
595
594
|
* <p>Describes the root volume for a WorkSpace bundle.</p>
|
|
595
|
+
* @public
|
|
596
596
|
*/
|
|
597
597
|
export interface RootStorage {
|
|
598
598
|
/**
|
|
599
|
-
* @public
|
|
600
599
|
* <p>The size of the root volume.</p>
|
|
600
|
+
* @public
|
|
601
601
|
*/
|
|
602
602
|
Capacity?: string;
|
|
603
603
|
}
|
|
@@ -615,122 +615,122 @@ export declare const WorkspaceBundleState: {
|
|
|
615
615
|
*/
|
|
616
616
|
export type WorkspaceBundleState = (typeof WorkspaceBundleState)[keyof typeof WorkspaceBundleState];
|
|
617
617
|
/**
|
|
618
|
-
* @public
|
|
619
618
|
* <p>Describes the user volume for a WorkSpace bundle.</p>
|
|
619
|
+
* @public
|
|
620
620
|
*/
|
|
621
621
|
export interface UserStorage {
|
|
622
622
|
/**
|
|
623
|
-
* @public
|
|
624
623
|
* <p>The size of the user volume.</p>
|
|
624
|
+
* @public
|
|
625
625
|
*/
|
|
626
626
|
Capacity?: string;
|
|
627
627
|
}
|
|
628
628
|
/**
|
|
629
|
-
* @public
|
|
630
629
|
* <p>Describes a WorkSpace bundle.</p>
|
|
630
|
+
* @public
|
|
631
631
|
*/
|
|
632
632
|
export interface WorkspaceBundle {
|
|
633
633
|
/**
|
|
634
|
-
* @public
|
|
635
634
|
* <p>The identifier of the bundle.</p>
|
|
635
|
+
* @public
|
|
636
636
|
*/
|
|
637
637
|
BundleId?: string;
|
|
638
638
|
/**
|
|
639
|
-
* @public
|
|
640
639
|
* <p>The name of the bundle.</p>
|
|
640
|
+
* @public
|
|
641
641
|
*/
|
|
642
642
|
Name?: string;
|
|
643
643
|
/**
|
|
644
|
-
* @public
|
|
645
644
|
* <p>The owner of the bundle. This is the account identifier of the owner, or
|
|
646
645
|
* <code>AMAZON</code> if the bundle is provided by Amazon Web Services.</p>
|
|
646
|
+
* @public
|
|
647
647
|
*/
|
|
648
648
|
Owner?: string;
|
|
649
649
|
/**
|
|
650
|
-
* @public
|
|
651
650
|
* <p>The description of the bundle.</p>
|
|
651
|
+
* @public
|
|
652
652
|
*/
|
|
653
653
|
Description?: string;
|
|
654
654
|
/**
|
|
655
|
-
* @public
|
|
656
655
|
* <p>The identifier of the image that was used to create the bundle.</p>
|
|
656
|
+
* @public
|
|
657
657
|
*/
|
|
658
658
|
ImageId?: string;
|
|
659
659
|
/**
|
|
660
|
-
* @public
|
|
661
660
|
* <p>The size of the root volume.</p>
|
|
661
|
+
* @public
|
|
662
662
|
*/
|
|
663
663
|
RootStorage?: RootStorage;
|
|
664
664
|
/**
|
|
665
|
-
* @public
|
|
666
665
|
* <p>The size of the user volume.</p>
|
|
666
|
+
* @public
|
|
667
667
|
*/
|
|
668
668
|
UserStorage?: UserStorage;
|
|
669
669
|
/**
|
|
670
|
-
* @public
|
|
671
670
|
* <p>The compute type of the bundle. For more information, see
|
|
672
671
|
* <a href="http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles">Amazon WorkSpaces Bundles</a>.</p>
|
|
672
|
+
* @public
|
|
673
673
|
*/
|
|
674
674
|
ComputeType?: ComputeType;
|
|
675
675
|
/**
|
|
676
|
-
* @public
|
|
677
676
|
* <p>The last time that the bundle was updated.</p>
|
|
677
|
+
* @public
|
|
678
678
|
*/
|
|
679
679
|
LastUpdatedTime?: Date;
|
|
680
680
|
/**
|
|
681
|
-
* @public
|
|
682
681
|
* <p>The time when the bundle was created.</p>
|
|
682
|
+
* @public
|
|
683
683
|
*/
|
|
684
684
|
CreationTime?: Date;
|
|
685
685
|
/**
|
|
686
|
-
* @public
|
|
687
686
|
* <p>The state of the WorkSpace bundle.</p>
|
|
687
|
+
* @public
|
|
688
688
|
*/
|
|
689
689
|
State?: WorkspaceBundleState;
|
|
690
690
|
/**
|
|
691
|
-
* @public
|
|
692
691
|
* <p>The type of WorkSpace bundle.</p>
|
|
692
|
+
* @public
|
|
693
693
|
*/
|
|
694
694
|
BundleType?: BundleType;
|
|
695
695
|
}
|
|
696
696
|
/**
|
|
697
|
-
* @public
|
|
698
697
|
* <p>Describes the association between an application and a bundle resource.</p>
|
|
698
|
+
* @public
|
|
699
699
|
*/
|
|
700
700
|
export interface BundleResourceAssociation {
|
|
701
701
|
/**
|
|
702
|
-
* @public
|
|
703
702
|
* <p>The identifier of the associated resource.</p>
|
|
703
|
+
* @public
|
|
704
704
|
*/
|
|
705
705
|
AssociatedResourceId?: string;
|
|
706
706
|
/**
|
|
707
|
-
* @public
|
|
708
707
|
* <p>The resource type of the associated resources.</p>
|
|
708
|
+
* @public
|
|
709
709
|
*/
|
|
710
710
|
AssociatedResourceType?: BundleAssociatedResourceType;
|
|
711
711
|
/**
|
|
712
|
-
* @public
|
|
713
712
|
* <p>The identifier of the bundle.</p>
|
|
713
|
+
* @public
|
|
714
714
|
*/
|
|
715
715
|
BundleId?: string;
|
|
716
716
|
/**
|
|
717
|
-
* @public
|
|
718
717
|
* <p>The time the association is created.</p>
|
|
718
|
+
* @public
|
|
719
719
|
*/
|
|
720
720
|
Created?: Date;
|
|
721
721
|
/**
|
|
722
|
-
* @public
|
|
723
722
|
* <p>The time the association status was last updated.</p>
|
|
723
|
+
* @public
|
|
724
724
|
*/
|
|
725
725
|
LastUpdatedTime?: Date;
|
|
726
726
|
/**
|
|
727
|
-
* @public
|
|
728
727
|
* <p>The status of the bundle resource association.</p>
|
|
728
|
+
* @public
|
|
729
729
|
*/
|
|
730
730
|
State?: AssociationState;
|
|
731
731
|
/**
|
|
732
|
-
* @public
|
|
733
732
|
* <p>The reason the association deployment failed.</p>
|
|
733
|
+
* @public
|
|
734
734
|
*/
|
|
735
735
|
StateReason?: AssociationStateReason;
|
|
736
736
|
}
|
|
@@ -747,19 +747,19 @@ export declare const CertificateBasedAuthStatusEnum: {
|
|
|
747
747
|
*/
|
|
748
748
|
export type CertificateBasedAuthStatusEnum = (typeof CertificateBasedAuthStatusEnum)[keyof typeof CertificateBasedAuthStatusEnum];
|
|
749
749
|
/**
|
|
750
|
-
* @public
|
|
751
750
|
* <p>Describes the properties of the certificate-based authentication you want to use
|
|
752
751
|
* with your WorkSpaces.</p>
|
|
752
|
+
* @public
|
|
753
753
|
*/
|
|
754
754
|
export interface CertificateBasedAuthProperties {
|
|
755
755
|
/**
|
|
756
|
-
* @public
|
|
757
756
|
* <p>The status of the certificate-based authentication properties.</p>
|
|
757
|
+
* @public
|
|
758
758
|
*/
|
|
759
759
|
Status?: CertificateBasedAuthStatusEnum;
|
|
760
760
|
/**
|
|
761
|
-
* @public
|
|
762
761
|
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.</p>
|
|
762
|
+
* @public
|
|
763
763
|
*/
|
|
764
764
|
CertificateAuthorityArn?: string;
|
|
765
765
|
}
|
|
@@ -804,95 +804,95 @@ export declare const ReconnectEnum: {
|
|
|
804
804
|
*/
|
|
805
805
|
export type ReconnectEnum = (typeof ReconnectEnum)[keyof typeof ReconnectEnum];
|
|
806
806
|
/**
|
|
807
|
-
* @public
|
|
808
807
|
* <p>Describes an Amazon WorkSpaces client.</p>
|
|
808
|
+
* @public
|
|
809
809
|
*/
|
|
810
810
|
export interface ClientProperties {
|
|
811
811
|
/**
|
|
812
|
-
* @public
|
|
813
812
|
* <p>Specifies whether users can cache their credentials on the Amazon WorkSpaces client.
|
|
814
813
|
* When enabled, users can choose to reconnect to their WorkSpaces without re-entering their
|
|
815
814
|
* credentials. </p>
|
|
815
|
+
* @public
|
|
816
816
|
*/
|
|
817
817
|
ReconnectEnabled?: ReconnectEnum;
|
|
818
818
|
/**
|
|
819
|
-
* @public
|
|
820
819
|
* <p>Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to
|
|
821
820
|
* WorkSpaces to troubleshoot issues when using the WorkSpaces client.
|
|
822
821
|
* When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all
|
|
823
822
|
* users in the specified directory.</p>
|
|
823
|
+
* @public
|
|
824
824
|
*/
|
|
825
825
|
LogUploadEnabled?: LogUploadEnum;
|
|
826
826
|
}
|
|
827
827
|
/**
|
|
828
|
-
* @public
|
|
829
828
|
* <p>Information about the Amazon WorkSpaces client.</p>
|
|
829
|
+
* @public
|
|
830
830
|
*/
|
|
831
831
|
export interface ClientPropertiesResult {
|
|
832
832
|
/**
|
|
833
|
-
* @public
|
|
834
833
|
* <p>The resource identifier, in the form of a directory ID.</p>
|
|
834
|
+
* @public
|
|
835
835
|
*/
|
|
836
836
|
ResourceId?: string;
|
|
837
837
|
/**
|
|
838
|
-
* @public
|
|
839
838
|
* <p>Information about the Amazon WorkSpaces client.</p>
|
|
839
|
+
* @public
|
|
840
840
|
*/
|
|
841
841
|
ClientProperties?: ClientProperties;
|
|
842
842
|
}
|
|
843
843
|
/**
|
|
844
|
-
* @public
|
|
845
844
|
* <p>Describes an Amazon Connect client add-in.</p>
|
|
845
|
+
* @public
|
|
846
846
|
*/
|
|
847
847
|
export interface ConnectClientAddIn {
|
|
848
848
|
/**
|
|
849
|
-
* @public
|
|
850
849
|
* <p>The client add-in identifier.</p>
|
|
850
|
+
* @public
|
|
851
851
|
*/
|
|
852
852
|
AddInId?: string;
|
|
853
853
|
/**
|
|
854
|
-
* @public
|
|
855
854
|
* <p>The directory identifier for which the client add-in is configured.</p>
|
|
855
|
+
* @public
|
|
856
856
|
*/
|
|
857
857
|
ResourceId?: string;
|
|
858
858
|
/**
|
|
859
|
-
* @public
|
|
860
859
|
* <p>The name of the client add in.</p>
|
|
860
|
+
* @public
|
|
861
861
|
*/
|
|
862
862
|
Name?: string;
|
|
863
863
|
/**
|
|
864
|
-
* @public
|
|
865
864
|
* <p>The endpoint URL of the client add-in.</p>
|
|
865
|
+
* @public
|
|
866
866
|
*/
|
|
867
867
|
URL?: string;
|
|
868
868
|
}
|
|
869
869
|
/**
|
|
870
|
-
* @public
|
|
871
870
|
* <p>Describes a connection alias association that is used for cross-Region redirection. For
|
|
872
871
|
* more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
873
872
|
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
873
|
+
* @public
|
|
874
874
|
*/
|
|
875
875
|
export interface ConnectionAliasAssociation {
|
|
876
876
|
/**
|
|
877
|
-
* @public
|
|
878
877
|
* <p>The association status of the connection alias.</p>
|
|
878
|
+
* @public
|
|
879
879
|
*/
|
|
880
880
|
AssociationStatus?: AssociationStatus;
|
|
881
881
|
/**
|
|
882
|
-
* @public
|
|
883
882
|
* <p>The identifier of the Amazon Web Services account that associated the connection alias
|
|
884
883
|
* with a directory.</p>
|
|
884
|
+
* @public
|
|
885
885
|
*/
|
|
886
886
|
AssociatedAccountId?: string;
|
|
887
887
|
/**
|
|
888
|
-
* @public
|
|
889
888
|
* <p>The identifier of the directory associated with a connection alias.</p>
|
|
889
|
+
* @public
|
|
890
890
|
*/
|
|
891
891
|
ResourceId?: string;
|
|
892
892
|
/**
|
|
893
|
-
* @public
|
|
894
893
|
* <p>The identifier of the connection alias association. You use the connection identifier in
|
|
895
894
|
* the DNS TXT record when you're configuring your DNS routing policies.</p>
|
|
895
|
+
* @public
|
|
896
896
|
*/
|
|
897
897
|
ConnectionIdentifier?: string;
|
|
898
898
|
}
|
|
@@ -910,57 +910,57 @@ export declare const ConnectionAliasState: {
|
|
|
910
910
|
*/
|
|
911
911
|
export type ConnectionAliasState = (typeof ConnectionAliasState)[keyof typeof ConnectionAliasState];
|
|
912
912
|
/**
|
|
913
|
-
* @public
|
|
914
913
|
* <p>Describes a connection alias. Connection aliases are used for cross-Region redirection.
|
|
915
914
|
* For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
916
915
|
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
916
|
+
* @public
|
|
917
917
|
*/
|
|
918
918
|
export interface ConnectionAlias {
|
|
919
919
|
/**
|
|
920
|
-
* @public
|
|
921
920
|
* <p>The connection string specified for the connection alias. The connection string must be
|
|
922
921
|
* in the form of a fully qualified domain name (FQDN), such as
|
|
923
922
|
* <code>www.example.com</code>.</p>
|
|
923
|
+
* @public
|
|
924
924
|
*/
|
|
925
925
|
ConnectionString?: string;
|
|
926
926
|
/**
|
|
927
|
-
* @public
|
|
928
927
|
* <p>The identifier of the connection alias.</p>
|
|
928
|
+
* @public
|
|
929
929
|
*/
|
|
930
930
|
AliasId?: string;
|
|
931
931
|
/**
|
|
932
|
-
* @public
|
|
933
932
|
* <p>The current state of the connection alias.</p>
|
|
933
|
+
* @public
|
|
934
934
|
*/
|
|
935
935
|
State?: ConnectionAliasState;
|
|
936
936
|
/**
|
|
937
|
-
* @public
|
|
938
937
|
* <p>The identifier of the Amazon Web Services account that owns the connection alias.</p>
|
|
938
|
+
* @public
|
|
939
939
|
*/
|
|
940
940
|
OwnerAccountId?: string;
|
|
941
941
|
/**
|
|
942
|
-
* @public
|
|
943
942
|
* <p>The association status of the connection alias.</p>
|
|
943
|
+
* @public
|
|
944
944
|
*/
|
|
945
945
|
Associations?: ConnectionAliasAssociation[];
|
|
946
946
|
}
|
|
947
947
|
/**
|
|
948
|
-
* @public
|
|
949
948
|
* <p>Describes the permissions for a connection alias. Connection aliases are used for
|
|
950
949
|
* cross-Region redirection. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region
|
|
951
950
|
* Redirection for Amazon WorkSpaces</a>.</p>
|
|
951
|
+
* @public
|
|
952
952
|
*/
|
|
953
953
|
export interface ConnectionAliasPermission {
|
|
954
954
|
/**
|
|
955
|
-
* @public
|
|
956
955
|
* <p>The identifier of the Amazon Web Services account that the connection alias is shared
|
|
957
956
|
* with.</p>
|
|
957
|
+
* @public
|
|
958
958
|
*/
|
|
959
959
|
SharedAccountId: string | undefined;
|
|
960
960
|
/**
|
|
961
|
-
* @public
|
|
962
961
|
* <p>Indicates whether the specified Amazon Web Services account is allowed to associate the
|
|
963
962
|
* connection alias with a directory.</p>
|
|
963
|
+
* @public
|
|
964
964
|
*/
|
|
965
965
|
AllowAssociation: boolean | undefined;
|
|
966
966
|
}
|
|
@@ -978,18 +978,18 @@ export declare const ConnectionState: {
|
|
|
978
978
|
*/
|
|
979
979
|
export type ConnectionState = (typeof ConnectionState)[keyof typeof ConnectionState];
|
|
980
980
|
/**
|
|
981
|
-
* @public
|
|
982
981
|
* <p>Describes a tag.</p>
|
|
982
|
+
* @public
|
|
983
983
|
*/
|
|
984
984
|
export interface Tag {
|
|
985
985
|
/**
|
|
986
|
-
* @public
|
|
987
986
|
* <p>The key of the tag.</p>
|
|
987
|
+
* @public
|
|
988
988
|
*/
|
|
989
989
|
Key: string | undefined;
|
|
990
990
|
/**
|
|
991
|
-
* @public
|
|
992
991
|
* <p>The value of the tag.</p>
|
|
992
|
+
* @public
|
|
993
993
|
*/
|
|
994
994
|
Value?: string;
|
|
995
995
|
}
|
|
@@ -998,28 +998,28 @@ export interface Tag {
|
|
|
998
998
|
*/
|
|
999
999
|
export interface CopyWorkspaceImageRequest {
|
|
1000
1000
|
/**
|
|
1001
|
-
* @public
|
|
1002
1001
|
* <p>The name of the image.</p>
|
|
1002
|
+
* @public
|
|
1003
1003
|
*/
|
|
1004
1004
|
Name: string | undefined;
|
|
1005
1005
|
/**
|
|
1006
|
-
* @public
|
|
1007
1006
|
* <p>A description of the image.</p>
|
|
1007
|
+
* @public
|
|
1008
1008
|
*/
|
|
1009
1009
|
Description?: string;
|
|
1010
1010
|
/**
|
|
1011
|
-
* @public
|
|
1012
1011
|
* <p>The identifier of the source image.</p>
|
|
1012
|
+
* @public
|
|
1013
1013
|
*/
|
|
1014
1014
|
SourceImageId: string | undefined;
|
|
1015
1015
|
/**
|
|
1016
|
-
* @public
|
|
1017
1016
|
* <p>The identifier of the source Region.</p>
|
|
1017
|
+
* @public
|
|
1018
1018
|
*/
|
|
1019
1019
|
SourceRegion: string | undefined;
|
|
1020
1020
|
/**
|
|
1021
|
-
* @public
|
|
1022
1021
|
* <p>The tags for the image.</p>
|
|
1022
|
+
* @public
|
|
1023
1023
|
*/
|
|
1024
1024
|
Tags?: Tag[];
|
|
1025
1025
|
}
|
|
@@ -1028,21 +1028,21 @@ export interface CopyWorkspaceImageRequest {
|
|
|
1028
1028
|
*/
|
|
1029
1029
|
export interface CopyWorkspaceImageResult {
|
|
1030
1030
|
/**
|
|
1031
|
-
* @public
|
|
1032
1031
|
* <p>The identifier of the image.</p>
|
|
1032
|
+
* @public
|
|
1033
1033
|
*/
|
|
1034
1034
|
ImageId?: string;
|
|
1035
1035
|
}
|
|
1036
1036
|
/**
|
|
1037
|
-
* @public
|
|
1038
1037
|
* <p>The specified resource is not available.</p>
|
|
1038
|
+
* @public
|
|
1039
1039
|
*/
|
|
1040
1040
|
export declare class ResourceUnavailableException extends __BaseException {
|
|
1041
1041
|
readonly name: "ResourceUnavailableException";
|
|
1042
1042
|
readonly $fault: "client";
|
|
1043
1043
|
/**
|
|
1044
|
-
* @public
|
|
1045
1044
|
* <p>The identifier of the resource that is not available.</p>
|
|
1045
|
+
* @public
|
|
1046
1046
|
*/
|
|
1047
1047
|
ResourceId?: string;
|
|
1048
1048
|
/**
|
|
@@ -1055,18 +1055,18 @@ export declare class ResourceUnavailableException extends __BaseException {
|
|
|
1055
1055
|
*/
|
|
1056
1056
|
export interface CreateConnectClientAddInRequest {
|
|
1057
1057
|
/**
|
|
1058
|
-
* @public
|
|
1059
1058
|
* <p>The directory identifier for which to configure the client add-in.</p>
|
|
1059
|
+
* @public
|
|
1060
1060
|
*/
|
|
1061
1061
|
ResourceId: string | undefined;
|
|
1062
1062
|
/**
|
|
1063
|
-
* @public
|
|
1064
1063
|
* <p>The name of the client add-in.</p>
|
|
1064
|
+
* @public
|
|
1065
1065
|
*/
|
|
1066
1066
|
Name: string | undefined;
|
|
1067
1067
|
/**
|
|
1068
|
-
* @public
|
|
1069
1068
|
* <p>The endpoint URL of the Amazon Connect client add-in.</p>
|
|
1069
|
+
* @public
|
|
1070
1070
|
*/
|
|
1071
1071
|
URL: string | undefined;
|
|
1072
1072
|
}
|
|
@@ -1075,14 +1075,14 @@ export interface CreateConnectClientAddInRequest {
|
|
|
1075
1075
|
*/
|
|
1076
1076
|
export interface CreateConnectClientAddInResult {
|
|
1077
1077
|
/**
|
|
1078
|
-
* @public
|
|
1079
1078
|
* <p>The client add-in identifier.</p>
|
|
1079
|
+
* @public
|
|
1080
1080
|
*/
|
|
1081
1081
|
AddInId?: string;
|
|
1082
1082
|
}
|
|
1083
1083
|
/**
|
|
1084
|
-
* @public
|
|
1085
1084
|
* <p>The resource could not be created.</p>
|
|
1085
|
+
* @public
|
|
1086
1086
|
*/
|
|
1087
1087
|
export declare class ResourceCreationFailedException extends __BaseException {
|
|
1088
1088
|
readonly name: "ResourceCreationFailedException";
|
|
@@ -1097,7 +1097,6 @@ export declare class ResourceCreationFailedException extends __BaseException {
|
|
|
1097
1097
|
*/
|
|
1098
1098
|
export interface CreateConnectionAliasRequest {
|
|
1099
1099
|
/**
|
|
1100
|
-
* @public
|
|
1101
1100
|
* <p>A connection string in the form of a fully qualified domain name (FQDN), such as
|
|
1102
1101
|
* <code>www.example.com</code>.</p>
|
|
1103
1102
|
* <important>
|
|
@@ -1105,11 +1104,12 @@ export interface CreateConnectionAliasRequest {
|
|
|
1105
1104
|
* account, even if you delete all instances of it from the original account. The
|
|
1106
1105
|
* connection string is globally reserved for your account.</p>
|
|
1107
1106
|
* </important>
|
|
1107
|
+
* @public
|
|
1108
1108
|
*/
|
|
1109
1109
|
ConnectionString: string | undefined;
|
|
1110
1110
|
/**
|
|
1111
|
-
* @public
|
|
1112
1111
|
* <p>The tags to associate with the connection alias.</p>
|
|
1112
|
+
* @public
|
|
1113
1113
|
*/
|
|
1114
1114
|
Tags?: Tag[];
|
|
1115
1115
|
}
|
|
@@ -1118,8 +1118,8 @@ export interface CreateConnectionAliasRequest {
|
|
|
1118
1118
|
*/
|
|
1119
1119
|
export interface CreateConnectionAliasResult {
|
|
1120
1120
|
/**
|
|
1121
|
-
* @public
|
|
1122
1121
|
* <p>The identifier of the connection alias.</p>
|
|
1122
|
+
* @public
|
|
1123
1123
|
*/
|
|
1124
1124
|
AliasId?: string;
|
|
1125
1125
|
}
|
|
@@ -1128,23 +1128,23 @@ export interface CreateConnectionAliasResult {
|
|
|
1128
1128
|
*/
|
|
1129
1129
|
export interface CreateIpGroupRequest {
|
|
1130
1130
|
/**
|
|
1131
|
-
* @public
|
|
1132
1131
|
* <p>The name of the group.</p>
|
|
1132
|
+
* @public
|
|
1133
1133
|
*/
|
|
1134
1134
|
GroupName: string | undefined;
|
|
1135
1135
|
/**
|
|
1136
|
-
* @public
|
|
1137
1136
|
* <p>The description of the group.</p>
|
|
1137
|
+
* @public
|
|
1138
1138
|
*/
|
|
1139
1139
|
GroupDesc?: string;
|
|
1140
1140
|
/**
|
|
1141
|
-
* @public
|
|
1142
1141
|
* <p>The rules to add to the group.</p>
|
|
1142
|
+
* @public
|
|
1143
1143
|
*/
|
|
1144
1144
|
UserRules?: IpRuleItem[];
|
|
1145
1145
|
/**
|
|
1146
|
-
* @public
|
|
1147
1146
|
* <p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>
|
|
1147
|
+
* @public
|
|
1148
1148
|
*/
|
|
1149
1149
|
Tags?: Tag[];
|
|
1150
1150
|
}
|
|
@@ -1153,8 +1153,8 @@ export interface CreateIpGroupRequest {
|
|
|
1153
1153
|
*/
|
|
1154
1154
|
export interface CreateIpGroupResult {
|
|
1155
1155
|
/**
|
|
1156
|
-
* @public
|
|
1157
1156
|
* <p>The identifier of the group.</p>
|
|
1157
|
+
* @public
|
|
1158
1158
|
*/
|
|
1159
1159
|
GroupId?: string;
|
|
1160
1160
|
}
|
|
@@ -1171,33 +1171,33 @@ export declare const DataReplication: {
|
|
|
1171
1171
|
*/
|
|
1172
1172
|
export type DataReplication = (typeof DataReplication)[keyof typeof DataReplication];
|
|
1173
1173
|
/**
|
|
1174
|
-
* @public
|
|
1175
1174
|
* <p>Describes a standby WorkSpace.</p>
|
|
1175
|
+
* @public
|
|
1176
1176
|
*/
|
|
1177
1177
|
export interface StandbyWorkspace {
|
|
1178
1178
|
/**
|
|
1179
|
-
* @public
|
|
1180
1179
|
* <p>The identifier of the standby WorkSpace.</p>
|
|
1180
|
+
* @public
|
|
1181
1181
|
*/
|
|
1182
1182
|
PrimaryWorkspaceId: string | undefined;
|
|
1183
1183
|
/**
|
|
1184
|
-
* @public
|
|
1185
1184
|
* <p>The volume encryption key of the standby WorkSpace.</p>
|
|
1185
|
+
* @public
|
|
1186
1186
|
*/
|
|
1187
1187
|
VolumeEncryptionKey?: string;
|
|
1188
1188
|
/**
|
|
1189
|
-
* @public
|
|
1190
1189
|
* <p>The identifier of the directory for the standby WorkSpace.</p>
|
|
1190
|
+
* @public
|
|
1191
1191
|
*/
|
|
1192
1192
|
DirectoryId: string | undefined;
|
|
1193
1193
|
/**
|
|
1194
|
-
* @public
|
|
1195
1194
|
* <p>The tags associated with the standby WorkSpace.</p>
|
|
1195
|
+
* @public
|
|
1196
1196
|
*/
|
|
1197
1197
|
Tags?: Tag[];
|
|
1198
1198
|
/**
|
|
1199
|
-
* @public
|
|
1200
1199
|
* <p>Indicates whether data replication is enabled, and if enabled, the type of data replication.</p>
|
|
1200
|
+
* @public
|
|
1201
1201
|
*/
|
|
1202
1202
|
DataReplication?: DataReplication;
|
|
1203
1203
|
}
|
|
@@ -1206,34 +1206,34 @@ export interface StandbyWorkspace {
|
|
|
1206
1206
|
*/
|
|
1207
1207
|
export interface CreateStandbyWorkspacesRequest {
|
|
1208
1208
|
/**
|
|
1209
|
-
* @public
|
|
1210
1209
|
* <p>The Region of the primary WorkSpace.</p>
|
|
1210
|
+
* @public
|
|
1211
1211
|
*/
|
|
1212
1212
|
PrimaryRegion: string | undefined;
|
|
1213
1213
|
/**
|
|
1214
|
-
* @public
|
|
1215
1214
|
* <p>Information about the standby WorkSpace to be created.</p>
|
|
1215
|
+
* @public
|
|
1216
1216
|
*/
|
|
1217
1217
|
StandbyWorkspaces: StandbyWorkspace[] | undefined;
|
|
1218
1218
|
}
|
|
1219
1219
|
/**
|
|
1220
|
-
* @public
|
|
1221
1220
|
* <p>Describes the standby WorkSpace that could not be created.</p>
|
|
1221
|
+
* @public
|
|
1222
1222
|
*/
|
|
1223
1223
|
export interface FailedCreateStandbyWorkspacesRequest {
|
|
1224
1224
|
/**
|
|
1225
|
-
* @public
|
|
1226
1225
|
* <p>Information about the standby WorkSpace that could not be created.</p>
|
|
1226
|
+
* @public
|
|
1227
1227
|
*/
|
|
1228
1228
|
StandbyWorkspaceRequest?: StandbyWorkspace;
|
|
1229
1229
|
/**
|
|
1230
|
-
* @public
|
|
1231
1230
|
* <p>The error code that is returned if the standby WorkSpace could not be created.</p>
|
|
1231
|
+
* @public
|
|
1232
1232
|
*/
|
|
1233
1233
|
ErrorCode?: string;
|
|
1234
1234
|
/**
|
|
1235
|
-
* @public
|
|
1236
1235
|
* <p>The text of the error message that is returned if the standby WorkSpace could not be created.</p>
|
|
1236
|
+
* @public
|
|
1237
1237
|
*/
|
|
1238
1238
|
ErrorMessage?: string;
|
|
1239
1239
|
}
|
|
@@ -1265,33 +1265,33 @@ export declare const WorkspaceState: {
|
|
|
1265
1265
|
*/
|
|
1266
1266
|
export type WorkspaceState = (typeof WorkspaceState)[keyof typeof WorkspaceState];
|
|
1267
1267
|
/**
|
|
1268
|
-
* @public
|
|
1269
1268
|
* <p>Information about the standby WorkSpace.</p>
|
|
1269
|
+
* @public
|
|
1270
1270
|
*/
|
|
1271
1271
|
export interface PendingCreateStandbyWorkspacesRequest {
|
|
1272
1272
|
/**
|
|
1273
|
-
* @public
|
|
1274
1273
|
* <p>Describes the standby WorkSpace that was created.</p>
|
|
1275
1274
|
* <p>Because this operation is asynchronous, the identifier returned is not immediately
|
|
1276
1275
|
* available for use with other operations. For example, if you call
|
|
1277
1276
|
* <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html">
|
|
1278
1277
|
* DescribeWorkspaces</a>
|
|
1279
1278
|
* before the WorkSpace is created, the information returned can be incomplete. </p>
|
|
1279
|
+
* @public
|
|
1280
1280
|
*/
|
|
1281
1281
|
UserName?: string;
|
|
1282
1282
|
/**
|
|
1283
|
-
* @public
|
|
1284
1283
|
* <p>The identifier of the directory for the standby WorkSpace.</p>
|
|
1284
|
+
* @public
|
|
1285
1285
|
*/
|
|
1286
1286
|
DirectoryId?: string;
|
|
1287
1287
|
/**
|
|
1288
|
-
* @public
|
|
1289
1288
|
* <p>The operational state of the standby WorkSpace.</p>
|
|
1289
|
+
* @public
|
|
1290
1290
|
*/
|
|
1291
1291
|
State?: WorkspaceState;
|
|
1292
1292
|
/**
|
|
1293
|
-
* @public
|
|
1294
1293
|
* <p>The identifier of the standby WorkSpace.</p>
|
|
1294
|
+
* @public
|
|
1295
1295
|
*/
|
|
1296
1296
|
WorkspaceId?: string;
|
|
1297
1297
|
}
|
|
@@ -1300,13 +1300,13 @@ export interface PendingCreateStandbyWorkspacesRequest {
|
|
|
1300
1300
|
*/
|
|
1301
1301
|
export interface CreateStandbyWorkspacesResult {
|
|
1302
1302
|
/**
|
|
1303
|
-
* @public
|
|
1304
1303
|
* <p>Information about the standby WorkSpace that could not be created. </p>
|
|
1304
|
+
* @public
|
|
1305
1305
|
*/
|
|
1306
1306
|
FailedStandbyRequests?: FailedCreateStandbyWorkspacesRequest[];
|
|
1307
1307
|
/**
|
|
1308
|
-
* @public
|
|
1309
1308
|
* <p>Information about the standby WorkSpace that was created.</p>
|
|
1309
|
+
* @public
|
|
1310
1310
|
*/
|
|
1311
1311
|
PendingStandbyRequests?: PendingCreateStandbyWorkspacesRequest[];
|
|
1312
1312
|
}
|
|
@@ -1315,15 +1315,15 @@ export interface CreateStandbyWorkspacesResult {
|
|
|
1315
1315
|
*/
|
|
1316
1316
|
export interface CreateTagsRequest {
|
|
1317
1317
|
/**
|
|
1318
|
-
* @public
|
|
1319
1318
|
* <p>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,
|
|
1320
1319
|
* registered directories, images, custom bundles, IP access control groups, and connection
|
|
1321
1320
|
* aliases.</p>
|
|
1321
|
+
* @public
|
|
1322
1322
|
*/
|
|
1323
1323
|
ResourceId: string | undefined;
|
|
1324
1324
|
/**
|
|
1325
|
-
* @public
|
|
1326
1325
|
* <p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>
|
|
1326
|
+
* @public
|
|
1327
1327
|
*/
|
|
1328
1328
|
Tags: Tag[] | undefined;
|
|
1329
1329
|
}
|
|
@@ -1337,28 +1337,28 @@ export interface CreateTagsResult {
|
|
|
1337
1337
|
*/
|
|
1338
1338
|
export interface CreateUpdatedWorkspaceImageRequest {
|
|
1339
1339
|
/**
|
|
1340
|
-
* @public
|
|
1341
1340
|
* <p>The name of the new updated WorkSpace image.</p>
|
|
1341
|
+
* @public
|
|
1342
1342
|
*/
|
|
1343
1343
|
Name: string | undefined;
|
|
1344
1344
|
/**
|
|
1345
|
-
* @public
|
|
1346
1345
|
* <p>A description of whether updates for the WorkSpace image are available.</p>
|
|
1346
|
+
* @public
|
|
1347
1347
|
*/
|
|
1348
1348
|
Description: string | undefined;
|
|
1349
1349
|
/**
|
|
1350
|
-
* @public
|
|
1351
1350
|
* <p>The identifier of the source WorkSpace image.</p>
|
|
1351
|
+
* @public
|
|
1352
1352
|
*/
|
|
1353
1353
|
SourceImageId: string | undefined;
|
|
1354
1354
|
/**
|
|
1355
|
-
* @public
|
|
1356
1355
|
* <p>The tags that you want to add to the new updated WorkSpace image.</p>
|
|
1357
1356
|
* <note>
|
|
1358
1357
|
* <p>To add tags at the same time when you're creating the updated image, you must create
|
|
1359
1358
|
* an IAM policy that grants your IAM user permissions to use
|
|
1360
1359
|
* <code>workspaces:CreateTags</code>. </p>
|
|
1361
1360
|
* </note>
|
|
1361
|
+
* @public
|
|
1362
1362
|
*/
|
|
1363
1363
|
Tags?: Tag[];
|
|
1364
1364
|
}
|
|
@@ -1367,8 +1367,8 @@ export interface CreateUpdatedWorkspaceImageRequest {
|
|
|
1367
1367
|
*/
|
|
1368
1368
|
export interface CreateUpdatedWorkspaceImageResult {
|
|
1369
1369
|
/**
|
|
1370
|
-
* @public
|
|
1371
1370
|
* <p>The identifier of the new updated WorkSpace image.</p>
|
|
1371
|
+
* @public
|
|
1372
1372
|
*/
|
|
1373
1373
|
ImageId?: string;
|
|
1374
1374
|
}
|
|
@@ -1377,42 +1377,42 @@ export interface CreateUpdatedWorkspaceImageResult {
|
|
|
1377
1377
|
*/
|
|
1378
1378
|
export interface CreateWorkspaceBundleRequest {
|
|
1379
1379
|
/**
|
|
1380
|
-
* @public
|
|
1381
1380
|
* <p>The name of the bundle.</p>
|
|
1381
|
+
* @public
|
|
1382
1382
|
*/
|
|
1383
1383
|
BundleName: string | undefined;
|
|
1384
1384
|
/**
|
|
1385
|
-
* @public
|
|
1386
1385
|
* <p>The description of the bundle.</p>
|
|
1386
|
+
* @public
|
|
1387
1387
|
*/
|
|
1388
1388
|
BundleDescription: string | undefined;
|
|
1389
1389
|
/**
|
|
1390
|
-
* @public
|
|
1391
1390
|
* <p>The identifier of the image that is used to create the bundle.</p>
|
|
1391
|
+
* @public
|
|
1392
1392
|
*/
|
|
1393
1393
|
ImageId: string | undefined;
|
|
1394
1394
|
/**
|
|
1395
|
-
* @public
|
|
1396
1395
|
* <p>Describes the compute type of the bundle.</p>
|
|
1396
|
+
* @public
|
|
1397
1397
|
*/
|
|
1398
1398
|
ComputeType: ComputeType | undefined;
|
|
1399
1399
|
/**
|
|
1400
|
-
* @public
|
|
1401
1400
|
* <p>Describes the user volume for a WorkSpace bundle.</p>
|
|
1401
|
+
* @public
|
|
1402
1402
|
*/
|
|
1403
1403
|
UserStorage: UserStorage | undefined;
|
|
1404
1404
|
/**
|
|
1405
|
-
* @public
|
|
1406
1405
|
* <p>Describes the root volume for a WorkSpace bundle.</p>
|
|
1406
|
+
* @public
|
|
1407
1407
|
*/
|
|
1408
1408
|
RootStorage?: RootStorage;
|
|
1409
1409
|
/**
|
|
1410
|
-
* @public
|
|
1411
1410
|
* <p>The tags associated with the bundle.</p>
|
|
1412
1411
|
* <note>
|
|
1413
1412
|
* <p>To add tags at the same time when you're creating the bundle, you must create an IAM policy that
|
|
1414
1413
|
* grants your IAM user permissions to use <code>workspaces:CreateTags</code>. </p>
|
|
1415
1414
|
* </note>
|
|
1415
|
+
* @public
|
|
1416
1416
|
*/
|
|
1417
1417
|
Tags?: Tag[];
|
|
1418
1418
|
}
|
|
@@ -1421,8 +1421,8 @@ export interface CreateWorkspaceBundleRequest {
|
|
|
1421
1421
|
*/
|
|
1422
1422
|
export interface CreateWorkspaceBundleResult {
|
|
1423
1423
|
/**
|
|
1424
|
-
* @public
|
|
1425
1424
|
* <p>Describes a WorkSpace bundle.</p>
|
|
1425
|
+
* @public
|
|
1426
1426
|
*/
|
|
1427
1427
|
WorkspaceBundle?: WorkspaceBundle;
|
|
1428
1428
|
}
|
|
@@ -1431,25 +1431,25 @@ export interface CreateWorkspaceBundleResult {
|
|
|
1431
1431
|
*/
|
|
1432
1432
|
export interface CreateWorkspaceImageRequest {
|
|
1433
1433
|
/**
|
|
1434
|
-
* @public
|
|
1435
1434
|
* <p>The name of the new WorkSpace image.</p>
|
|
1435
|
+
* @public
|
|
1436
1436
|
*/
|
|
1437
1437
|
Name: string | undefined;
|
|
1438
1438
|
/**
|
|
1439
|
-
* @public
|
|
1440
1439
|
* <p>The description of the new WorkSpace image.</p>
|
|
1440
|
+
* @public
|
|
1441
1441
|
*/
|
|
1442
1442
|
Description: string | undefined;
|
|
1443
1443
|
/**
|
|
1444
|
-
* @public
|
|
1445
1444
|
* <p>The identifier of the source WorkSpace</p>
|
|
1445
|
+
* @public
|
|
1446
1446
|
*/
|
|
1447
1447
|
WorkspaceId: string | undefined;
|
|
1448
1448
|
/**
|
|
1449
|
-
* @public
|
|
1450
1449
|
* <p>The tags that you want to add to the new WorkSpace image.
|
|
1451
1450
|
* To add tags when you're creating the image, you must create an IAM policy that grants
|
|
1452
1451
|
* your IAM user permission to use <code>workspaces:CreateTags</code>.</p>
|
|
1452
|
+
* @public
|
|
1453
1453
|
*/
|
|
1454
1454
|
Tags?: Tag[];
|
|
1455
1455
|
}
|
|
@@ -1466,13 +1466,13 @@ export declare const OperatingSystemType: {
|
|
|
1466
1466
|
*/
|
|
1467
1467
|
export type OperatingSystemType = (typeof OperatingSystemType)[keyof typeof OperatingSystemType];
|
|
1468
1468
|
/**
|
|
1469
|
-
* @public
|
|
1470
1469
|
* <p>The operating system that the image is running.</p>
|
|
1470
|
+
* @public
|
|
1471
1471
|
*/
|
|
1472
1472
|
export interface OperatingSystem {
|
|
1473
1473
|
/**
|
|
1474
|
-
* @public
|
|
1475
1474
|
* <p>The operating system.</p>
|
|
1475
|
+
* @public
|
|
1476
1476
|
*/
|
|
1477
1477
|
Type?: OperatingSystemType;
|
|
1478
1478
|
}
|
|
@@ -1506,47 +1506,47 @@ export type WorkspaceImageState = (typeof WorkspaceImageState)[keyof typeof Work
|
|
|
1506
1506
|
*/
|
|
1507
1507
|
export interface CreateWorkspaceImageResult {
|
|
1508
1508
|
/**
|
|
1509
|
-
* @public
|
|
1510
1509
|
* <p>The identifier of the new WorkSpace image.</p>
|
|
1510
|
+
* @public
|
|
1511
1511
|
*/
|
|
1512
1512
|
ImageId?: string;
|
|
1513
1513
|
/**
|
|
1514
|
-
* @public
|
|
1515
1514
|
* <p>The name of the image.</p>
|
|
1515
|
+
* @public
|
|
1516
1516
|
*/
|
|
1517
1517
|
Name?: string;
|
|
1518
1518
|
/**
|
|
1519
|
-
* @public
|
|
1520
1519
|
* <p>The description of the image.</p>
|
|
1520
|
+
* @public
|
|
1521
1521
|
*/
|
|
1522
1522
|
Description?: string;
|
|
1523
1523
|
/**
|
|
1524
|
-
* @public
|
|
1525
1524
|
* <p>The operating system that the image is running.</p>
|
|
1525
|
+
* @public
|
|
1526
1526
|
*/
|
|
1527
1527
|
OperatingSystem?: OperatingSystem;
|
|
1528
1528
|
/**
|
|
1529
|
-
* @public
|
|
1530
1529
|
* <p>The availability status of the image.</p>
|
|
1530
|
+
* @public
|
|
1531
1531
|
*/
|
|
1532
1532
|
State?: WorkspaceImageState;
|
|
1533
1533
|
/**
|
|
1534
|
-
* @public
|
|
1535
1534
|
* <p>Specifies whether the image is running on dedicated hardware.
|
|
1536
1535
|
* When Bring Your Own License (BYOL) is enabled, this value is set
|
|
1537
1536
|
* to DEDICATED. For more information, see
|
|
1538
1537
|
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.htm">
|
|
1539
1538
|
* Bring Your Own Windows Desktop Images.</a>.</p>
|
|
1539
|
+
* @public
|
|
1540
1540
|
*/
|
|
1541
1541
|
RequiredTenancy?: WorkspaceImageRequiredTenancy;
|
|
1542
1542
|
/**
|
|
1543
|
-
* @public
|
|
1544
1543
|
* <p>The date when the image was created.</p>
|
|
1544
|
+
* @public
|
|
1545
1545
|
*/
|
|
1546
1546
|
Created?: Date;
|
|
1547
1547
|
/**
|
|
1548
|
-
* @public
|
|
1549
1548
|
* <p>The identifier of the Amazon Web Services account that owns the image.</p>
|
|
1549
|
+
* @public
|
|
1550
1550
|
*/
|
|
1551
1551
|
OwnerAccountId?: string;
|
|
1552
1552
|
}
|
|
@@ -1597,12 +1597,11 @@ export declare const RunningMode: {
|
|
|
1597
1597
|
*/
|
|
1598
1598
|
export type RunningMode = (typeof RunningMode)[keyof typeof RunningMode];
|
|
1599
1599
|
/**
|
|
1600
|
-
* @public
|
|
1601
1600
|
* <p>Describes a WorkSpace.</p>
|
|
1601
|
+
* @public
|
|
1602
1602
|
*/
|
|
1603
1603
|
export interface WorkspaceProperties {
|
|
1604
1604
|
/**
|
|
1605
|
-
* @public
|
|
1606
1605
|
* <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
|
|
1607
1606
|
* Mode</a>.</p>
|
|
1608
1607
|
* <note>
|
|
@@ -1610,36 +1609,36 @@ export interface WorkspaceProperties {
|
|
|
1610
1609
|
* your account team to be allow-listed to use this value. For more information, see
|
|
1611
1610
|
* <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p>
|
|
1612
1611
|
* </note>
|
|
1612
|
+
* @public
|
|
1613
1613
|
*/
|
|
1614
1614
|
RunningMode?: RunningMode;
|
|
1615
1615
|
/**
|
|
1616
|
-
* @public
|
|
1617
1616
|
* <p>The time after a user logs off when WorkSpaces are automatically stopped. Configured in
|
|
1618
1617
|
* 60-minute intervals.</p>
|
|
1618
|
+
* @public
|
|
1619
1619
|
*/
|
|
1620
1620
|
RunningModeAutoStopTimeoutInMinutes?: number;
|
|
1621
1621
|
/**
|
|
1622
|
-
* @public
|
|
1623
1622
|
* <p>The size of the root volume. For important information about how to modify the size of
|
|
1624
1623
|
* the root and user volumes, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html">Modify a
|
|
1625
1624
|
* WorkSpace</a>.</p>
|
|
1625
|
+
* @public
|
|
1626
1626
|
*/
|
|
1627
1627
|
RootVolumeSizeGib?: number;
|
|
1628
1628
|
/**
|
|
1629
|
-
* @public
|
|
1630
1629
|
* <p>The size of the user storage. For important information about how to modify the size of
|
|
1631
1630
|
* the root and user volumes, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html">Modify a
|
|
1632
1631
|
* WorkSpace</a>.</p>
|
|
1632
|
+
* @public
|
|
1633
1633
|
*/
|
|
1634
1634
|
UserVolumeSizeGib?: number;
|
|
1635
1635
|
/**
|
|
1636
|
-
* @public
|
|
1637
1636
|
* <p>The compute type. For more information, see <a href="http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles">Amazon WorkSpaces
|
|
1638
1637
|
* Bundles</a>.</p>
|
|
1638
|
+
* @public
|
|
1639
1639
|
*/
|
|
1640
1640
|
ComputeTypeName?: Compute;
|
|
1641
1641
|
/**
|
|
1642
|
-
* @public
|
|
1643
1642
|
* <p>The protocol. For more information, see
|
|
1644
1643
|
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html">
|
|
1645
1644
|
* Protocols for Amazon WorkSpaces</a>.</p>
|
|
@@ -1657,64 +1656,65 @@ export interface WorkspaceProperties {
|
|
|
1657
1656
|
* </li>
|
|
1658
1657
|
* </ul>
|
|
1659
1658
|
* </note>
|
|
1659
|
+
* @public
|
|
1660
1660
|
*/
|
|
1661
1661
|
Protocols?: Protocol[];
|
|
1662
1662
|
/**
|
|
1663
|
-
* @public
|
|
1664
1663
|
* <p>The name of the operating system.</p>
|
|
1664
|
+
* @public
|
|
1665
1665
|
*/
|
|
1666
1666
|
OperatingSystemName?: OperatingSystemName;
|
|
1667
1667
|
}
|
|
1668
1668
|
/**
|
|
1669
|
-
* @public
|
|
1670
1669
|
* <p>Describes the information used to create a WorkSpace.</p>
|
|
1670
|
+
* @public
|
|
1671
1671
|
*/
|
|
1672
1672
|
export interface WorkspaceRequest {
|
|
1673
1673
|
/**
|
|
1674
|
-
* @public
|
|
1675
1674
|
* <p>The identifier of the Directory Service directory for the WorkSpace. You can use <a>DescribeWorkspaceDirectories</a> to list the available directories.</p>
|
|
1675
|
+
* @public
|
|
1676
1676
|
*/
|
|
1677
1677
|
DirectoryId: string | undefined;
|
|
1678
1678
|
/**
|
|
1679
|
-
* @public
|
|
1680
1679
|
* <p>The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.</p>
|
|
1681
1680
|
* <p>The reserved keyword, <code>[UNDEFINED]</code>, is used when creating user-decoupled WorkSpaces.</p>
|
|
1681
|
+
* @public
|
|
1682
1682
|
*/
|
|
1683
1683
|
UserName: string | undefined;
|
|
1684
1684
|
/**
|
|
1685
|
-
* @public
|
|
1686
1685
|
* <p>The identifier of the bundle for the WorkSpace. You can use <a>DescribeWorkspaceBundles</a> to list the available bundles.</p>
|
|
1686
|
+
* @public
|
|
1687
1687
|
*/
|
|
1688
1688
|
BundleId: string | undefined;
|
|
1689
1689
|
/**
|
|
1690
|
-
* @public
|
|
1691
1690
|
* <p>The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.
|
|
1692
1691
|
* Amazon WorkSpaces does not support asymmetric KMS keys.</p>
|
|
1692
|
+
* @public
|
|
1693
1693
|
*/
|
|
1694
1694
|
VolumeEncryptionKey?: string;
|
|
1695
1695
|
/**
|
|
1696
|
-
* @public
|
|
1697
1696
|
* <p>Indicates whether the data stored on the user volume is encrypted.</p>
|
|
1697
|
+
* @public
|
|
1698
1698
|
*/
|
|
1699
1699
|
UserVolumeEncryptionEnabled?: boolean;
|
|
1700
1700
|
/**
|
|
1701
|
-
* @public
|
|
1702
1701
|
* <p>Indicates whether the data stored on the root volume is encrypted.</p>
|
|
1702
|
+
* @public
|
|
1703
1703
|
*/
|
|
1704
1704
|
RootVolumeEncryptionEnabled?: boolean;
|
|
1705
1705
|
/**
|
|
1706
|
-
* @public
|
|
1707
1706
|
* <p>The WorkSpace properties.</p>
|
|
1707
|
+
* @public
|
|
1708
1708
|
*/
|
|
1709
1709
|
WorkspaceProperties?: WorkspaceProperties;
|
|
1710
1710
|
/**
|
|
1711
|
-
* @public
|
|
1712
1711
|
* <p>The tags for the WorkSpace.</p>
|
|
1712
|
+
* @public
|
|
1713
1713
|
*/
|
|
1714
1714
|
Tags?: Tag[];
|
|
1715
1715
|
/**
|
|
1716
|
-
* @public
|
|
1717
1716
|
* <p>The name of the user-decoupled WorkSpace.</p>
|
|
1717
|
+
* @public
|
|
1718
1718
|
*/
|
|
1719
1719
|
WorkspaceName?: string;
|
|
1720
1720
|
}
|
|
@@ -1723,47 +1723,47 @@ export interface WorkspaceRequest {
|
|
|
1723
1723
|
*/
|
|
1724
1724
|
export interface CreateWorkspacesRequest {
|
|
1725
1725
|
/**
|
|
1726
|
-
* @public
|
|
1727
1726
|
* <p>The WorkSpaces to create. You can specify up to 25 WorkSpaces.</p>
|
|
1727
|
+
* @public
|
|
1728
1728
|
*/
|
|
1729
1729
|
Workspaces: WorkspaceRequest[] | undefined;
|
|
1730
1730
|
}
|
|
1731
1731
|
/**
|
|
1732
|
-
* @public
|
|
1733
1732
|
* <p>Describes a WorkSpace that cannot be created.</p>
|
|
1733
|
+
* @public
|
|
1734
1734
|
*/
|
|
1735
1735
|
export interface FailedCreateWorkspaceRequest {
|
|
1736
1736
|
/**
|
|
1737
|
-
* @public
|
|
1738
1737
|
* <p>Information about the WorkSpace.</p>
|
|
1738
|
+
* @public
|
|
1739
1739
|
*/
|
|
1740
1740
|
WorkspaceRequest?: WorkspaceRequest;
|
|
1741
1741
|
/**
|
|
1742
|
-
* @public
|
|
1743
1742
|
* <p>The error code that is returned if the WorkSpace cannot be created.</p>
|
|
1743
|
+
* @public
|
|
1744
1744
|
*/
|
|
1745
1745
|
ErrorCode?: string;
|
|
1746
1746
|
/**
|
|
1747
|
-
* @public
|
|
1748
1747
|
* <p>The text of the error message that is returned if the WorkSpace cannot be
|
|
1749
1748
|
* created.</p>
|
|
1749
|
+
* @public
|
|
1750
1750
|
*/
|
|
1751
1751
|
ErrorMessage?: string;
|
|
1752
1752
|
}
|
|
1753
1753
|
/**
|
|
1754
|
-
* @public
|
|
1755
1754
|
* <p>Describes the data replication settings.</p>
|
|
1755
|
+
* @public
|
|
1756
1756
|
*/
|
|
1757
1757
|
export interface DataReplicationSettings {
|
|
1758
1758
|
/**
|
|
1759
|
-
* @public
|
|
1760
1759
|
* <p>Indicates whether data replication is enabled, and if enabled, the type of data replication.</p>
|
|
1760
|
+
* @public
|
|
1761
1761
|
*/
|
|
1762
1762
|
DataReplication?: DataReplication;
|
|
1763
1763
|
/**
|
|
1764
|
-
* @public
|
|
1765
1764
|
* <p>The date and time at which the last successful snapshot was taken of the
|
|
1766
1765
|
* primary WorkSpace used for replicating data.</p>
|
|
1766
|
+
* @public
|
|
1767
1767
|
*/
|
|
1768
1768
|
RecoverySnapshotTime?: Date;
|
|
1769
1769
|
}
|
|
@@ -1793,18 +1793,18 @@ export declare const ModificationStateEnum: {
|
|
|
1793
1793
|
*/
|
|
1794
1794
|
export type ModificationStateEnum = (typeof ModificationStateEnum)[keyof typeof ModificationStateEnum];
|
|
1795
1795
|
/**
|
|
1796
|
-
* @public
|
|
1797
1796
|
* <p>Describes a WorkSpace modification.</p>
|
|
1797
|
+
* @public
|
|
1798
1798
|
*/
|
|
1799
1799
|
export interface ModificationState {
|
|
1800
1800
|
/**
|
|
1801
|
-
* @public
|
|
1802
1801
|
* <p>The resource.</p>
|
|
1802
|
+
* @public
|
|
1803
1803
|
*/
|
|
1804
1804
|
Resource?: ModificationResourceEnum;
|
|
1805
1805
|
/**
|
|
1806
|
-
* @public
|
|
1807
1806
|
* <p>The modification state.</p>
|
|
1807
|
+
* @public
|
|
1808
1808
|
*/
|
|
1809
1809
|
State?: ModificationStateEnum;
|
|
1810
1810
|
}
|
|
@@ -1821,81 +1821,80 @@ export declare const StandbyWorkspaceRelationshipType: {
|
|
|
1821
1821
|
*/
|
|
1822
1822
|
export type StandbyWorkspaceRelationshipType = (typeof StandbyWorkspaceRelationshipType)[keyof typeof StandbyWorkspaceRelationshipType];
|
|
1823
1823
|
/**
|
|
1824
|
-
* @public
|
|
1825
1824
|
* <p>Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or
|
|
1826
1825
|
* primary WorkSpace related to the specified WorkSpace.</p>
|
|
1826
|
+
* @public
|
|
1827
1827
|
*/
|
|
1828
1828
|
export interface RelatedWorkspaceProperties {
|
|
1829
1829
|
/**
|
|
1830
|
-
* @public
|
|
1831
1830
|
* <p>The identifier of the related WorkSpace.</p>
|
|
1831
|
+
* @public
|
|
1832
1832
|
*/
|
|
1833
1833
|
WorkspaceId?: string;
|
|
1834
1834
|
/**
|
|
1835
|
-
* @public
|
|
1836
1835
|
* <p>The Region of the related WorkSpace.</p>
|
|
1836
|
+
* @public
|
|
1837
1837
|
*/
|
|
1838
1838
|
Region?: string;
|
|
1839
1839
|
/**
|
|
1840
|
-
* @public
|
|
1841
1840
|
* <p>Indicates the state of the WorkSpace.</p>
|
|
1841
|
+
* @public
|
|
1842
1842
|
*/
|
|
1843
1843
|
State?: WorkspaceState;
|
|
1844
1844
|
/**
|
|
1845
|
-
* @public
|
|
1846
1845
|
* <p>Indicates the type of WorkSpace.</p>
|
|
1846
|
+
* @public
|
|
1847
1847
|
*/
|
|
1848
1848
|
Type?: StandbyWorkspaceRelationshipType;
|
|
1849
1849
|
}
|
|
1850
1850
|
/**
|
|
1851
|
-
* @public
|
|
1852
1851
|
* <p>Describes the properties of the related standby WorkSpaces. </p>
|
|
1852
|
+
* @public
|
|
1853
1853
|
*/
|
|
1854
1854
|
export interface StandbyWorkspacesProperties {
|
|
1855
1855
|
/**
|
|
1856
|
-
* @public
|
|
1857
1856
|
* <p>The identifier of the standby WorkSpace</p>
|
|
1857
|
+
* @public
|
|
1858
1858
|
*/
|
|
1859
1859
|
StandbyWorkspaceId?: string;
|
|
1860
1860
|
/**
|
|
1861
|
-
* @public
|
|
1862
1861
|
* <p>Indicates whether data replication is enabled, and if enabled, the type of data replication.</p>
|
|
1862
|
+
* @public
|
|
1863
1863
|
*/
|
|
1864
1864
|
DataReplication?: DataReplication;
|
|
1865
1865
|
/**
|
|
1866
|
-
* @public
|
|
1867
1866
|
* <p>The date and time at which the last successful snapshot was taken of the
|
|
1868
1867
|
* primary WorkSpace used for replicating data.</p>
|
|
1868
|
+
* @public
|
|
1869
1869
|
*/
|
|
1870
1870
|
RecoverySnapshotTime?: Date;
|
|
1871
1871
|
}
|
|
1872
1872
|
/**
|
|
1873
|
-
* @public
|
|
1874
1873
|
* <p>Describes a WorkSpace.</p>
|
|
1874
|
+
* @public
|
|
1875
1875
|
*/
|
|
1876
1876
|
export interface Workspace {
|
|
1877
1877
|
/**
|
|
1878
|
-
* @public
|
|
1879
1878
|
* <p>The identifier of the WorkSpace.</p>
|
|
1879
|
+
* @public
|
|
1880
1880
|
*/
|
|
1881
1881
|
WorkspaceId?: string;
|
|
1882
1882
|
/**
|
|
1883
|
-
* @public
|
|
1884
1883
|
* <p>The identifier of the Directory Service directory for the WorkSpace.</p>
|
|
1884
|
+
* @public
|
|
1885
1885
|
*/
|
|
1886
1886
|
DirectoryId?: string;
|
|
1887
1887
|
/**
|
|
1888
|
-
* @public
|
|
1889
1888
|
* <p>The user for the WorkSpace.</p>
|
|
1889
|
+
* @public
|
|
1890
1890
|
*/
|
|
1891
1891
|
UserName?: string;
|
|
1892
1892
|
/**
|
|
1893
|
-
* @public
|
|
1894
1893
|
* <p>The IP address of the WorkSpace.</p>
|
|
1894
|
+
* @public
|
|
1895
1895
|
*/
|
|
1896
1896
|
IpAddress?: string;
|
|
1897
1897
|
/**
|
|
1898
|
-
* @public
|
|
1899
1898
|
* <p>The operational state of the WorkSpace.</p>
|
|
1900
1899
|
* <ul>
|
|
1901
1900
|
* <li>
|
|
@@ -1975,80 +1974,81 @@ export interface Workspace {
|
|
|
1975
1974
|
* DescribeWorkSpaces</a>. If the WorkSpace ID isn't returned, then the WorkSpace
|
|
1976
1975
|
* has been successfully terminated.</p>
|
|
1977
1976
|
* </note>
|
|
1977
|
+
* @public
|
|
1978
1978
|
*/
|
|
1979
1979
|
State?: WorkspaceState;
|
|
1980
1980
|
/**
|
|
1981
|
-
* @public
|
|
1982
1981
|
* <p>The identifier of the bundle used to create the WorkSpace.</p>
|
|
1982
|
+
* @public
|
|
1983
1983
|
*/
|
|
1984
1984
|
BundleId?: string;
|
|
1985
1985
|
/**
|
|
1986
|
-
* @public
|
|
1987
1986
|
* <p>The identifier of the subnet for the WorkSpace.</p>
|
|
1987
|
+
* @public
|
|
1988
1988
|
*/
|
|
1989
1989
|
SubnetId?: string;
|
|
1990
1990
|
/**
|
|
1991
|
-
* @public
|
|
1992
1991
|
* <p>The text of the error message that is returned if the WorkSpace cannot be
|
|
1993
1992
|
* created.</p>
|
|
1993
|
+
* @public
|
|
1994
1994
|
*/
|
|
1995
1995
|
ErrorMessage?: string;
|
|
1996
1996
|
/**
|
|
1997
|
-
* @public
|
|
1998
1997
|
* <p>The error code that is returned if the WorkSpace cannot be created.</p>
|
|
1998
|
+
* @public
|
|
1999
1999
|
*/
|
|
2000
2000
|
ErrorCode?: string;
|
|
2001
2001
|
/**
|
|
2002
|
-
* @public
|
|
2003
2002
|
* <p>The name of the WorkSpace, as seen by the operating system. The format of this name
|
|
2004
2003
|
* varies. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html"> Launch a
|
|
2005
2004
|
* WorkSpace</a>. </p>
|
|
2005
|
+
* @public
|
|
2006
2006
|
*/
|
|
2007
2007
|
ComputerName?: string;
|
|
2008
2008
|
/**
|
|
2009
|
-
* @public
|
|
2010
2009
|
* <p>The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.
|
|
2011
2010
|
* Amazon WorkSpaces does not support asymmetric KMS keys.</p>
|
|
2011
|
+
* @public
|
|
2012
2012
|
*/
|
|
2013
2013
|
VolumeEncryptionKey?: string;
|
|
2014
2014
|
/**
|
|
2015
|
-
* @public
|
|
2016
2015
|
* <p>Indicates whether the data stored on the user volume is encrypted.</p>
|
|
2016
|
+
* @public
|
|
2017
2017
|
*/
|
|
2018
2018
|
UserVolumeEncryptionEnabled?: boolean;
|
|
2019
2019
|
/**
|
|
2020
|
-
* @public
|
|
2021
2020
|
* <p>Indicates whether the data stored on the root volume is encrypted.</p>
|
|
2021
|
+
* @public
|
|
2022
2022
|
*/
|
|
2023
2023
|
RootVolumeEncryptionEnabled?: boolean;
|
|
2024
2024
|
/**
|
|
2025
|
-
* @public
|
|
2026
2025
|
* <p>The name of the user-decoupled WorkSpace.</p>
|
|
2026
|
+
* @public
|
|
2027
2027
|
*/
|
|
2028
2028
|
WorkspaceName?: string;
|
|
2029
2029
|
/**
|
|
2030
|
-
* @public
|
|
2031
2030
|
* <p>The properties of the WorkSpace.</p>
|
|
2031
|
+
* @public
|
|
2032
2032
|
*/
|
|
2033
2033
|
WorkspaceProperties?: WorkspaceProperties;
|
|
2034
2034
|
/**
|
|
2035
|
-
* @public
|
|
2036
2035
|
* <p>The modification states of the WorkSpace.</p>
|
|
2036
|
+
* @public
|
|
2037
2037
|
*/
|
|
2038
2038
|
ModificationStates?: ModificationState[];
|
|
2039
2039
|
/**
|
|
2040
|
-
* @public
|
|
2041
2040
|
* <p>The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.</p>
|
|
2041
|
+
* @public
|
|
2042
2042
|
*/
|
|
2043
2043
|
RelatedWorkspaces?: RelatedWorkspaceProperties[];
|
|
2044
2044
|
/**
|
|
2045
|
-
* @public
|
|
2046
2045
|
* <p>Indicates the settings of the data replication.</p>
|
|
2046
|
+
* @public
|
|
2047
2047
|
*/
|
|
2048
2048
|
DataReplicationSettings?: DataReplicationSettings;
|
|
2049
2049
|
/**
|
|
2050
|
-
* @public
|
|
2051
2050
|
* <p>The properties of the standby WorkSpace</p>
|
|
2051
|
+
* @public
|
|
2052
2052
|
*/
|
|
2053
2053
|
StandbyWorkspacesProperties?: StandbyWorkspacesProperties[];
|
|
2054
2054
|
}
|
|
@@ -2057,16 +2057,16 @@ export interface Workspace {
|
|
|
2057
2057
|
*/
|
|
2058
2058
|
export interface CreateWorkspacesResult {
|
|
2059
2059
|
/**
|
|
2060
|
-
* @public
|
|
2061
2060
|
* <p>Information about the WorkSpaces that could not be created.</p>
|
|
2061
|
+
* @public
|
|
2062
2062
|
*/
|
|
2063
2063
|
FailedRequests?: FailedCreateWorkspaceRequest[];
|
|
2064
2064
|
/**
|
|
2065
|
-
* @public
|
|
2066
2065
|
* <p>Information about the WorkSpaces that were created.</p>
|
|
2067
2066
|
* <p>Because this operation is asynchronous, the identifier returned is not immediately
|
|
2068
2067
|
* available for use with other operations. For example, if you call <a>DescribeWorkspaces</a> before the WorkSpace is created, the information returned
|
|
2069
2068
|
* can be incomplete.</p>
|
|
2069
|
+
* @public
|
|
2070
2070
|
*/
|
|
2071
2071
|
PendingRequests?: Workspace[];
|
|
2072
2072
|
}
|
|
@@ -2082,22 +2082,21 @@ export declare const DedicatedTenancySupportEnum: {
|
|
|
2082
2082
|
*/
|
|
2083
2083
|
export type DedicatedTenancySupportEnum = (typeof DedicatedTenancySupportEnum)[keyof typeof DedicatedTenancySupportEnum];
|
|
2084
2084
|
/**
|
|
2085
|
-
* @public
|
|
2086
2085
|
* <p>Returns default client branding attributes that were imported. These attributes display
|
|
2087
2086
|
* on the client login screen.</p>
|
|
2088
2087
|
* <important>
|
|
2089
2088
|
* <p>Client branding attributes are public facing. Ensure that you don't include sensitive
|
|
2090
2089
|
* information.</p>
|
|
2091
2090
|
* </important>
|
|
2091
|
+
* @public
|
|
2092
2092
|
*/
|
|
2093
2093
|
export interface DefaultClientBrandingAttributes {
|
|
2094
2094
|
/**
|
|
2095
|
-
* @public
|
|
2096
2095
|
* <p>The logo. The only image format accepted is a binary data object that is converted from a <code>.png</code> file.</p>
|
|
2096
|
+
* @public
|
|
2097
2097
|
*/
|
|
2098
2098
|
LogoUrl?: string;
|
|
2099
2099
|
/**
|
|
2100
|
-
* @public
|
|
2101
2100
|
* <p>The support email. The company's customer support email address.</p>
|
|
2102
2101
|
* <note>
|
|
2103
2102
|
* <ul>
|
|
@@ -2111,10 +2110,10 @@ export interface DefaultClientBrandingAttributes {
|
|
|
2111
2110
|
* </li>
|
|
2112
2111
|
* </ul>
|
|
2113
2112
|
* </note>
|
|
2113
|
+
* @public
|
|
2114
2114
|
*/
|
|
2115
2115
|
SupportEmail?: string;
|
|
2116
2116
|
/**
|
|
2117
|
-
* @public
|
|
2118
2117
|
* <p>The support link. The link for the company's customer support page for their
|
|
2119
2118
|
* WorkSpace.</p>
|
|
2120
2119
|
* <note>
|
|
@@ -2129,40 +2128,40 @@ export interface DefaultClientBrandingAttributes {
|
|
|
2129
2128
|
* </li>
|
|
2130
2129
|
* </ul>
|
|
2131
2130
|
* </note>
|
|
2131
|
+
* @public
|
|
2132
2132
|
*/
|
|
2133
2133
|
SupportLink?: string;
|
|
2134
2134
|
/**
|
|
2135
|
-
* @public
|
|
2136
2135
|
* <p>The forgotten password link. This is the web address that users can go to if they forget
|
|
2137
2136
|
* the password for their WorkSpace.</p>
|
|
2137
|
+
* @public
|
|
2138
2138
|
*/
|
|
2139
2139
|
ForgotPasswordLink?: string;
|
|
2140
2140
|
/**
|
|
2141
|
-
* @public
|
|
2142
2141
|
* <p>The login message. Specified as a key value pair, in which the key is a locale and the
|
|
2143
2142
|
* value is the localized message for that locale. The only key supported is
|
|
2144
2143
|
* <code>en_US</code>. The HTML tags supported include the following: <code>a, b, blockquote, br, cite, code, dd, dl, dt, div, em,
|
|
2145
2144
|
* i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul</code>.</p>
|
|
2145
|
+
* @public
|
|
2146
2146
|
*/
|
|
2147
2147
|
LoginMessage?: Record<string, string>;
|
|
2148
2148
|
}
|
|
2149
2149
|
/**
|
|
2150
|
-
* @public
|
|
2151
2150
|
* <p>The default client branding attributes to be imported. These attributes display on the
|
|
2152
2151
|
* client login screen.</p>
|
|
2153
2152
|
* <important>
|
|
2154
2153
|
* <p>Client branding attributes are public facing. Ensure that you do not include
|
|
2155
2154
|
* sensitive information.</p>
|
|
2156
2155
|
* </important>
|
|
2156
|
+
* @public
|
|
2157
2157
|
*/
|
|
2158
2158
|
export interface DefaultImportClientBrandingAttributes {
|
|
2159
2159
|
/**
|
|
2160
|
-
* @public
|
|
2161
2160
|
* <p>The logo. The only image format accepted is a binary data object that is converted from a <code>.png</code> file.</p>
|
|
2161
|
+
* @public
|
|
2162
2162
|
*/
|
|
2163
2163
|
Logo?: Uint8Array;
|
|
2164
2164
|
/**
|
|
2165
|
-
* @public
|
|
2166
2165
|
* <p>The support email. The company's customer support email address.</p>
|
|
2167
2166
|
* <note>
|
|
2168
2167
|
* <ul>
|
|
@@ -2176,10 +2175,10 @@ export interface DefaultImportClientBrandingAttributes {
|
|
|
2176
2175
|
* </li>
|
|
2177
2176
|
* </ul>
|
|
2178
2177
|
* </note>
|
|
2178
|
+
* @public
|
|
2179
2179
|
*/
|
|
2180
2180
|
SupportEmail?: string;
|
|
2181
2181
|
/**
|
|
2182
|
-
* @public
|
|
2183
2182
|
* <p>The support link. The link for the company's customer support page for their
|
|
2184
2183
|
* WorkSpace.</p>
|
|
2185
2184
|
* <note>
|
|
@@ -2194,37 +2193,37 @@ export interface DefaultImportClientBrandingAttributes {
|
|
|
2194
2193
|
* </li>
|
|
2195
2194
|
* </ul>
|
|
2196
2195
|
* </note>
|
|
2196
|
+
* @public
|
|
2197
2197
|
*/
|
|
2198
2198
|
SupportLink?: string;
|
|
2199
2199
|
/**
|
|
2200
|
-
* @public
|
|
2201
2200
|
* <p>The forgotten password link. This is the web address that users can go to if they forget
|
|
2202
2201
|
* the password for their WorkSpace.</p>
|
|
2202
|
+
* @public
|
|
2203
2203
|
*/
|
|
2204
2204
|
ForgotPasswordLink?: string;
|
|
2205
2205
|
/**
|
|
2206
|
-
* @public
|
|
2207
2206
|
* <p>The login message. Specified as a key value pair, in which the key is a locale and the
|
|
2208
2207
|
* value is the localized message for that locale. The only key supported is
|
|
2209
2208
|
* <code>en_US</code>. The HTML tags supported include the following: <code>a, b, blockquote, br, cite, code, dd, dl, dt, div, em,
|
|
2210
2209
|
* i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul</code>.</p>
|
|
2210
|
+
* @public
|
|
2211
2211
|
*/
|
|
2212
2212
|
LoginMessage?: Record<string, string>;
|
|
2213
2213
|
}
|
|
2214
2214
|
/**
|
|
2215
|
-
* @public
|
|
2216
2215
|
* <p>Describes the default values that are used to create WorkSpaces. For more information,
|
|
2217
2216
|
* see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html">Update Directory
|
|
2218
2217
|
* Details for Your WorkSpaces</a>.</p>
|
|
2218
|
+
* @public
|
|
2219
2219
|
*/
|
|
2220
2220
|
export interface DefaultWorkspaceCreationProperties {
|
|
2221
2221
|
/**
|
|
2222
|
-
* @public
|
|
2223
2222
|
* <p>Specifies whether the directory is enabled for Amazon WorkDocs.</p>
|
|
2223
|
+
* @public
|
|
2224
2224
|
*/
|
|
2225
2225
|
EnableWorkDocs?: boolean;
|
|
2226
2226
|
/**
|
|
2227
|
-
* @public
|
|
2228
2227
|
* <p>Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in
|
|
2229
2228
|
* this directory by default. If enabled, the Elastic public IP address allows outbound
|
|
2230
2229
|
* internet access from your WorkSpaces when you’re using an internet gateway in the Amazon
|
|
@@ -2234,30 +2233,31 @@ export interface DefaultWorkspaceCreationProperties {
|
|
|
2234
2233
|
* setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces
|
|
2235
2234
|
* that you rebuild. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html"> Configure a VPC for
|
|
2236
2235
|
* Amazon WorkSpaces</a>.</p>
|
|
2236
|
+
* @public
|
|
2237
2237
|
*/
|
|
2238
2238
|
EnableInternetAccess?: boolean;
|
|
2239
2239
|
/**
|
|
2240
|
-
* @public
|
|
2241
2240
|
* <p>The organizational unit (OU) in the directory for the WorkSpace machine accounts.</p>
|
|
2241
|
+
* @public
|
|
2242
2242
|
*/
|
|
2243
2243
|
DefaultOu?: string;
|
|
2244
2244
|
/**
|
|
2245
|
-
* @public
|
|
2246
2245
|
* <p>The identifier of the default security group to apply to WorkSpaces when they are
|
|
2247
2246
|
* created. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-security-groups.html"> Security
|
|
2248
2247
|
* Groups for Your WorkSpaces</a>.</p>
|
|
2248
|
+
* @public
|
|
2249
2249
|
*/
|
|
2250
2250
|
CustomSecurityGroupId?: string;
|
|
2251
2251
|
/**
|
|
2252
|
-
* @public
|
|
2253
2252
|
* <p>Specifies whether WorkSpace users are local administrators on their WorkSpaces.</p>
|
|
2253
|
+
* @public
|
|
2254
2254
|
*/
|
|
2255
2255
|
UserEnabledAsLocalAdministrator?: boolean;
|
|
2256
2256
|
/**
|
|
2257
|
-
* @public
|
|
2258
2257
|
* <p>Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see
|
|
2259
2258
|
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html">WorkSpace
|
|
2260
2259
|
* Maintenance</a>.</p>
|
|
2260
|
+
* @public
|
|
2261
2261
|
*/
|
|
2262
2262
|
EnableMaintenanceMode?: boolean;
|
|
2263
2263
|
}
|
|
@@ -2289,14 +2289,14 @@ export type DeletableSamlProperty = (typeof DeletableSamlProperty)[keyof typeof
|
|
|
2289
2289
|
*/
|
|
2290
2290
|
export interface DeleteClientBrandingRequest {
|
|
2291
2291
|
/**
|
|
2292
|
-
* @public
|
|
2293
2292
|
* <p>The directory identifier of the WorkSpace for which you want to delete client
|
|
2294
2293
|
* branding.</p>
|
|
2294
|
+
* @public
|
|
2295
2295
|
*/
|
|
2296
2296
|
ResourceId: string | undefined;
|
|
2297
2297
|
/**
|
|
2298
|
-
* @public
|
|
2299
2298
|
* <p>The device type for which you want to delete client branding.</p>
|
|
2299
|
+
* @public
|
|
2300
2300
|
*/
|
|
2301
2301
|
Platforms: ClientDeviceType[] | undefined;
|
|
2302
2302
|
}
|
|
@@ -2310,13 +2310,13 @@ export interface DeleteClientBrandingResult {
|
|
|
2310
2310
|
*/
|
|
2311
2311
|
export interface DeleteConnectClientAddInRequest {
|
|
2312
2312
|
/**
|
|
2313
|
-
* @public
|
|
2314
2313
|
* <p>The identifier of the client add-in to delete.</p>
|
|
2314
|
+
* @public
|
|
2315
2315
|
*/
|
|
2316
2316
|
AddInId: string | undefined;
|
|
2317
2317
|
/**
|
|
2318
|
-
* @public
|
|
2319
2318
|
* <p>The directory identifier for which the client add-in is configured.</p>
|
|
2319
|
+
* @public
|
|
2320
2320
|
*/
|
|
2321
2321
|
ResourceId: string | undefined;
|
|
2322
2322
|
}
|
|
@@ -2330,8 +2330,8 @@ export interface DeleteConnectClientAddInResult {
|
|
|
2330
2330
|
*/
|
|
2331
2331
|
export interface DeleteConnectionAliasRequest {
|
|
2332
2332
|
/**
|
|
2333
|
-
* @public
|
|
2334
2333
|
* <p>The identifier of the connection alias to delete.</p>
|
|
2334
|
+
* @public
|
|
2335
2335
|
*/
|
|
2336
2336
|
AliasId: string | undefined;
|
|
2337
2337
|
}
|
|
@@ -2345,8 +2345,8 @@ export interface DeleteConnectionAliasResult {
|
|
|
2345
2345
|
*/
|
|
2346
2346
|
export interface DeleteIpGroupRequest {
|
|
2347
2347
|
/**
|
|
2348
|
-
* @public
|
|
2349
2348
|
* <p>The identifier of the IP access control group.</p>
|
|
2349
|
+
* @public
|
|
2350
2350
|
*/
|
|
2351
2351
|
GroupId: string | undefined;
|
|
2352
2352
|
}
|
|
@@ -2360,15 +2360,15 @@ export interface DeleteIpGroupResult {
|
|
|
2360
2360
|
*/
|
|
2361
2361
|
export interface DeleteTagsRequest {
|
|
2362
2362
|
/**
|
|
2363
|
-
* @public
|
|
2364
2363
|
* <p>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,
|
|
2365
2364
|
* registered directories, images, custom bundles, IP access control groups, and connection
|
|
2366
2365
|
* aliases.</p>
|
|
2366
|
+
* @public
|
|
2367
2367
|
*/
|
|
2368
2368
|
ResourceId: string | undefined;
|
|
2369
2369
|
/**
|
|
2370
|
-
* @public
|
|
2371
2370
|
* <p>The tag keys.</p>
|
|
2371
|
+
* @public
|
|
2372
2372
|
*/
|
|
2373
2373
|
TagKeys: string[] | undefined;
|
|
2374
2374
|
}
|
|
@@ -2382,8 +2382,8 @@ export interface DeleteTagsResult {
|
|
|
2382
2382
|
*/
|
|
2383
2383
|
export interface DeleteWorkspaceBundleRequest {
|
|
2384
2384
|
/**
|
|
2385
|
-
* @public
|
|
2386
2385
|
* <p>The identifier of the bundle.</p>
|
|
2386
|
+
* @public
|
|
2387
2387
|
*/
|
|
2388
2388
|
BundleId?: string;
|
|
2389
2389
|
}
|
|
@@ -2397,8 +2397,8 @@ export interface DeleteWorkspaceBundleResult {
|
|
|
2397
2397
|
*/
|
|
2398
2398
|
export interface DeleteWorkspaceImageRequest {
|
|
2399
2399
|
/**
|
|
2400
|
-
* @public
|
|
2401
2400
|
* <p>The identifier of the image.</p>
|
|
2401
|
+
* @public
|
|
2402
2402
|
*/
|
|
2403
2403
|
ImageId: string | undefined;
|
|
2404
2404
|
}
|
|
@@ -2412,25 +2412,25 @@ export interface DeleteWorkspaceImageResult {
|
|
|
2412
2412
|
*/
|
|
2413
2413
|
export interface DeployWorkspaceApplicationsRequest {
|
|
2414
2414
|
/**
|
|
2415
|
-
* @public
|
|
2416
2415
|
* <p>The identifier of the WorkSpace.</p>
|
|
2416
|
+
* @public
|
|
2417
2417
|
*/
|
|
2418
2418
|
WorkspaceId: string | undefined;
|
|
2419
2419
|
/**
|
|
2420
|
-
* @public
|
|
2421
2420
|
* <p>Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled,
|
|
2422
2421
|
* it allows previously failed deployments to be retried.</p>
|
|
2422
|
+
* @public
|
|
2423
2423
|
*/
|
|
2424
2424
|
Force?: boolean;
|
|
2425
2425
|
}
|
|
2426
2426
|
/**
|
|
2427
|
-
* @public
|
|
2428
2427
|
* <p>Describes the WorkSpace application deployment.</p>
|
|
2428
|
+
* @public
|
|
2429
2429
|
*/
|
|
2430
2430
|
export interface WorkSpaceApplicationDeployment {
|
|
2431
2431
|
/**
|
|
2432
|
-
* @public
|
|
2433
2432
|
* <p>The associations between the applications and the associated resources.</p>
|
|
2433
|
+
* @public
|
|
2434
2434
|
*/
|
|
2435
2435
|
Associations?: WorkspaceResourceAssociation[];
|
|
2436
2436
|
}
|
|
@@ -2439,8 +2439,8 @@ export interface WorkSpaceApplicationDeployment {
|
|
|
2439
2439
|
*/
|
|
2440
2440
|
export interface DeployWorkspaceApplicationsResult {
|
|
2441
2441
|
/**
|
|
2442
|
-
* @public
|
|
2443
2442
|
* <p>The list of deployed associations and information about them.</p>
|
|
2443
|
+
* @public
|
|
2444
2444
|
*/
|
|
2445
2445
|
Deployment?: WorkSpaceApplicationDeployment;
|
|
2446
2446
|
}
|
|
@@ -2449,10 +2449,10 @@ export interface DeployWorkspaceApplicationsResult {
|
|
|
2449
2449
|
*/
|
|
2450
2450
|
export interface DeregisterWorkspaceDirectoryRequest {
|
|
2451
2451
|
/**
|
|
2452
|
-
* @public
|
|
2453
2452
|
* <p>The identifier of the directory. If any WorkSpaces are registered to this directory, you
|
|
2454
2453
|
* must remove them before you deregister the directory, or you will receive an
|
|
2455
2454
|
* OperationNotSupportedException error.</p>
|
|
2455
|
+
* @public
|
|
2456
2456
|
*/
|
|
2457
2457
|
DirectoryId: string | undefined;
|
|
2458
2458
|
}
|
|
@@ -2471,17 +2471,17 @@ export interface DescribeAccountRequest {
|
|
|
2471
2471
|
*/
|
|
2472
2472
|
export interface DescribeAccountResult {
|
|
2473
2473
|
/**
|
|
2474
|
-
* @public
|
|
2475
2474
|
* <p>The status of BYOL (whether BYOL is enabled or disabled).</p>
|
|
2475
|
+
* @public
|
|
2476
2476
|
*/
|
|
2477
2477
|
DedicatedTenancySupport?: DedicatedTenancySupportResultEnum;
|
|
2478
2478
|
/**
|
|
2479
|
-
* @public
|
|
2480
2479
|
* <p>The IP address range, specified as an IPv4 CIDR block, used for the management network
|
|
2481
2480
|
* interface.</p>
|
|
2482
2481
|
* <p>The management network interface is connected to a secure Amazon WorkSpaces management
|
|
2483
2482
|
* network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces
|
|
2484
2483
|
* clients, and to allow Amazon WorkSpaces to manage the WorkSpace.</p>
|
|
2484
|
+
* @public
|
|
2485
2485
|
*/
|
|
2486
2486
|
DedicatedTenancyManagementCidrRange?: string;
|
|
2487
2487
|
}
|
|
@@ -2490,9 +2490,9 @@ export interface DescribeAccountResult {
|
|
|
2490
2490
|
*/
|
|
2491
2491
|
export interface DescribeAccountModificationsRequest {
|
|
2492
2492
|
/**
|
|
2493
|
-
* @public
|
|
2494
2493
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
2495
2494
|
* provide this token to receive the next set of results.</p>
|
|
2495
|
+
* @public
|
|
2496
2496
|
*/
|
|
2497
2497
|
NextToken?: string;
|
|
2498
2498
|
}
|
|
@@ -2501,14 +2501,14 @@ export interface DescribeAccountModificationsRequest {
|
|
|
2501
2501
|
*/
|
|
2502
2502
|
export interface DescribeAccountModificationsResult {
|
|
2503
2503
|
/**
|
|
2504
|
-
* @public
|
|
2505
2504
|
* <p>The list of modifications to the configuration of BYOL.</p>
|
|
2505
|
+
* @public
|
|
2506
2506
|
*/
|
|
2507
2507
|
AccountModifications?: AccountModification[];
|
|
2508
2508
|
/**
|
|
2509
|
-
* @public
|
|
2510
2509
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2511
2510
|
* no more results to return. </p>
|
|
2511
|
+
* @public
|
|
2512
2512
|
*/
|
|
2513
2513
|
NextToken?: string;
|
|
2514
2514
|
}
|
|
@@ -2517,23 +2517,23 @@ export interface DescribeAccountModificationsResult {
|
|
|
2517
2517
|
*/
|
|
2518
2518
|
export interface DescribeApplicationAssociationsRequest {
|
|
2519
2519
|
/**
|
|
2520
|
-
* @public
|
|
2521
2520
|
* <p>The maximum number of associations to return.</p>
|
|
2521
|
+
* @public
|
|
2522
2522
|
*/
|
|
2523
2523
|
MaxResults?: number;
|
|
2524
2524
|
/**
|
|
2525
|
-
* @public
|
|
2526
2525
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>
|
|
2526
|
+
* @public
|
|
2527
2527
|
*/
|
|
2528
2528
|
NextToken?: string;
|
|
2529
2529
|
/**
|
|
2530
|
-
* @public
|
|
2531
2530
|
* <p>The identifier of the specified application.</p>
|
|
2531
|
+
* @public
|
|
2532
2532
|
*/
|
|
2533
2533
|
ApplicationId: string | undefined;
|
|
2534
2534
|
/**
|
|
2535
|
-
* @public
|
|
2536
2535
|
* <p>The resource type of the associated resources.</p>
|
|
2536
|
+
* @public
|
|
2537
2537
|
*/
|
|
2538
2538
|
AssociatedResourceTypes: ApplicationAssociatedResourceType[] | undefined;
|
|
2539
2539
|
}
|
|
@@ -2542,13 +2542,13 @@ export interface DescribeApplicationAssociationsRequest {
|
|
|
2542
2542
|
*/
|
|
2543
2543
|
export interface DescribeApplicationAssociationsResult {
|
|
2544
2544
|
/**
|
|
2545
|
-
* @public
|
|
2546
2545
|
* <p>List of associations and information about them.</p>
|
|
2546
|
+
* @public
|
|
2547
2547
|
*/
|
|
2548
2548
|
Associations?: ApplicationResourceAssociation[];
|
|
2549
2549
|
/**
|
|
2550
|
-
* @public
|
|
2551
2550
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>
|
|
2551
|
+
* @public
|
|
2552
2552
|
*/
|
|
2553
2553
|
NextToken?: string;
|
|
2554
2554
|
}
|
|
@@ -2569,38 +2569,38 @@ export type WorkSpaceApplicationLicenseType = (typeof WorkSpaceApplicationLicens
|
|
|
2569
2569
|
*/
|
|
2570
2570
|
export interface DescribeApplicationsRequest {
|
|
2571
2571
|
/**
|
|
2572
|
-
* @public
|
|
2573
2572
|
* <p>The identifiers of one or more applications.</p>
|
|
2573
|
+
* @public
|
|
2574
2574
|
*/
|
|
2575
2575
|
ApplicationIds?: string[];
|
|
2576
2576
|
/**
|
|
2577
|
-
* @public
|
|
2578
2577
|
* <p>The compute types supported by the applications.</p>
|
|
2578
|
+
* @public
|
|
2579
2579
|
*/
|
|
2580
2580
|
ComputeTypeNames?: Compute[];
|
|
2581
2581
|
/**
|
|
2582
|
-
* @public
|
|
2583
2582
|
* <p>The license availability for the applications.</p>
|
|
2583
|
+
* @public
|
|
2584
2584
|
*/
|
|
2585
2585
|
LicenseType?: WorkSpaceApplicationLicenseType;
|
|
2586
2586
|
/**
|
|
2587
|
-
* @public
|
|
2588
2587
|
* <p>The operating systems supported by the applications.</p>
|
|
2588
|
+
* @public
|
|
2589
2589
|
*/
|
|
2590
2590
|
OperatingSystemNames?: OperatingSystemName[];
|
|
2591
2591
|
/**
|
|
2592
|
-
* @public
|
|
2593
2592
|
* <p>The owner of the applications.</p>
|
|
2593
|
+
* @public
|
|
2594
2594
|
*/
|
|
2595
2595
|
Owner?: string;
|
|
2596
2596
|
/**
|
|
2597
|
-
* @public
|
|
2598
2597
|
* <p>The maximum number of applications to return.</p>
|
|
2598
|
+
* @public
|
|
2599
2599
|
*/
|
|
2600
2600
|
MaxResults?: number;
|
|
2601
2601
|
/**
|
|
2602
|
-
* @public
|
|
2603
2602
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>
|
|
2603
|
+
* @public
|
|
2604
2604
|
*/
|
|
2605
2605
|
NextToken?: string;
|
|
2606
2606
|
}
|
|
@@ -2619,53 +2619,53 @@ export declare const WorkSpaceApplicationState: {
|
|
|
2619
2619
|
*/
|
|
2620
2620
|
export type WorkSpaceApplicationState = (typeof WorkSpaceApplicationState)[keyof typeof WorkSpaceApplicationState];
|
|
2621
2621
|
/**
|
|
2622
|
-
* @public
|
|
2623
2622
|
* <p>Describes the WorkSpace application.</p>
|
|
2623
|
+
* @public
|
|
2624
2624
|
*/
|
|
2625
2625
|
export interface WorkSpaceApplication {
|
|
2626
2626
|
/**
|
|
2627
|
-
* @public
|
|
2628
2627
|
* <p>The identifier of the application.</p>
|
|
2628
|
+
* @public
|
|
2629
2629
|
*/
|
|
2630
2630
|
ApplicationId?: string;
|
|
2631
2631
|
/**
|
|
2632
|
-
* @public
|
|
2633
2632
|
* <p>The time the application is created.</p>
|
|
2633
|
+
* @public
|
|
2634
2634
|
*/
|
|
2635
2635
|
Created?: Date;
|
|
2636
2636
|
/**
|
|
2637
|
-
* @public
|
|
2638
2637
|
* <p>The description of the WorkSpace application.</p>
|
|
2638
|
+
* @public
|
|
2639
2639
|
*/
|
|
2640
2640
|
Description?: string;
|
|
2641
2641
|
/**
|
|
2642
|
-
* @public
|
|
2643
2642
|
* <p>The license availability for the applications.</p>
|
|
2643
|
+
* @public
|
|
2644
2644
|
*/
|
|
2645
2645
|
LicenseType?: WorkSpaceApplicationLicenseType;
|
|
2646
2646
|
/**
|
|
2647
|
-
* @public
|
|
2648
2647
|
* <p>The name of the WorkSpace application.</p>
|
|
2648
|
+
* @public
|
|
2649
2649
|
*/
|
|
2650
2650
|
Name?: string;
|
|
2651
2651
|
/**
|
|
2652
|
-
* @public
|
|
2653
2652
|
* <p>The owner of the WorkSpace application.</p>
|
|
2653
|
+
* @public
|
|
2654
2654
|
*/
|
|
2655
2655
|
Owner?: string;
|
|
2656
2656
|
/**
|
|
2657
|
-
* @public
|
|
2658
2657
|
* <p>The status of WorkSpace application.</p>
|
|
2658
|
+
* @public
|
|
2659
2659
|
*/
|
|
2660
2660
|
State?: WorkSpaceApplicationState;
|
|
2661
2661
|
/**
|
|
2662
|
-
* @public
|
|
2663
2662
|
* <p>The supported compute types of the WorkSpace application.</p>
|
|
2663
|
+
* @public
|
|
2664
2664
|
*/
|
|
2665
2665
|
SupportedComputeTypeNames?: Compute[];
|
|
2666
2666
|
/**
|
|
2667
|
-
* @public
|
|
2668
2667
|
* <p>The supported operating systems of the WorkSpace application.</p>
|
|
2668
|
+
* @public
|
|
2669
2669
|
*/
|
|
2670
2670
|
SupportedOperatingSystemNames?: OperatingSystemName[];
|
|
2671
2671
|
}
|
|
@@ -2674,13 +2674,13 @@ export interface WorkSpaceApplication {
|
|
|
2674
2674
|
*/
|
|
2675
2675
|
export interface DescribeApplicationsResult {
|
|
2676
2676
|
/**
|
|
2677
|
-
* @public
|
|
2678
2677
|
* <p>List of information about the specified applications.</p>
|
|
2678
|
+
* @public
|
|
2679
2679
|
*/
|
|
2680
2680
|
Applications?: WorkSpaceApplication[];
|
|
2681
2681
|
/**
|
|
2682
|
-
* @public
|
|
2683
2682
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>
|
|
2683
|
+
* @public
|
|
2684
2684
|
*/
|
|
2685
2685
|
NextToken?: string;
|
|
2686
2686
|
}
|
|
@@ -2689,13 +2689,13 @@ export interface DescribeApplicationsResult {
|
|
|
2689
2689
|
*/
|
|
2690
2690
|
export interface DescribeBundleAssociationsRequest {
|
|
2691
2691
|
/**
|
|
2692
|
-
* @public
|
|
2693
2692
|
* <p>The identifier of the bundle.</p>
|
|
2693
|
+
* @public
|
|
2694
2694
|
*/
|
|
2695
2695
|
BundleId: string | undefined;
|
|
2696
2696
|
/**
|
|
2697
|
-
* @public
|
|
2698
2697
|
* <p>The resource types of the associated resource.</p>
|
|
2698
|
+
* @public
|
|
2699
2699
|
*/
|
|
2700
2700
|
AssociatedResourceTypes: BundleAssociatedResourceType[] | undefined;
|
|
2701
2701
|
}
|
|
@@ -2704,8 +2704,8 @@ export interface DescribeBundleAssociationsRequest {
|
|
|
2704
2704
|
*/
|
|
2705
2705
|
export interface DescribeBundleAssociationsResult {
|
|
2706
2706
|
/**
|
|
2707
|
-
* @public
|
|
2708
2707
|
* <p>List of information about the specified associations.</p>
|
|
2708
|
+
* @public
|
|
2709
2709
|
*/
|
|
2710
2710
|
Associations?: BundleResourceAssociation[];
|
|
2711
2711
|
}
|
|
@@ -2714,32 +2714,31 @@ export interface DescribeBundleAssociationsResult {
|
|
|
2714
2714
|
*/
|
|
2715
2715
|
export interface DescribeClientBrandingRequest {
|
|
2716
2716
|
/**
|
|
2717
|
-
* @public
|
|
2718
2717
|
* <p>The directory identifier of the WorkSpace for which you want to view client branding
|
|
2719
2718
|
* information.</p>
|
|
2719
|
+
* @public
|
|
2720
2720
|
*/
|
|
2721
2721
|
ResourceId: string | undefined;
|
|
2722
2722
|
}
|
|
2723
2723
|
/**
|
|
2724
|
-
* @public
|
|
2725
2724
|
* <p>The client branding attributes for iOS device types. These attributes are displayed on
|
|
2726
2725
|
* the iOS client login screen only.</p>
|
|
2727
2726
|
* <important>
|
|
2728
2727
|
* <p>Client branding attributes are public facing. Ensure you do not include sensitive
|
|
2729
2728
|
* information.</p>
|
|
2730
2729
|
* </important>
|
|
2730
|
+
* @public
|
|
2731
2731
|
*/
|
|
2732
2732
|
export interface IosClientBrandingAttributes {
|
|
2733
2733
|
/**
|
|
2734
|
-
* @public
|
|
2735
2734
|
* <p>The logo. This is the standard-resolution display that has a 1:1 pixel density
|
|
2736
2735
|
* (or @1x), where one pixel is equal
|
|
2737
2736
|
* to one point. The only image format accepted is a binary data object that is converted from
|
|
2738
2737
|
* a <code>.png</code> file.</p>
|
|
2738
|
+
* @public
|
|
2739
2739
|
*/
|
|
2740
2740
|
LogoUrl?: string;
|
|
2741
2741
|
/**
|
|
2742
|
-
* @public
|
|
2743
2742
|
* <p>The @2x version of the logo. This is the higher resolution display that offers a scale
|
|
2744
2743
|
* factor of 2.0 (or @2x). The only image format accepted is a binary data object that is
|
|
2745
2744
|
* converted from a <code>.png</code> file.</p>
|
|
@@ -2747,10 +2746,10 @@ export interface IosClientBrandingAttributes {
|
|
|
2747
2746
|
* <p> For more information about iOS image size and resolution, see <a href="https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/">Image Size and Resolution </a> in the <i>Apple Human Interface
|
|
2748
2747
|
* Guidelines</i>.</p>
|
|
2749
2748
|
* </note>
|
|
2749
|
+
* @public
|
|
2750
2750
|
*/
|
|
2751
2751
|
Logo2xUrl?: string;
|
|
2752
2752
|
/**
|
|
2753
|
-
* @public
|
|
2754
2753
|
* <p>The @3x version of the logo. This is the higher resolution display that offers a scale
|
|
2755
2754
|
* factor of 3.0 (or @3x).The only image format accepted is a binary data object that is
|
|
2756
2755
|
* converted from a <code>.png</code> file.</p>
|
|
@@ -2758,10 +2757,10 @@ export interface IosClientBrandingAttributes {
|
|
|
2758
2757
|
* <p> For more information about iOS image size and resolution, see <a href="https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/">Image Size and Resolution </a> in the <i>Apple Human Interface
|
|
2759
2758
|
* Guidelines</i>.</p>
|
|
2760
2759
|
* </note>
|
|
2760
|
+
* @public
|
|
2761
2761
|
*/
|
|
2762
2762
|
Logo3xUrl?: string;
|
|
2763
2763
|
/**
|
|
2764
|
-
* @public
|
|
2765
2764
|
* <p>The support email. The company's customer support email address.</p>
|
|
2766
2765
|
* <note>
|
|
2767
2766
|
* <ul>
|
|
@@ -2775,10 +2774,10 @@ export interface IosClientBrandingAttributes {
|
|
|
2775
2774
|
* </li>
|
|
2776
2775
|
* </ul>
|
|
2777
2776
|
* </note>
|
|
2777
|
+
* @public
|
|
2778
2778
|
*/
|
|
2779
2779
|
SupportEmail?: string;
|
|
2780
2780
|
/**
|
|
2781
|
-
* @public
|
|
2782
2781
|
* <p>The support link. The link for the company's customer support page for their
|
|
2783
2782
|
* WorkSpace.</p>
|
|
2784
2783
|
* <note>
|
|
@@ -2793,20 +2792,21 @@ export interface IosClientBrandingAttributes {
|
|
|
2793
2792
|
* </li>
|
|
2794
2793
|
* </ul>
|
|
2795
2794
|
* </note>
|
|
2795
|
+
* @public
|
|
2796
2796
|
*/
|
|
2797
2797
|
SupportLink?: string;
|
|
2798
2798
|
/**
|
|
2799
|
-
* @public
|
|
2800
2799
|
* <p>The forgotten password link. This is the web address that users can go to if they forget
|
|
2801
2800
|
* the password for their WorkSpace.</p>
|
|
2801
|
+
* @public
|
|
2802
2802
|
*/
|
|
2803
2803
|
ForgotPasswordLink?: string;
|
|
2804
2804
|
/**
|
|
2805
|
-
* @public
|
|
2806
2805
|
* <p>The login message. Specified as a key value pair, in which the key is a locale and the
|
|
2807
2806
|
* value is the localized message for that locale. The only key supported is
|
|
2808
2807
|
* <code>en_US</code>. The HTML tags supported include the following: <code>a, b, blockquote, br, cite, code, dd, dl, dt, div, em,
|
|
2809
2808
|
* i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul</code>.</p>
|
|
2809
|
+
* @public
|
|
2810
2810
|
*/
|
|
2811
2811
|
LoginMessage?: Record<string, string>;
|
|
2812
2812
|
}
|
|
@@ -2815,33 +2815,33 @@ export interface IosClientBrandingAttributes {
|
|
|
2815
2815
|
*/
|
|
2816
2816
|
export interface DescribeClientBrandingResult {
|
|
2817
2817
|
/**
|
|
2818
|
-
* @public
|
|
2819
2818
|
* <p>The branding information for Windows devices.</p>
|
|
2819
|
+
* @public
|
|
2820
2820
|
*/
|
|
2821
2821
|
DeviceTypeWindows?: DefaultClientBrandingAttributes;
|
|
2822
2822
|
/**
|
|
2823
|
-
* @public
|
|
2824
2823
|
* <p>The branding information for macOS devices.</p>
|
|
2824
|
+
* @public
|
|
2825
2825
|
*/
|
|
2826
2826
|
DeviceTypeOsx?: DefaultClientBrandingAttributes;
|
|
2827
2827
|
/**
|
|
2828
|
-
* @public
|
|
2829
2828
|
* <p>The branding information for Android devices.</p>
|
|
2829
|
+
* @public
|
|
2830
2830
|
*/
|
|
2831
2831
|
DeviceTypeAndroid?: DefaultClientBrandingAttributes;
|
|
2832
2832
|
/**
|
|
2833
|
-
* @public
|
|
2834
2833
|
* <p>The branding information for iOS devices.</p>
|
|
2834
|
+
* @public
|
|
2835
2835
|
*/
|
|
2836
2836
|
DeviceTypeIos?: IosClientBrandingAttributes;
|
|
2837
2837
|
/**
|
|
2838
|
-
* @public
|
|
2839
2838
|
* <p>The branding information for Linux devices.</p>
|
|
2839
|
+
* @public
|
|
2840
2840
|
*/
|
|
2841
2841
|
DeviceTypeLinux?: DefaultClientBrandingAttributes;
|
|
2842
2842
|
/**
|
|
2843
|
-
* @public
|
|
2844
2843
|
* <p>The branding information for Web access.</p>
|
|
2844
|
+
* @public
|
|
2845
2845
|
*/
|
|
2846
2846
|
DeviceTypeWeb?: DefaultClientBrandingAttributes;
|
|
2847
2847
|
}
|
|
@@ -2850,8 +2850,8 @@ export interface DescribeClientBrandingResult {
|
|
|
2850
2850
|
*/
|
|
2851
2851
|
export interface DescribeClientPropertiesRequest {
|
|
2852
2852
|
/**
|
|
2853
|
-
* @public
|
|
2854
2853
|
* <p>The resource identifier, in the form of directory IDs.</p>
|
|
2854
|
+
* @public
|
|
2855
2855
|
*/
|
|
2856
2856
|
ResourceIds: string[] | undefined;
|
|
2857
2857
|
}
|
|
@@ -2860,8 +2860,8 @@ export interface DescribeClientPropertiesRequest {
|
|
|
2860
2860
|
*/
|
|
2861
2861
|
export interface DescribeClientPropertiesResult {
|
|
2862
2862
|
/**
|
|
2863
|
-
* @public
|
|
2864
2863
|
* <p>Information about the specified Amazon WorkSpaces clients.</p>
|
|
2864
|
+
* @public
|
|
2865
2865
|
*/
|
|
2866
2866
|
ClientPropertiesList?: ClientPropertiesResult[];
|
|
2867
2867
|
}
|
|
@@ -2870,19 +2870,19 @@ export interface DescribeClientPropertiesResult {
|
|
|
2870
2870
|
*/
|
|
2871
2871
|
export interface DescribeConnectClientAddInsRequest {
|
|
2872
2872
|
/**
|
|
2873
|
-
* @public
|
|
2874
2873
|
* <p>The directory identifier for which the client add-in is configured.</p>
|
|
2874
|
+
* @public
|
|
2875
2875
|
*/
|
|
2876
2876
|
ResourceId: string | undefined;
|
|
2877
2877
|
/**
|
|
2878
|
-
* @public
|
|
2879
2878
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
2880
2879
|
* provide this token to receive the next set of results.</p>
|
|
2880
|
+
* @public
|
|
2881
2881
|
*/
|
|
2882
2882
|
NextToken?: string;
|
|
2883
2883
|
/**
|
|
2884
|
-
* @public
|
|
2885
2884
|
* <p>The maximum number of items to return.</p>
|
|
2885
|
+
* @public
|
|
2886
2886
|
*/
|
|
2887
2887
|
MaxResults?: number;
|
|
2888
2888
|
}
|
|
@@ -2891,14 +2891,14 @@ export interface DescribeConnectClientAddInsRequest {
|
|
|
2891
2891
|
*/
|
|
2892
2892
|
export interface DescribeConnectClientAddInsResult {
|
|
2893
2893
|
/**
|
|
2894
|
-
* @public
|
|
2895
2894
|
* <p>Information about client add-ins.</p>
|
|
2895
|
+
* @public
|
|
2896
2896
|
*/
|
|
2897
2897
|
AddIns?: ConnectClientAddIn[];
|
|
2898
2898
|
/**
|
|
2899
|
-
* @public
|
|
2900
2899
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2901
2900
|
* no more results to return. </p>
|
|
2901
|
+
* @public
|
|
2902
2902
|
*/
|
|
2903
2903
|
NextToken?: string;
|
|
2904
2904
|
}
|
|
@@ -2907,24 +2907,24 @@ export interface DescribeConnectClientAddInsResult {
|
|
|
2907
2907
|
*/
|
|
2908
2908
|
export interface DescribeConnectionAliasesRequest {
|
|
2909
2909
|
/**
|
|
2910
|
-
* @public
|
|
2911
2910
|
* <p>The identifiers of the connection aliases to describe.</p>
|
|
2911
|
+
* @public
|
|
2912
2912
|
*/
|
|
2913
2913
|
AliasIds?: string[];
|
|
2914
2914
|
/**
|
|
2915
|
-
* @public
|
|
2916
2915
|
* <p>The identifier of the directory associated with the connection alias.</p>
|
|
2916
|
+
* @public
|
|
2917
2917
|
*/
|
|
2918
2918
|
ResourceId?: string;
|
|
2919
2919
|
/**
|
|
2920
|
-
* @public
|
|
2921
2920
|
* <p>The maximum number of connection aliases to return.</p>
|
|
2921
|
+
* @public
|
|
2922
2922
|
*/
|
|
2923
2923
|
Limit?: number;
|
|
2924
2924
|
/**
|
|
2925
|
-
* @public
|
|
2926
2925
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
2927
2926
|
* provide this token to receive the next set of results. </p>
|
|
2927
|
+
* @public
|
|
2928
2928
|
*/
|
|
2929
2929
|
NextToken?: string;
|
|
2930
2930
|
}
|
|
@@ -2933,14 +2933,14 @@ export interface DescribeConnectionAliasesRequest {
|
|
|
2933
2933
|
*/
|
|
2934
2934
|
export interface DescribeConnectionAliasesResult {
|
|
2935
2935
|
/**
|
|
2936
|
-
* @public
|
|
2937
2936
|
* <p>Information about the specified connection aliases.</p>
|
|
2937
|
+
* @public
|
|
2938
2938
|
*/
|
|
2939
2939
|
ConnectionAliases?: ConnectionAlias[];
|
|
2940
2940
|
/**
|
|
2941
|
-
* @public
|
|
2942
2941
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2943
2942
|
* no more results to return. </p>
|
|
2943
|
+
* @public
|
|
2944
2944
|
*/
|
|
2945
2945
|
NextToken?: string;
|
|
2946
2946
|
}
|
|
@@ -2949,19 +2949,19 @@ export interface DescribeConnectionAliasesResult {
|
|
|
2949
2949
|
*/
|
|
2950
2950
|
export interface DescribeConnectionAliasPermissionsRequest {
|
|
2951
2951
|
/**
|
|
2952
|
-
* @public
|
|
2953
2952
|
* <p>The identifier of the connection alias.</p>
|
|
2953
|
+
* @public
|
|
2954
2954
|
*/
|
|
2955
2955
|
AliasId: string | undefined;
|
|
2956
2956
|
/**
|
|
2957
|
-
* @public
|
|
2958
2957
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
2959
2958
|
* provide this token to receive the next set of results. </p>
|
|
2959
|
+
* @public
|
|
2960
2960
|
*/
|
|
2961
2961
|
NextToken?: string;
|
|
2962
2962
|
/**
|
|
2963
|
-
* @public
|
|
2964
2963
|
* <p>The maximum number of results to return.</p>
|
|
2964
|
+
* @public
|
|
2965
2965
|
*/
|
|
2966
2966
|
MaxResults?: number;
|
|
2967
2967
|
}
|
|
@@ -2970,19 +2970,19 @@ export interface DescribeConnectionAliasPermissionsRequest {
|
|
|
2970
2970
|
*/
|
|
2971
2971
|
export interface DescribeConnectionAliasPermissionsResult {
|
|
2972
2972
|
/**
|
|
2973
|
-
* @public
|
|
2974
2973
|
* <p>The identifier of the connection alias.</p>
|
|
2974
|
+
* @public
|
|
2975
2975
|
*/
|
|
2976
2976
|
AliasId?: string;
|
|
2977
2977
|
/**
|
|
2978
|
-
* @public
|
|
2979
2978
|
* <p>The permissions associated with a connection alias.</p>
|
|
2979
|
+
* @public
|
|
2980
2980
|
*/
|
|
2981
2981
|
ConnectionAliasPermissions?: ConnectionAliasPermission[];
|
|
2982
2982
|
/**
|
|
2983
|
-
* @public
|
|
2984
2983
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
2985
2984
|
* no more results to return. </p>
|
|
2985
|
+
* @public
|
|
2986
2986
|
*/
|
|
2987
2987
|
NextToken?: string;
|
|
2988
2988
|
}
|
|
@@ -3002,54 +3002,54 @@ export type ImageAssociatedResourceType = (typeof ImageAssociatedResourceType)[k
|
|
|
3002
3002
|
*/
|
|
3003
3003
|
export interface DescribeImageAssociationsRequest {
|
|
3004
3004
|
/**
|
|
3005
|
-
* @public
|
|
3006
3005
|
* <p>The identifier of the image.</p>
|
|
3006
|
+
* @public
|
|
3007
3007
|
*/
|
|
3008
3008
|
ImageId: string | undefined;
|
|
3009
3009
|
/**
|
|
3010
|
-
* @public
|
|
3011
3010
|
* <p>The resource types of the associated resource.</p>
|
|
3011
|
+
* @public
|
|
3012
3012
|
*/
|
|
3013
3013
|
AssociatedResourceTypes: ImageAssociatedResourceType[] | undefined;
|
|
3014
3014
|
}
|
|
3015
3015
|
/**
|
|
3016
|
-
* @public
|
|
3017
3016
|
* <p>Describes the association between an application and an image resource.</p>
|
|
3017
|
+
* @public
|
|
3018
3018
|
*/
|
|
3019
3019
|
export interface ImageResourceAssociation {
|
|
3020
3020
|
/**
|
|
3021
|
-
* @public
|
|
3022
3021
|
* <p>The identifier of the associated resource.</p>
|
|
3022
|
+
* @public
|
|
3023
3023
|
*/
|
|
3024
3024
|
AssociatedResourceId?: string;
|
|
3025
3025
|
/**
|
|
3026
|
-
* @public
|
|
3027
3026
|
* <p>The resource type of the associated resources.</p>
|
|
3027
|
+
* @public
|
|
3028
3028
|
*/
|
|
3029
3029
|
AssociatedResourceType?: ImageAssociatedResourceType;
|
|
3030
3030
|
/**
|
|
3031
|
-
* @public
|
|
3032
3031
|
* <p>The time the association is created.</p>
|
|
3032
|
+
* @public
|
|
3033
3033
|
*/
|
|
3034
3034
|
Created?: Date;
|
|
3035
3035
|
/**
|
|
3036
|
-
* @public
|
|
3037
3036
|
* <p>The time the association status was last updated.</p>
|
|
3037
|
+
* @public
|
|
3038
3038
|
*/
|
|
3039
3039
|
LastUpdatedTime?: Date;
|
|
3040
3040
|
/**
|
|
3041
|
-
* @public
|
|
3042
3041
|
* <p>The identifier of the image.</p>
|
|
3042
|
+
* @public
|
|
3043
3043
|
*/
|
|
3044
3044
|
ImageId?: string;
|
|
3045
3045
|
/**
|
|
3046
|
-
* @public
|
|
3047
3046
|
* <p>The status of the image resource association.</p>
|
|
3047
|
+
* @public
|
|
3048
3048
|
*/
|
|
3049
3049
|
State?: AssociationState;
|
|
3050
3050
|
/**
|
|
3051
|
-
* @public
|
|
3052
3051
|
* <p>The reason the association deployment failed.</p>
|
|
3052
|
+
* @public
|
|
3053
3053
|
*/
|
|
3054
3054
|
StateReason?: AssociationStateReason;
|
|
3055
3055
|
}
|
|
@@ -3058,8 +3058,8 @@ export interface ImageResourceAssociation {
|
|
|
3058
3058
|
*/
|
|
3059
3059
|
export interface DescribeImageAssociationsResult {
|
|
3060
3060
|
/**
|
|
3061
|
-
* @public
|
|
3062
3061
|
* <p>List of information about the specified associations.</p>
|
|
3062
|
+
* @public
|
|
3063
3063
|
*/
|
|
3064
3064
|
Associations?: ImageResourceAssociation[];
|
|
3065
3065
|
}
|
|
@@ -3068,45 +3068,45 @@ export interface DescribeImageAssociationsResult {
|
|
|
3068
3068
|
*/
|
|
3069
3069
|
export interface DescribeIpGroupsRequest {
|
|
3070
3070
|
/**
|
|
3071
|
-
* @public
|
|
3072
3071
|
* <p>The identifiers of one or more IP access control groups.</p>
|
|
3072
|
+
* @public
|
|
3073
3073
|
*/
|
|
3074
3074
|
GroupIds?: string[];
|
|
3075
3075
|
/**
|
|
3076
|
-
* @public
|
|
3077
3076
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
3078
3077
|
* provide this token to receive the next set of results.</p>
|
|
3078
|
+
* @public
|
|
3079
3079
|
*/
|
|
3080
3080
|
NextToken?: string;
|
|
3081
3081
|
/**
|
|
3082
|
-
* @public
|
|
3083
3082
|
* <p>The maximum number of items to return.</p>
|
|
3083
|
+
* @public
|
|
3084
3084
|
*/
|
|
3085
3085
|
MaxResults?: number;
|
|
3086
3086
|
}
|
|
3087
3087
|
/**
|
|
3088
|
-
* @public
|
|
3089
3088
|
* <p>Describes an IP access control group.</p>
|
|
3089
|
+
* @public
|
|
3090
3090
|
*/
|
|
3091
3091
|
export interface WorkspacesIpGroup {
|
|
3092
3092
|
/**
|
|
3093
|
-
* @public
|
|
3094
3093
|
* <p>The identifier of the group.</p>
|
|
3094
|
+
* @public
|
|
3095
3095
|
*/
|
|
3096
3096
|
groupId?: string;
|
|
3097
3097
|
/**
|
|
3098
|
-
* @public
|
|
3099
3098
|
* <p>The name of the group.</p>
|
|
3099
|
+
* @public
|
|
3100
3100
|
*/
|
|
3101
3101
|
groupName?: string;
|
|
3102
3102
|
/**
|
|
3103
|
-
* @public
|
|
3104
3103
|
* <p>The description of the group.</p>
|
|
3104
|
+
* @public
|
|
3105
3105
|
*/
|
|
3106
3106
|
groupDesc?: string;
|
|
3107
3107
|
/**
|
|
3108
|
-
* @public
|
|
3109
3108
|
* <p>The rules.</p>
|
|
3109
|
+
* @public
|
|
3110
3110
|
*/
|
|
3111
3111
|
userRules?: IpRuleItem[];
|
|
3112
3112
|
}
|
|
@@ -3115,14 +3115,14 @@ export interface WorkspacesIpGroup {
|
|
|
3115
3115
|
*/
|
|
3116
3116
|
export interface DescribeIpGroupsResult {
|
|
3117
3117
|
/**
|
|
3118
|
-
* @public
|
|
3119
3118
|
* <p>Information about the IP access control groups.</p>
|
|
3119
|
+
* @public
|
|
3120
3120
|
*/
|
|
3121
3121
|
Result?: WorkspacesIpGroup[];
|
|
3122
3122
|
/**
|
|
3123
|
-
* @public
|
|
3124
3123
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
3125
3124
|
* no more results to return. </p>
|
|
3125
|
+
* @public
|
|
3126
3126
|
*/
|
|
3127
3127
|
NextToken?: string;
|
|
3128
3128
|
}
|
|
@@ -3131,10 +3131,10 @@ export interface DescribeIpGroupsResult {
|
|
|
3131
3131
|
*/
|
|
3132
3132
|
export interface DescribeTagsRequest {
|
|
3133
3133
|
/**
|
|
3134
|
-
* @public
|
|
3135
3134
|
* <p>The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,
|
|
3136
3135
|
* registered directories, images, custom bundles, IP access control groups, and connection
|
|
3137
3136
|
* aliases.</p>
|
|
3137
|
+
* @public
|
|
3138
3138
|
*/
|
|
3139
3139
|
ResourceId: string | undefined;
|
|
3140
3140
|
}
|
|
@@ -3143,8 +3143,8 @@ export interface DescribeTagsRequest {
|
|
|
3143
3143
|
*/
|
|
3144
3144
|
export interface DescribeTagsResult {
|
|
3145
3145
|
/**
|
|
3146
|
-
* @public
|
|
3147
3146
|
* <p>The tags.</p>
|
|
3147
|
+
* @public
|
|
3148
3148
|
*/
|
|
3149
3149
|
TagList?: Tag[];
|
|
3150
3150
|
}
|
|
@@ -3153,13 +3153,13 @@ export interface DescribeTagsResult {
|
|
|
3153
3153
|
*/
|
|
3154
3154
|
export interface DescribeWorkspaceAssociationsRequest {
|
|
3155
3155
|
/**
|
|
3156
|
-
* @public
|
|
3157
3156
|
* <p>The identifier of the WorkSpace.</p>
|
|
3157
|
+
* @public
|
|
3158
3158
|
*/
|
|
3159
3159
|
WorkspaceId: string | undefined;
|
|
3160
3160
|
/**
|
|
3161
|
-
* @public
|
|
3162
3161
|
* <p>The resource types of the associated resources.</p>
|
|
3162
|
+
* @public
|
|
3163
3163
|
*/
|
|
3164
3164
|
AssociatedResourceTypes: WorkSpaceAssociatedResourceType[] | undefined;
|
|
3165
3165
|
}
|
|
@@ -3168,8 +3168,8 @@ export interface DescribeWorkspaceAssociationsRequest {
|
|
|
3168
3168
|
*/
|
|
3169
3169
|
export interface DescribeWorkspaceAssociationsResult {
|
|
3170
3170
|
/**
|
|
3171
|
-
* @public
|
|
3172
3171
|
* <p>List of information about the specified associations.</p>
|
|
3172
|
+
* @public
|
|
3173
3173
|
*/
|
|
3174
3174
|
Associations?: WorkspaceResourceAssociation[];
|
|
3175
3175
|
}
|
|
@@ -3178,20 +3178,20 @@ export interface DescribeWorkspaceAssociationsResult {
|
|
|
3178
3178
|
*/
|
|
3179
3179
|
export interface DescribeWorkspaceBundlesRequest {
|
|
3180
3180
|
/**
|
|
3181
|
-
* @public
|
|
3182
3181
|
* <p>The identifiers of the bundles. You cannot combine this parameter with any other filter.</p>
|
|
3182
|
+
* @public
|
|
3183
3183
|
*/
|
|
3184
3184
|
BundleIds?: string[];
|
|
3185
3185
|
/**
|
|
3186
|
-
* @public
|
|
3187
3186
|
* <p>The owner of the bundles. You cannot combine this parameter with any other filter.</p>
|
|
3188
3187
|
* <p>To describe the bundles provided by Amazon Web Services, specify <code>AMAZON</code>.
|
|
3189
3188
|
* To describe the bundles that belong to your account, don't specify a value.</p>
|
|
3189
|
+
* @public
|
|
3190
3190
|
*/
|
|
3191
3191
|
Owner?: string;
|
|
3192
3192
|
/**
|
|
3193
|
-
* @public
|
|
3194
3193
|
* <p>The token for the next set of results. (You received this token from a previous call.)</p>
|
|
3194
|
+
* @public
|
|
3195
3195
|
*/
|
|
3196
3196
|
NextToken?: string;
|
|
3197
3197
|
}
|
|
@@ -3200,15 +3200,15 @@ export interface DescribeWorkspaceBundlesRequest {
|
|
|
3200
3200
|
*/
|
|
3201
3201
|
export interface DescribeWorkspaceBundlesResult {
|
|
3202
3202
|
/**
|
|
3203
|
-
* @public
|
|
3204
3203
|
* <p>Information about the bundles.</p>
|
|
3204
|
+
* @public
|
|
3205
3205
|
*/
|
|
3206
3206
|
Bundles?: WorkspaceBundle[];
|
|
3207
3207
|
/**
|
|
3208
|
-
* @public
|
|
3209
3208
|
* <p>The token to use to retrieve the next page of results. This value is null when there are no more
|
|
3210
3209
|
* results to return. This token is valid for one day and must be used within that time
|
|
3211
3210
|
* frame.</p>
|
|
3211
|
+
* @public
|
|
3212
3212
|
*/
|
|
3213
3213
|
NextToken?: string;
|
|
3214
3214
|
}
|
|
@@ -3217,20 +3217,20 @@ export interface DescribeWorkspaceBundlesResult {
|
|
|
3217
3217
|
*/
|
|
3218
3218
|
export interface DescribeWorkspaceDirectoriesRequest {
|
|
3219
3219
|
/**
|
|
3220
|
-
* @public
|
|
3221
3220
|
* <p>The identifiers of the directories. If the value is null, all directories are
|
|
3222
3221
|
* retrieved.</p>
|
|
3222
|
+
* @public
|
|
3223
3223
|
*/
|
|
3224
3224
|
DirectoryIds?: string[];
|
|
3225
3225
|
/**
|
|
3226
|
-
* @public
|
|
3227
3226
|
* <p>The maximum number of directories to return.</p>
|
|
3227
|
+
* @public
|
|
3228
3228
|
*/
|
|
3229
3229
|
Limit?: number;
|
|
3230
3230
|
/**
|
|
3231
|
-
* @public
|
|
3232
3231
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
3233
3232
|
* provide this token to receive the next set of results.</p>
|
|
3233
|
+
* @public
|
|
3234
3234
|
*/
|
|
3235
3235
|
NextToken?: string;
|
|
3236
3236
|
}
|
|
@@ -3260,13 +3260,12 @@ export declare const SamlStatusEnum: {
|
|
|
3260
3260
|
*/
|
|
3261
3261
|
export type SamlStatusEnum = (typeof SamlStatusEnum)[keyof typeof SamlStatusEnum];
|
|
3262
3262
|
/**
|
|
3263
|
-
* @public
|
|
3264
3263
|
* <p>Describes the enablement status, user access URL, and relay state parameter name that
|
|
3265
3264
|
* are used for configuring federation with an SAML 2.0 identity provider.</p>
|
|
3265
|
+
* @public
|
|
3266
3266
|
*/
|
|
3267
3267
|
export interface SamlProperties {
|
|
3268
3268
|
/**
|
|
3269
|
-
* @public
|
|
3270
3269
|
* <p>Indicates the status of SAML 2.0 authentication. These statuses include the following.</p>
|
|
3271
3270
|
* <ul>
|
|
3272
3271
|
* <li>
|
|
@@ -3283,55 +3282,56 @@ export interface SamlProperties {
|
|
|
3283
3282
|
* from connecting as if SAML 2.0 authentication was disabled.</p>
|
|
3284
3283
|
* </li>
|
|
3285
3284
|
* </ul>
|
|
3285
|
+
* @public
|
|
3286
3286
|
*/
|
|
3287
3287
|
Status?: SamlStatusEnum;
|
|
3288
3288
|
/**
|
|
3289
|
-
* @public
|
|
3290
3289
|
* <p>The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in
|
|
3291
3290
|
* order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP)
|
|
3292
3291
|
* bindings.</p>
|
|
3292
|
+
* @public
|
|
3293
3293
|
*/
|
|
3294
3294
|
UserAccessUrl?: string;
|
|
3295
3295
|
/**
|
|
3296
|
-
* @public
|
|
3297
3296
|
* <p>The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to
|
|
3298
3297
|
* the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query
|
|
3299
3298
|
* parameter to the URL along with the relay state endpoint to return the user to the client application session.</p>
|
|
3300
3299
|
* <p>To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state
|
|
3301
3300
|
* URL. Consult your IdP documentation for more information.</p>
|
|
3301
|
+
* @public
|
|
3302
3302
|
*/
|
|
3303
3303
|
RelayStateParameterName?: string;
|
|
3304
3304
|
}
|
|
3305
3305
|
/**
|
|
3306
|
-
* @public
|
|
3307
3306
|
* <p>Describes the self-service permissions for a directory. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html">Enable Self-Service WorkSpace Management Capabilities for Your Users</a>.</p>
|
|
3307
|
+
* @public
|
|
3308
3308
|
*/
|
|
3309
3309
|
export interface SelfservicePermissions {
|
|
3310
3310
|
/**
|
|
3311
|
-
* @public
|
|
3312
3311
|
* <p>Specifies whether users can restart their WorkSpace.</p>
|
|
3312
|
+
* @public
|
|
3313
3313
|
*/
|
|
3314
3314
|
RestartWorkspace?: ReconnectEnum;
|
|
3315
3315
|
/**
|
|
3316
|
-
* @public
|
|
3317
3316
|
* <p>Specifies whether users can increase the volume size of the drives on their
|
|
3318
3317
|
* WorkSpace.</p>
|
|
3318
|
+
* @public
|
|
3319
3319
|
*/
|
|
3320
3320
|
IncreaseVolumeSize?: ReconnectEnum;
|
|
3321
3321
|
/**
|
|
3322
|
-
* @public
|
|
3323
3322
|
* <p>Specifies whether users can change the compute type (bundle) for their WorkSpace.</p>
|
|
3323
|
+
* @public
|
|
3324
3324
|
*/
|
|
3325
3325
|
ChangeComputeType?: ReconnectEnum;
|
|
3326
3326
|
/**
|
|
3327
|
-
* @public
|
|
3328
3327
|
* <p>Specifies whether users can switch the running mode of their WorkSpace.</p>
|
|
3328
|
+
* @public
|
|
3329
3329
|
*/
|
|
3330
3330
|
SwitchRunningMode?: ReconnectEnum;
|
|
3331
3331
|
/**
|
|
3332
|
-
* @public
|
|
3333
3332
|
* <p>Specifies whether users can rebuild the operating system of a WorkSpace to its original
|
|
3334
3333
|
* state.</p>
|
|
3334
|
+
* @public
|
|
3335
3335
|
*/
|
|
3336
3336
|
RebuildWorkspace?: ReconnectEnum;
|
|
3337
3337
|
}
|
|
@@ -3363,158 +3363,158 @@ export declare const Tenancy: {
|
|
|
3363
3363
|
*/
|
|
3364
3364
|
export type Tenancy = (typeof Tenancy)[keyof typeof Tenancy];
|
|
3365
3365
|
/**
|
|
3366
|
-
* @public
|
|
3367
3366
|
* <p>The device types and operating systems that can be used to access a WorkSpace. For more
|
|
3368
3367
|
* information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-network-requirements.html">Amazon
|
|
3369
3368
|
* WorkSpaces Client Network Requirements</a>.</p>
|
|
3369
|
+
* @public
|
|
3370
3370
|
*/
|
|
3371
3371
|
export interface WorkspaceAccessProperties {
|
|
3372
3372
|
/**
|
|
3373
|
-
* @public
|
|
3374
3373
|
* <p>Indicates whether users can use Windows clients to access their WorkSpaces.</p>
|
|
3374
|
+
* @public
|
|
3375
3375
|
*/
|
|
3376
3376
|
DeviceTypeWindows?: AccessPropertyValue;
|
|
3377
3377
|
/**
|
|
3378
|
-
* @public
|
|
3379
3378
|
* <p>Indicates whether users can use macOS clients to access their WorkSpaces.</p>
|
|
3379
|
+
* @public
|
|
3380
3380
|
*/
|
|
3381
3381
|
DeviceTypeOsx?: AccessPropertyValue;
|
|
3382
3382
|
/**
|
|
3383
|
-
* @public
|
|
3384
3383
|
* <p>Indicates whether users can access their WorkSpaces through a web browser.</p>
|
|
3384
|
+
* @public
|
|
3385
3385
|
*/
|
|
3386
3386
|
DeviceTypeWeb?: AccessPropertyValue;
|
|
3387
3387
|
/**
|
|
3388
|
-
* @public
|
|
3389
3388
|
* <p>Indicates whether users can use iOS devices to access their WorkSpaces.</p>
|
|
3389
|
+
* @public
|
|
3390
3390
|
*/
|
|
3391
3391
|
DeviceTypeIos?: AccessPropertyValue;
|
|
3392
3392
|
/**
|
|
3393
|
-
* @public
|
|
3394
3393
|
* <p>Indicates whether users can use Android and Android-compatible Chrome OS devices to
|
|
3395
3394
|
* access their WorkSpaces.</p>
|
|
3395
|
+
* @public
|
|
3396
3396
|
*/
|
|
3397
3397
|
DeviceTypeAndroid?: AccessPropertyValue;
|
|
3398
3398
|
/**
|
|
3399
|
-
* @public
|
|
3400
3399
|
* <p>Indicates whether users can use Chromebooks to access their WorkSpaces.</p>
|
|
3400
|
+
* @public
|
|
3401
3401
|
*/
|
|
3402
3402
|
DeviceTypeChromeOs?: AccessPropertyValue;
|
|
3403
3403
|
/**
|
|
3404
|
-
* @public
|
|
3405
3404
|
* <p>Indicates whether users can use zero client devices to access their WorkSpaces.</p>
|
|
3405
|
+
* @public
|
|
3406
3406
|
*/
|
|
3407
3407
|
DeviceTypeZeroClient?: AccessPropertyValue;
|
|
3408
3408
|
/**
|
|
3409
|
-
* @public
|
|
3410
3409
|
* <p>Indicates whether users can use Linux clients to access their WorkSpaces.</p>
|
|
3410
|
+
* @public
|
|
3411
3411
|
*/
|
|
3412
3412
|
DeviceTypeLinux?: AccessPropertyValue;
|
|
3413
3413
|
}
|
|
3414
3414
|
/**
|
|
3415
|
-
* @public
|
|
3416
3415
|
* <p>Describes a directory that is used with Amazon WorkSpaces.</p>
|
|
3416
|
+
* @public
|
|
3417
3417
|
*/
|
|
3418
3418
|
export interface WorkspaceDirectory {
|
|
3419
3419
|
/**
|
|
3420
|
-
* @public
|
|
3421
3420
|
* <p>The directory identifier.</p>
|
|
3421
|
+
* @public
|
|
3422
3422
|
*/
|
|
3423
3423
|
DirectoryId?: string;
|
|
3424
3424
|
/**
|
|
3425
|
-
* @public
|
|
3426
3425
|
* <p>The directory alias.</p>
|
|
3426
|
+
* @public
|
|
3427
3427
|
*/
|
|
3428
3428
|
Alias?: string;
|
|
3429
3429
|
/**
|
|
3430
|
-
* @public
|
|
3431
3430
|
* <p>The name of the directory.</p>
|
|
3431
|
+
* @public
|
|
3432
3432
|
*/
|
|
3433
3433
|
DirectoryName?: string;
|
|
3434
3434
|
/**
|
|
3435
|
-
* @public
|
|
3436
3435
|
* <p>The registration code for the directory. This is the code that users enter in their
|
|
3437
3436
|
* Amazon WorkSpaces client application to connect to the directory.</p>
|
|
3437
|
+
* @public
|
|
3438
3438
|
*/
|
|
3439
3439
|
RegistrationCode?: string;
|
|
3440
3440
|
/**
|
|
3441
|
-
* @public
|
|
3442
3441
|
* <p>The identifiers of the subnets used with the directory.</p>
|
|
3442
|
+
* @public
|
|
3443
3443
|
*/
|
|
3444
3444
|
SubnetIds?: string[];
|
|
3445
3445
|
/**
|
|
3446
|
-
* @public
|
|
3447
3446
|
* <p>The IP addresses of the DNS servers for the directory.</p>
|
|
3447
|
+
* @public
|
|
3448
3448
|
*/
|
|
3449
3449
|
DnsIpAddresses?: string[];
|
|
3450
3450
|
/**
|
|
3451
|
-
* @public
|
|
3452
3451
|
* <p>The user name for the service account.</p>
|
|
3452
|
+
* @public
|
|
3453
3453
|
*/
|
|
3454
3454
|
CustomerUserName?: string;
|
|
3455
3455
|
/**
|
|
3456
|
-
* @public
|
|
3457
3456
|
* <p>The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make
|
|
3458
3457
|
* calls to other services, such as Amazon EC2, on your behalf.</p>
|
|
3458
|
+
* @public
|
|
3459
3459
|
*/
|
|
3460
3460
|
IamRoleId?: string;
|
|
3461
3461
|
/**
|
|
3462
|
-
* @public
|
|
3463
3462
|
* <p>The directory type.</p>
|
|
3463
|
+
* @public
|
|
3464
3464
|
*/
|
|
3465
3465
|
DirectoryType?: WorkspaceDirectoryType;
|
|
3466
3466
|
/**
|
|
3467
|
-
* @public
|
|
3468
3467
|
* <p>The identifier of the security group that is assigned to new WorkSpaces.</p>
|
|
3468
|
+
* @public
|
|
3469
3469
|
*/
|
|
3470
3470
|
WorkspaceSecurityGroupId?: string;
|
|
3471
3471
|
/**
|
|
3472
|
-
* @public
|
|
3473
3472
|
* <p>The state of the directory's registration with Amazon WorkSpaces. After a directory is
|
|
3474
3473
|
* deregistered, the <code>DEREGISTERED</code> state is returned very briefly before the
|
|
3475
3474
|
* directory metadata is cleaned up, so this state is rarely returned. To confirm that a
|
|
3476
3475
|
* directory is deregistered, check for the directory ID by using <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html">
|
|
3477
3476
|
* DescribeWorkspaceDirectories</a>. If the directory ID isn't returned, then the
|
|
3478
3477
|
* directory has been successfully deregistered.</p>
|
|
3478
|
+
* @public
|
|
3479
3479
|
*/
|
|
3480
3480
|
State?: WorkspaceDirectoryState;
|
|
3481
3481
|
/**
|
|
3482
|
-
* @public
|
|
3483
3482
|
* <p>The default creation properties for all WorkSpaces in the directory.</p>
|
|
3483
|
+
* @public
|
|
3484
3484
|
*/
|
|
3485
3485
|
WorkspaceCreationProperties?: DefaultWorkspaceCreationProperties;
|
|
3486
3486
|
/**
|
|
3487
|
-
* @public
|
|
3488
3487
|
* <p>The identifiers of the IP access control groups associated with the directory.</p>
|
|
3488
|
+
* @public
|
|
3489
3489
|
*/
|
|
3490
3490
|
ipGroupIds?: string[];
|
|
3491
3491
|
/**
|
|
3492
|
-
* @public
|
|
3493
3492
|
* <p>The devices and operating systems that users can use to access WorkSpaces.</p>
|
|
3493
|
+
* @public
|
|
3494
3494
|
*/
|
|
3495
3495
|
WorkspaceAccessProperties?: WorkspaceAccessProperties;
|
|
3496
3496
|
/**
|
|
3497
|
-
* @public
|
|
3498
3497
|
* <p>Specifies whether the directory is dedicated or shared. To use Bring Your Own License
|
|
3499
3498
|
* (BYOL), this value must be set to <code>DEDICATED</code>. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html">Bring
|
|
3500
3499
|
* Your Own Windows Desktop Images</a>.</p>
|
|
3500
|
+
* @public
|
|
3501
3501
|
*/
|
|
3502
3502
|
Tenancy?: Tenancy;
|
|
3503
3503
|
/**
|
|
3504
|
-
* @public
|
|
3505
3504
|
* <p>The default self-service permissions for WorkSpaces in the directory.</p>
|
|
3505
|
+
* @public
|
|
3506
3506
|
*/
|
|
3507
3507
|
SelfservicePermissions?: SelfservicePermissions;
|
|
3508
3508
|
/**
|
|
3509
|
-
* @public
|
|
3510
3509
|
* <p>Describes the enablement status, user access URL, and relay state parameter name that are used for configuring
|
|
3511
3510
|
* federation with an SAML 2.0 identity provider.</p>
|
|
3511
|
+
* @public
|
|
3512
3512
|
*/
|
|
3513
3513
|
SamlProperties?: SamlProperties;
|
|
3514
3514
|
/**
|
|
3515
|
-
* @public
|
|
3516
3515
|
* <p>The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP)
|
|
3517
3516
|
* user identities to Active Directory for WorkSpaces login.</p>
|
|
3517
|
+
* @public
|
|
3518
3518
|
*/
|
|
3519
3519
|
CertificateBasedAuthProperties?: CertificateBasedAuthProperties;
|
|
3520
3520
|
}
|
|
@@ -3523,14 +3523,14 @@ export interface WorkspaceDirectory {
|
|
|
3523
3523
|
*/
|
|
3524
3524
|
export interface DescribeWorkspaceDirectoriesResult {
|
|
3525
3525
|
/**
|
|
3526
|
-
* @public
|
|
3527
3526
|
* <p>Information about the directories.</p>
|
|
3527
|
+
* @public
|
|
3528
3528
|
*/
|
|
3529
3529
|
Directories?: WorkspaceDirectory[];
|
|
3530
3530
|
/**
|
|
3531
|
-
* @public
|
|
3532
3531
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
3533
3532
|
* no more results to return. </p>
|
|
3533
|
+
* @public
|
|
3534
3534
|
*/
|
|
3535
3535
|
NextToken?: string;
|
|
3536
3536
|
}
|
|
@@ -3539,33 +3539,33 @@ export interface DescribeWorkspaceDirectoriesResult {
|
|
|
3539
3539
|
*/
|
|
3540
3540
|
export interface DescribeWorkspaceImagePermissionsRequest {
|
|
3541
3541
|
/**
|
|
3542
|
-
* @public
|
|
3543
3542
|
* <p>The identifier of the image.</p>
|
|
3543
|
+
* @public
|
|
3544
3544
|
*/
|
|
3545
3545
|
ImageId: string | undefined;
|
|
3546
3546
|
/**
|
|
3547
|
-
* @public
|
|
3548
3547
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
3549
3548
|
* provide this token to receive the next set of results.</p>
|
|
3549
|
+
* @public
|
|
3550
3550
|
*/
|
|
3551
3551
|
NextToken?: string;
|
|
3552
3552
|
/**
|
|
3553
|
-
* @public
|
|
3554
3553
|
* <p>The maximum number of items to return.</p>
|
|
3554
|
+
* @public
|
|
3555
3555
|
*/
|
|
3556
3556
|
MaxResults?: number;
|
|
3557
3557
|
}
|
|
3558
3558
|
/**
|
|
3559
|
-
* @public
|
|
3560
3559
|
* <p>Describes the Amazon Web Services accounts that have been granted permission to use a
|
|
3561
3560
|
* shared image. For more information about sharing images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html"> Share or Unshare a Custom
|
|
3562
3561
|
* WorkSpaces Image</a>.</p>
|
|
3562
|
+
* @public
|
|
3563
3563
|
*/
|
|
3564
3564
|
export interface ImagePermission {
|
|
3565
3565
|
/**
|
|
3566
|
-
* @public
|
|
3567
3566
|
* <p>The identifier of the Amazon Web Services account that an image has been shared
|
|
3568
3567
|
* with.</p>
|
|
3568
|
+
* @public
|
|
3569
3569
|
*/
|
|
3570
3570
|
SharedAccountId?: string;
|
|
3571
3571
|
}
|
|
@@ -3574,20 +3574,20 @@ export interface ImagePermission {
|
|
|
3574
3574
|
*/
|
|
3575
3575
|
export interface DescribeWorkspaceImagePermissionsResult {
|
|
3576
3576
|
/**
|
|
3577
|
-
* @public
|
|
3578
3577
|
* <p>The identifier of the image.</p>
|
|
3578
|
+
* @public
|
|
3579
3579
|
*/
|
|
3580
3580
|
ImageId?: string;
|
|
3581
3581
|
/**
|
|
3582
|
-
* @public
|
|
3583
3582
|
* <p>The identifiers of the Amazon Web Services accounts that the image has been shared
|
|
3584
3583
|
* with.</p>
|
|
3584
|
+
* @public
|
|
3585
3585
|
*/
|
|
3586
3586
|
ImagePermissions?: ImagePermission[];
|
|
3587
3587
|
/**
|
|
3588
|
-
* @public
|
|
3589
3588
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
3590
3589
|
* no more results to return. </p>
|
|
3590
|
+
* @public
|
|
3591
3591
|
*/
|
|
3592
3592
|
NextToken?: string;
|
|
3593
3593
|
}
|
|
@@ -3608,24 +3608,24 @@ export type ImageType = (typeof ImageType)[keyof typeof ImageType];
|
|
|
3608
3608
|
*/
|
|
3609
3609
|
export interface DescribeWorkspaceImagesRequest {
|
|
3610
3610
|
/**
|
|
3611
|
-
* @public
|
|
3612
3611
|
* <p>The identifier of the image.</p>
|
|
3612
|
+
* @public
|
|
3613
3613
|
*/
|
|
3614
3614
|
ImageIds?: string[];
|
|
3615
3615
|
/**
|
|
3616
|
-
* @public
|
|
3617
3616
|
* <p>The type (owned or shared) of the image.</p>
|
|
3617
|
+
* @public
|
|
3618
3618
|
*/
|
|
3619
3619
|
ImageType?: ImageType;
|
|
3620
3620
|
/**
|
|
3621
|
-
* @public
|
|
3622
3621
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
3623
3622
|
* provide this token to receive the next set of results.</p>
|
|
3623
|
+
* @public
|
|
3624
3624
|
*/
|
|
3625
3625
|
NextToken?: string;
|
|
3626
3626
|
/**
|
|
3627
|
-
* @public
|
|
3628
3627
|
* <p>The maximum number of items to return.</p>
|
|
3628
|
+
* @public
|
|
3629
3629
|
*/
|
|
3630
3630
|
MaxResults?: number;
|
|
3631
3631
|
}
|
|
@@ -3666,112 +3666,112 @@ export declare const WorkspaceImageErrorDetailCode: {
|
|
|
3666
3666
|
*/
|
|
3667
3667
|
export type WorkspaceImageErrorDetailCode = (typeof WorkspaceImageErrorDetailCode)[keyof typeof WorkspaceImageErrorDetailCode];
|
|
3668
3668
|
/**
|
|
3669
|
-
* @public
|
|
3670
3669
|
* <p>Describes in-depth details about the error. These details include the
|
|
3671
3670
|
* possible causes of the error and troubleshooting information.</p>
|
|
3671
|
+
* @public
|
|
3672
3672
|
*/
|
|
3673
3673
|
export interface ErrorDetails {
|
|
3674
3674
|
/**
|
|
3675
|
-
* @public
|
|
3676
3675
|
* <p>Indicates the error code returned.</p>
|
|
3676
|
+
* @public
|
|
3677
3677
|
*/
|
|
3678
3678
|
ErrorCode?: WorkspaceImageErrorDetailCode;
|
|
3679
3679
|
/**
|
|
3680
|
-
* @public
|
|
3681
3680
|
* <p>The text of the error message related the error code.</p>
|
|
3681
|
+
* @public
|
|
3682
3682
|
*/
|
|
3683
3683
|
ErrorMessage?: string;
|
|
3684
3684
|
}
|
|
3685
3685
|
/**
|
|
3686
|
-
* @public
|
|
3687
3686
|
* <p>Describes whether a WorkSpace image needs to be updated with the latest drivers and
|
|
3688
3687
|
* other components required by Amazon WorkSpaces.</p>
|
|
3689
3688
|
* <note>
|
|
3690
3689
|
* <p>Only Windows 10 WorkSpace images can be programmatically updated at this time.</p>
|
|
3691
3690
|
* </note>
|
|
3691
|
+
* @public
|
|
3692
3692
|
*/
|
|
3693
3693
|
export interface UpdateResult {
|
|
3694
3694
|
/**
|
|
3695
|
-
* @public
|
|
3696
3695
|
* <p>Indicates whether updated drivers or other components are available for the specified
|
|
3697
3696
|
* WorkSpace image.</p>
|
|
3697
|
+
* @public
|
|
3698
3698
|
*/
|
|
3699
3699
|
UpdateAvailable?: boolean;
|
|
3700
3700
|
/**
|
|
3701
|
-
* @public
|
|
3702
3701
|
* <p>A description of whether updates for the WorkSpace image are pending or
|
|
3703
3702
|
* available.</p>
|
|
3703
|
+
* @public
|
|
3704
3704
|
*/
|
|
3705
3705
|
Description?: string;
|
|
3706
3706
|
}
|
|
3707
3707
|
/**
|
|
3708
|
-
* @public
|
|
3709
3708
|
* <p>Describes a WorkSpace image.</p>
|
|
3709
|
+
* @public
|
|
3710
3710
|
*/
|
|
3711
3711
|
export interface WorkspaceImage {
|
|
3712
3712
|
/**
|
|
3713
|
-
* @public
|
|
3714
3713
|
* <p>The identifier of the image.</p>
|
|
3714
|
+
* @public
|
|
3715
3715
|
*/
|
|
3716
3716
|
ImageId?: string;
|
|
3717
3717
|
/**
|
|
3718
|
-
* @public
|
|
3719
3718
|
* <p>The name of the image.</p>
|
|
3719
|
+
* @public
|
|
3720
3720
|
*/
|
|
3721
3721
|
Name?: string;
|
|
3722
3722
|
/**
|
|
3723
|
-
* @public
|
|
3724
3723
|
* <p>The description of the image.</p>
|
|
3724
|
+
* @public
|
|
3725
3725
|
*/
|
|
3726
3726
|
Description?: string;
|
|
3727
3727
|
/**
|
|
3728
|
-
* @public
|
|
3729
3728
|
* <p>The operating system that the image is running. </p>
|
|
3729
|
+
* @public
|
|
3730
3730
|
*/
|
|
3731
3731
|
OperatingSystem?: OperatingSystem;
|
|
3732
3732
|
/**
|
|
3733
|
-
* @public
|
|
3734
3733
|
* <p>The status of the image.</p>
|
|
3734
|
+
* @public
|
|
3735
3735
|
*/
|
|
3736
3736
|
State?: WorkspaceImageState;
|
|
3737
3737
|
/**
|
|
3738
|
-
* @public
|
|
3739
3738
|
* <p>Specifies whether the image is running on dedicated hardware. When Bring Your Own
|
|
3740
3739
|
* License (BYOL) is enabled, this value is set to <code>DEDICATED</code>. For more
|
|
3741
3740
|
* information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html">Bring Your Own Windows
|
|
3742
3741
|
* Desktop Images</a>.</p>
|
|
3742
|
+
* @public
|
|
3743
3743
|
*/
|
|
3744
3744
|
RequiredTenancy?: WorkspaceImageRequiredTenancy;
|
|
3745
3745
|
/**
|
|
3746
|
-
* @public
|
|
3747
3746
|
* <p>The error code that is returned for the image.</p>
|
|
3747
|
+
* @public
|
|
3748
3748
|
*/
|
|
3749
3749
|
ErrorCode?: string;
|
|
3750
3750
|
/**
|
|
3751
|
-
* @public
|
|
3752
3751
|
* <p>The text of the error message that is returned for the image.</p>
|
|
3752
|
+
* @public
|
|
3753
3753
|
*/
|
|
3754
3754
|
ErrorMessage?: string;
|
|
3755
3755
|
/**
|
|
3756
|
-
* @public
|
|
3757
3756
|
* <p>The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date
|
|
3758
3757
|
* of the image.</p>
|
|
3758
|
+
* @public
|
|
3759
3759
|
*/
|
|
3760
3760
|
Created?: Date;
|
|
3761
3761
|
/**
|
|
3762
|
-
* @public
|
|
3763
3762
|
* <p>The identifier of the Amazon Web Services account that owns the image.</p>
|
|
3763
|
+
* @public
|
|
3764
3764
|
*/
|
|
3765
3765
|
OwnerAccountId?: string;
|
|
3766
3766
|
/**
|
|
3767
|
-
* @public
|
|
3768
3767
|
* <p>The updates (if any) that are available for the specified image.</p>
|
|
3768
|
+
* @public
|
|
3769
3769
|
*/
|
|
3770
3770
|
Updates?: UpdateResult;
|
|
3771
3771
|
/**
|
|
3772
|
-
* @public
|
|
3773
3772
|
* <p>Additional details of the error returned for the image, including the
|
|
3774
3773
|
* possible causes of the errors and troubleshooting information.</p>
|
|
3774
|
+
* @public
|
|
3775
3775
|
*/
|
|
3776
3776
|
ErrorDetails?: ErrorDetails[];
|
|
3777
3777
|
}
|
|
@@ -3780,14 +3780,14 @@ export interface WorkspaceImage {
|
|
|
3780
3780
|
*/
|
|
3781
3781
|
export interface DescribeWorkspaceImagesResult {
|
|
3782
3782
|
/**
|
|
3783
|
-
* @public
|
|
3784
3783
|
* <p>Information about the images.</p>
|
|
3784
|
+
* @public
|
|
3785
3785
|
*/
|
|
3786
3786
|
Images?: WorkspaceImage[];
|
|
3787
3787
|
/**
|
|
3788
|
-
* @public
|
|
3789
3788
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
3790
3789
|
* no more results to return. </p>
|
|
3790
|
+
* @public
|
|
3791
3791
|
*/
|
|
3792
3792
|
NextToken?: string;
|
|
3793
3793
|
}
|
|
@@ -3796,46 +3796,46 @@ export interface DescribeWorkspaceImagesResult {
|
|
|
3796
3796
|
*/
|
|
3797
3797
|
export interface DescribeWorkspacesRequest {
|
|
3798
3798
|
/**
|
|
3799
|
-
* @public
|
|
3800
3799
|
* <p>The identifiers of the WorkSpaces. You cannot combine this parameter with any other
|
|
3801
3800
|
* filter.</p>
|
|
3802
3801
|
* <p>Because the <a>CreateWorkspaces</a> operation is asynchronous, the identifier
|
|
3803
3802
|
* it returns is not immediately available. If you immediately call <a>DescribeWorkspaces</a> with this identifier, no information is returned.</p>
|
|
3803
|
+
* @public
|
|
3804
3804
|
*/
|
|
3805
3805
|
WorkspaceIds?: string[];
|
|
3806
3806
|
/**
|
|
3807
|
-
* @public
|
|
3808
3807
|
* <p>The identifier of the directory. In addition, you can optionally specify a specific
|
|
3809
3808
|
* directory user (see <code>UserName</code>). You cannot combine this parameter with any
|
|
3810
3809
|
* other filter.</p>
|
|
3810
|
+
* @public
|
|
3811
3811
|
*/
|
|
3812
3812
|
DirectoryId?: string;
|
|
3813
3813
|
/**
|
|
3814
|
-
* @public
|
|
3815
3814
|
* <p>The name of the directory user. You must specify this parameter with
|
|
3816
3815
|
* <code>DirectoryId</code>.</p>
|
|
3816
|
+
* @public
|
|
3817
3817
|
*/
|
|
3818
3818
|
UserName?: string;
|
|
3819
3819
|
/**
|
|
3820
|
-
* @public
|
|
3821
3820
|
* <p>The identifier of the bundle. All WorkSpaces that are created from this bundle are
|
|
3822
3821
|
* retrieved. You cannot combine this parameter with any other filter.</p>
|
|
3822
|
+
* @public
|
|
3823
3823
|
*/
|
|
3824
3824
|
BundleId?: string;
|
|
3825
3825
|
/**
|
|
3826
|
-
* @public
|
|
3827
3826
|
* <p>The maximum number of items to return.</p>
|
|
3827
|
+
* @public
|
|
3828
3828
|
*/
|
|
3829
3829
|
Limit?: number;
|
|
3830
3830
|
/**
|
|
3831
|
-
* @public
|
|
3832
3831
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
3833
3832
|
* provide this token to receive the next set of results.</p>
|
|
3833
|
+
* @public
|
|
3834
3834
|
*/
|
|
3835
3835
|
NextToken?: string;
|
|
3836
3836
|
/**
|
|
3837
|
-
* @public
|
|
3838
3837
|
* <p>The name of the user-decoupled WorkSpace.</p>
|
|
3838
|
+
* @public
|
|
3839
3839
|
*/
|
|
3840
3840
|
WorkspaceName?: string;
|
|
3841
3841
|
}
|
|
@@ -3844,16 +3844,16 @@ export interface DescribeWorkspacesRequest {
|
|
|
3844
3844
|
*/
|
|
3845
3845
|
export interface DescribeWorkspacesResult {
|
|
3846
3846
|
/**
|
|
3847
|
-
* @public
|
|
3848
3847
|
* <p>Information about the WorkSpaces.</p>
|
|
3849
3848
|
* <p>Because <a>CreateWorkspaces</a> is an asynchronous operation, some of the
|
|
3850
3849
|
* returned information could be incomplete.</p>
|
|
3850
|
+
* @public
|
|
3851
3851
|
*/
|
|
3852
3852
|
Workspaces?: Workspace[];
|
|
3853
3853
|
/**
|
|
3854
|
-
* @public
|
|
3855
3854
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
3856
3855
|
* no more results to return. </p>
|
|
3856
|
+
* @public
|
|
3857
3857
|
*/
|
|
3858
3858
|
NextToken?: string;
|
|
3859
3859
|
}
|
|
@@ -3862,41 +3862,41 @@ export interface DescribeWorkspacesResult {
|
|
|
3862
3862
|
*/
|
|
3863
3863
|
export interface DescribeWorkspacesConnectionStatusRequest {
|
|
3864
3864
|
/**
|
|
3865
|
-
* @public
|
|
3866
3865
|
* <p>The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.</p>
|
|
3866
|
+
* @public
|
|
3867
3867
|
*/
|
|
3868
3868
|
WorkspaceIds?: string[];
|
|
3869
3869
|
/**
|
|
3870
|
-
* @public
|
|
3871
3870
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
3872
3871
|
* provide this token to receive the next set of results.</p>
|
|
3872
|
+
* @public
|
|
3873
3873
|
*/
|
|
3874
3874
|
NextToken?: string;
|
|
3875
3875
|
}
|
|
3876
3876
|
/**
|
|
3877
|
-
* @public
|
|
3878
3877
|
* <p>Describes the connection status of a WorkSpace.</p>
|
|
3878
|
+
* @public
|
|
3879
3879
|
*/
|
|
3880
3880
|
export interface WorkspaceConnectionStatus {
|
|
3881
3881
|
/**
|
|
3882
|
-
* @public
|
|
3883
3882
|
* <p>The identifier of the WorkSpace.</p>
|
|
3883
|
+
* @public
|
|
3884
3884
|
*/
|
|
3885
3885
|
WorkspaceId?: string;
|
|
3886
3886
|
/**
|
|
3887
|
-
* @public
|
|
3888
3887
|
* <p>The connection state of the WorkSpace. The connection state is unknown if the WorkSpace
|
|
3889
3888
|
* is stopped.</p>
|
|
3889
|
+
* @public
|
|
3890
3890
|
*/
|
|
3891
3891
|
ConnectionState?: ConnectionState;
|
|
3892
3892
|
/**
|
|
3893
|
-
* @public
|
|
3894
3893
|
* <p>The timestamp of the connection status check.</p>
|
|
3894
|
+
* @public
|
|
3895
3895
|
*/
|
|
3896
3896
|
ConnectionStateCheckTimestamp?: Date;
|
|
3897
3897
|
/**
|
|
3898
|
-
* @public
|
|
3899
3898
|
* <p>The timestamp of the last known user connection.</p>
|
|
3899
|
+
* @public
|
|
3900
3900
|
*/
|
|
3901
3901
|
LastKnownUserConnectionTimestamp?: Date;
|
|
3902
3902
|
}
|
|
@@ -3905,14 +3905,14 @@ export interface WorkspaceConnectionStatus {
|
|
|
3905
3905
|
*/
|
|
3906
3906
|
export interface DescribeWorkspacesConnectionStatusResult {
|
|
3907
3907
|
/**
|
|
3908
|
-
* @public
|
|
3909
3908
|
* <p>Information about the connection status of the WorkSpace.</p>
|
|
3909
|
+
* @public
|
|
3910
3910
|
*/
|
|
3911
3911
|
WorkspacesConnectionStatus?: WorkspaceConnectionStatus[];
|
|
3912
3912
|
/**
|
|
3913
|
-
* @public
|
|
3914
3913
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
3915
3914
|
* no more results to return. </p>
|
|
3915
|
+
* @public
|
|
3916
3916
|
*/
|
|
3917
3917
|
NextToken?: string;
|
|
3918
3918
|
}
|
|
@@ -3921,19 +3921,19 @@ export interface DescribeWorkspacesConnectionStatusResult {
|
|
|
3921
3921
|
*/
|
|
3922
3922
|
export interface DescribeWorkspaceSnapshotsRequest {
|
|
3923
3923
|
/**
|
|
3924
|
-
* @public
|
|
3925
3924
|
* <p>The identifier of the WorkSpace.</p>
|
|
3925
|
+
* @public
|
|
3926
3926
|
*/
|
|
3927
3927
|
WorkspaceId: string | undefined;
|
|
3928
3928
|
}
|
|
3929
3929
|
/**
|
|
3930
|
-
* @public
|
|
3931
3930
|
* <p>Describes a snapshot.</p>
|
|
3931
|
+
* @public
|
|
3932
3932
|
*/
|
|
3933
3933
|
export interface Snapshot {
|
|
3934
3934
|
/**
|
|
3935
|
-
* @public
|
|
3936
3935
|
* <p>The time when the snapshot was created.</p>
|
|
3936
|
+
* @public
|
|
3937
3937
|
*/
|
|
3938
3938
|
SnapshotTime?: Date;
|
|
3939
3939
|
}
|
|
@@ -3942,15 +3942,15 @@ export interface Snapshot {
|
|
|
3942
3942
|
*/
|
|
3943
3943
|
export interface DescribeWorkspaceSnapshotsResult {
|
|
3944
3944
|
/**
|
|
3945
|
-
* @public
|
|
3946
3945
|
* <p>Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots
|
|
3947
3946
|
* include the user volume.</p>
|
|
3947
|
+
* @public
|
|
3948
3948
|
*/
|
|
3949
3949
|
RebuildSnapshots?: Snapshot[];
|
|
3950
3950
|
/**
|
|
3951
|
-
* @public
|
|
3952
3951
|
* <p>Information about the snapshots that can be used to restore a WorkSpace. These snapshots
|
|
3953
3952
|
* include both the root volume and the user volume.</p>
|
|
3953
|
+
* @public
|
|
3954
3954
|
*/
|
|
3955
3955
|
RestoreSnapshots?: Snapshot[];
|
|
3956
3956
|
}
|
|
@@ -3959,8 +3959,8 @@ export interface DescribeWorkspaceSnapshotsResult {
|
|
|
3959
3959
|
*/
|
|
3960
3960
|
export interface DisassociateConnectionAliasRequest {
|
|
3961
3961
|
/**
|
|
3962
|
-
* @public
|
|
3963
3962
|
* <p>The identifier of the connection alias to disassociate.</p>
|
|
3963
|
+
* @public
|
|
3964
3964
|
*/
|
|
3965
3965
|
AliasId: string | undefined;
|
|
3966
3966
|
}
|
|
@@ -3974,13 +3974,13 @@ export interface DisassociateConnectionAliasResult {
|
|
|
3974
3974
|
*/
|
|
3975
3975
|
export interface DisassociateIpGroupsRequest {
|
|
3976
3976
|
/**
|
|
3977
|
-
* @public
|
|
3978
3977
|
* <p>The identifier of the directory.</p>
|
|
3978
|
+
* @public
|
|
3979
3979
|
*/
|
|
3980
3980
|
DirectoryId: string | undefined;
|
|
3981
3981
|
/**
|
|
3982
|
-
* @public
|
|
3983
3982
|
* <p>The identifiers of one or more IP access control groups.</p>
|
|
3983
|
+
* @public
|
|
3984
3984
|
*/
|
|
3985
3985
|
GroupIds: string[] | undefined;
|
|
3986
3986
|
}
|
|
@@ -3994,13 +3994,13 @@ export interface DisassociateIpGroupsResult {
|
|
|
3994
3994
|
*/
|
|
3995
3995
|
export interface DisassociateWorkspaceApplicationRequest {
|
|
3996
3996
|
/**
|
|
3997
|
-
* @public
|
|
3998
3997
|
* <p>The identifier of the WorkSpace.</p>
|
|
3998
|
+
* @public
|
|
3999
3999
|
*/
|
|
4000
4000
|
WorkspaceId: string | undefined;
|
|
4001
4001
|
/**
|
|
4002
|
-
* @public
|
|
4003
4002
|
* <p>The identifier of the application.</p>
|
|
4003
|
+
* @public
|
|
4004
4004
|
*/
|
|
4005
4005
|
ApplicationId: string | undefined;
|
|
4006
4006
|
}
|
|
@@ -4009,54 +4009,53 @@ export interface DisassociateWorkspaceApplicationRequest {
|
|
|
4009
4009
|
*/
|
|
4010
4010
|
export interface DisassociateWorkspaceApplicationResult {
|
|
4011
4011
|
/**
|
|
4012
|
-
* @public
|
|
4013
4012
|
* <p>Information about the targeted association.</p>
|
|
4013
|
+
* @public
|
|
4014
4014
|
*/
|
|
4015
4015
|
Association?: WorkspaceResourceAssociation;
|
|
4016
4016
|
}
|
|
4017
4017
|
/**
|
|
4018
|
-
* @public
|
|
4019
4018
|
* <p>Describes a WorkSpace that could not be rebooted. (<a>RebootWorkspaces</a>),
|
|
4020
4019
|
* rebuilt (<a>RebuildWorkspaces</a>), restored (<a>RestoreWorkspace</a>), terminated (<a>TerminateWorkspaces</a>), started (<a>StartWorkspaces</a>), or stopped (<a>StopWorkspaces</a>).</p>
|
|
4020
|
+
* @public
|
|
4021
4021
|
*/
|
|
4022
4022
|
export interface FailedWorkspaceChangeRequest {
|
|
4023
4023
|
/**
|
|
4024
|
-
* @public
|
|
4025
4024
|
* <p>The identifier of the WorkSpace.</p>
|
|
4025
|
+
* @public
|
|
4026
4026
|
*/
|
|
4027
4027
|
WorkspaceId?: string;
|
|
4028
4028
|
/**
|
|
4029
|
-
* @public
|
|
4030
4029
|
* <p>The error code that is returned if the WorkSpace cannot be rebooted.</p>
|
|
4030
|
+
* @public
|
|
4031
4031
|
*/
|
|
4032
4032
|
ErrorCode?: string;
|
|
4033
4033
|
/**
|
|
4034
|
-
* @public
|
|
4035
4034
|
* <p>The text of the error message that is returned if the WorkSpace cannot be
|
|
4036
4035
|
* rebooted.</p>
|
|
4036
|
+
* @public
|
|
4037
4037
|
*/
|
|
4038
4038
|
ErrorMessage?: string;
|
|
4039
4039
|
}
|
|
4040
4040
|
/**
|
|
4041
|
-
* @public
|
|
4042
4041
|
* <p>The client branding attributes to import for iOS device types. These attributes are
|
|
4043
4042
|
* displayed on the iOS client login screen.</p>
|
|
4044
4043
|
* <important>
|
|
4045
4044
|
* <p>Client branding attributes are public facing. Ensure you do not include sensitive
|
|
4046
4045
|
* information.</p>
|
|
4047
4046
|
* </important>
|
|
4047
|
+
* @public
|
|
4048
4048
|
*/
|
|
4049
4049
|
export interface IosImportClientBrandingAttributes {
|
|
4050
4050
|
/**
|
|
4051
|
-
* @public
|
|
4052
4051
|
* <p>The logo. This is the
|
|
4053
4052
|
* standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal
|
|
4054
4053
|
* to one point. The only image format accepted is a binary data object that is converted
|
|
4055
4054
|
* from a <code>.png</code> file.</p>
|
|
4055
|
+
* @public
|
|
4056
4056
|
*/
|
|
4057
4057
|
Logo?: Uint8Array;
|
|
4058
4058
|
/**
|
|
4059
|
-
* @public
|
|
4060
4059
|
* <p>The @2x version of the logo. This is the higher resolution display that offers a scale
|
|
4061
4060
|
* factor of 2.0 (or @2x). The only image format accepted is a binary data object that is
|
|
4062
4061
|
* converted from a <code>.png</code> file.</p>
|
|
@@ -4064,10 +4063,10 @@ export interface IosImportClientBrandingAttributes {
|
|
|
4064
4063
|
* <p> For more information about iOS image size and resolution, see <a href="https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/">Image Size and Resolution </a> in the <i>Apple Human Interface
|
|
4065
4064
|
* Guidelines</i>.</p>
|
|
4066
4065
|
* </note>
|
|
4066
|
+
* @public
|
|
4067
4067
|
*/
|
|
4068
4068
|
Logo2x?: Uint8Array;
|
|
4069
4069
|
/**
|
|
4070
|
-
* @public
|
|
4071
4070
|
* <p>The @3x version of the logo. This is the higher resolution display that offers a scale
|
|
4072
4071
|
* factor of 3.0 (or @3x). The only image format accepted is a binary data object that is
|
|
4073
4072
|
* converted from a <code>.png</code> file.</p>
|
|
@@ -4075,10 +4074,10 @@ export interface IosImportClientBrandingAttributes {
|
|
|
4075
4074
|
* <p> For more information about iOS image size and resolution, see <a href="https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/">Image Size and Resolution </a> in the <i>Apple Human Interface
|
|
4076
4075
|
* Guidelines</i>.</p>
|
|
4077
4076
|
* </note>
|
|
4077
|
+
* @public
|
|
4078
4078
|
*/
|
|
4079
4079
|
Logo3x?: Uint8Array;
|
|
4080
4080
|
/**
|
|
4081
|
-
* @public
|
|
4082
4081
|
* <p>The support email. The company's customer support email address.</p>
|
|
4083
4082
|
* <note>
|
|
4084
4083
|
* <ul>
|
|
@@ -4092,10 +4091,10 @@ export interface IosImportClientBrandingAttributes {
|
|
|
4092
4091
|
* </li>
|
|
4093
4092
|
* </ul>
|
|
4094
4093
|
* </note>
|
|
4094
|
+
* @public
|
|
4095
4095
|
*/
|
|
4096
4096
|
SupportEmail?: string;
|
|
4097
4097
|
/**
|
|
4098
|
-
* @public
|
|
4099
4098
|
* <p>The support link. The link for the company's customer support page for their
|
|
4100
4099
|
* WorkSpace.</p>
|
|
4101
4100
|
* <note>
|
|
@@ -4110,20 +4109,21 @@ export interface IosImportClientBrandingAttributes {
|
|
|
4110
4109
|
* </li>
|
|
4111
4110
|
* </ul>
|
|
4112
4111
|
* </note>
|
|
4112
|
+
* @public
|
|
4113
4113
|
*/
|
|
4114
4114
|
SupportLink?: string;
|
|
4115
4115
|
/**
|
|
4116
|
-
* @public
|
|
4117
4116
|
* <p>The forgotten password link. This is the web address that users can go to if they forget
|
|
4118
4117
|
* the password for their WorkSpace.</p>
|
|
4118
|
+
* @public
|
|
4119
4119
|
*/
|
|
4120
4120
|
ForgotPasswordLink?: string;
|
|
4121
4121
|
/**
|
|
4122
|
-
* @public
|
|
4123
4122
|
* <p>The login message. Specified as a key value pair, in which the key is a locale and the
|
|
4124
4123
|
* value is the localized message for that locale. The only key supported is
|
|
4125
4124
|
* <code>en_US</code>. The HTML tags supported include the following: <code>a, b, blockquote, br, cite, code, dd, dl, dt, div, em,
|
|
4126
4125
|
* i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul</code>.</p>
|
|
4126
|
+
* @public
|
|
4127
4127
|
*/
|
|
4128
4128
|
LoginMessage?: Record<string, string>;
|
|
4129
4129
|
}
|
|
@@ -4132,39 +4132,39 @@ export interface IosImportClientBrandingAttributes {
|
|
|
4132
4132
|
*/
|
|
4133
4133
|
export interface ImportClientBrandingRequest {
|
|
4134
4134
|
/**
|
|
4135
|
-
* @public
|
|
4136
4135
|
* <p>The directory identifier of the WorkSpace for which you want to import client
|
|
4137
4136
|
* branding.</p>
|
|
4137
|
+
* @public
|
|
4138
4138
|
*/
|
|
4139
4139
|
ResourceId: string | undefined;
|
|
4140
4140
|
/**
|
|
4141
|
-
* @public
|
|
4142
4141
|
* <p>The branding information to import for Windows devices.</p>
|
|
4142
|
+
* @public
|
|
4143
4143
|
*/
|
|
4144
4144
|
DeviceTypeWindows?: DefaultImportClientBrandingAttributes;
|
|
4145
4145
|
/**
|
|
4146
|
-
* @public
|
|
4147
4146
|
* <p>The branding information to import for macOS devices.</p>
|
|
4147
|
+
* @public
|
|
4148
4148
|
*/
|
|
4149
4149
|
DeviceTypeOsx?: DefaultImportClientBrandingAttributes;
|
|
4150
4150
|
/**
|
|
4151
|
-
* @public
|
|
4152
4151
|
* <p>The branding information to import for Android devices.</p>
|
|
4152
|
+
* @public
|
|
4153
4153
|
*/
|
|
4154
4154
|
DeviceTypeAndroid?: DefaultImportClientBrandingAttributes;
|
|
4155
4155
|
/**
|
|
4156
|
-
* @public
|
|
4157
4156
|
* <p>The branding information to import for iOS devices.</p>
|
|
4157
|
+
* @public
|
|
4158
4158
|
*/
|
|
4159
4159
|
DeviceTypeIos?: IosImportClientBrandingAttributes;
|
|
4160
4160
|
/**
|
|
4161
|
-
* @public
|
|
4162
4161
|
* <p>The branding information to import for Linux devices.</p>
|
|
4162
|
+
* @public
|
|
4163
4163
|
*/
|
|
4164
4164
|
DeviceTypeLinux?: DefaultImportClientBrandingAttributes;
|
|
4165
4165
|
/**
|
|
4166
|
-
* @public
|
|
4167
4166
|
* <p>The branding information to import for web access.</p>
|
|
4167
|
+
* @public
|
|
4168
4168
|
*/
|
|
4169
4169
|
DeviceTypeWeb?: DefaultImportClientBrandingAttributes;
|
|
4170
4170
|
}
|
|
@@ -4173,33 +4173,33 @@ export interface ImportClientBrandingRequest {
|
|
|
4173
4173
|
*/
|
|
4174
4174
|
export interface ImportClientBrandingResult {
|
|
4175
4175
|
/**
|
|
4176
|
-
* @public
|
|
4177
4176
|
* <p>The branding information configured for Windows devices.</p>
|
|
4177
|
+
* @public
|
|
4178
4178
|
*/
|
|
4179
4179
|
DeviceTypeWindows?: DefaultClientBrandingAttributes;
|
|
4180
4180
|
/**
|
|
4181
|
-
* @public
|
|
4182
4181
|
* <p>The branding information configured for macOS devices.</p>
|
|
4182
|
+
* @public
|
|
4183
4183
|
*/
|
|
4184
4184
|
DeviceTypeOsx?: DefaultClientBrandingAttributes;
|
|
4185
4185
|
/**
|
|
4186
|
-
* @public
|
|
4187
4186
|
* <p>The branding information configured for Android devices.</p>
|
|
4187
|
+
* @public
|
|
4188
4188
|
*/
|
|
4189
4189
|
DeviceTypeAndroid?: DefaultClientBrandingAttributes;
|
|
4190
4190
|
/**
|
|
4191
|
-
* @public
|
|
4192
4191
|
* <p>The branding information configured for iOS devices.</p>
|
|
4192
|
+
* @public
|
|
4193
4193
|
*/
|
|
4194
4194
|
DeviceTypeIos?: IosClientBrandingAttributes;
|
|
4195
4195
|
/**
|
|
4196
|
-
* @public
|
|
4197
4196
|
* <p>The branding information configured for Linux devices.</p>
|
|
4197
|
+
* @public
|
|
4198
4198
|
*/
|
|
4199
4199
|
DeviceTypeLinux?: DefaultClientBrandingAttributes;
|
|
4200
4200
|
/**
|
|
4201
|
-
* @public
|
|
4202
4201
|
* <p>The branding information configured for web access.</p>
|
|
4202
|
+
* @public
|
|
4203
4203
|
*/
|
|
4204
4204
|
DeviceTypeWeb?: DefaultClientBrandingAttributes;
|
|
4205
4205
|
}
|
|
@@ -4225,12 +4225,11 @@ export type WorkspaceImageIngestionProcess = (typeof WorkspaceImageIngestionProc
|
|
|
4225
4225
|
*/
|
|
4226
4226
|
export interface ImportWorkspaceImageRequest {
|
|
4227
4227
|
/**
|
|
4228
|
-
* @public
|
|
4229
4228
|
* <p>The identifier of the EC2 image.</p>
|
|
4229
|
+
* @public
|
|
4230
4230
|
*/
|
|
4231
4231
|
Ec2ImageId: string | undefined;
|
|
4232
4232
|
/**
|
|
4233
|
-
* @public
|
|
4234
4233
|
* <p>The ingestion process to be used when importing the image, depending on which protocol
|
|
4235
4234
|
* you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol
|
|
4236
4235
|
* (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in
|
|
@@ -4244,25 +4243,25 @@ export interface ImportWorkspaceImageRequest {
|
|
|
4244
4243
|
* are only supported by Amazon WorkSpaces Core. Contact your account team to be
|
|
4245
4244
|
* allow-listed to use these values. For more information, see <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p>
|
|
4246
4245
|
* </note>
|
|
4246
|
+
* @public
|
|
4247
4247
|
*/
|
|
4248
4248
|
IngestionProcess: WorkspaceImageIngestionProcess | undefined;
|
|
4249
4249
|
/**
|
|
4250
|
-
* @public
|
|
4251
4250
|
* <p>The name of the WorkSpace image.</p>
|
|
4251
|
+
* @public
|
|
4252
4252
|
*/
|
|
4253
4253
|
ImageName: string | undefined;
|
|
4254
4254
|
/**
|
|
4255
|
-
* @public
|
|
4256
4255
|
* <p>The description of the WorkSpace image.</p>
|
|
4256
|
+
* @public
|
|
4257
4257
|
*/
|
|
4258
4258
|
ImageDescription: string | undefined;
|
|
4259
4259
|
/**
|
|
4260
|
-
* @public
|
|
4261
4260
|
* <p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>
|
|
4261
|
+
* @public
|
|
4262
4262
|
*/
|
|
4263
4263
|
Tags?: Tag[];
|
|
4264
4264
|
/**
|
|
4265
|
-
* @public
|
|
4266
4265
|
* <p>If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11
|
|
4267
4266
|
* BYOL images. For more information about subscribing to Office for BYOL images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html"> Bring
|
|
4268
4267
|
* Your Own Windows Desktop Licenses</a>.</p>
|
|
@@ -4276,6 +4275,7 @@ export interface ImportWorkspaceImageRequest {
|
|
|
4276
4275
|
* </li>
|
|
4277
4276
|
* </ul>
|
|
4278
4277
|
* </note>
|
|
4278
|
+
* @public
|
|
4279
4279
|
*/
|
|
4280
4280
|
Applications?: Application[];
|
|
4281
4281
|
}
|
|
@@ -4284,8 +4284,8 @@ export interface ImportWorkspaceImageRequest {
|
|
|
4284
4284
|
*/
|
|
4285
4285
|
export interface ImportWorkspaceImageResult {
|
|
4286
4286
|
/**
|
|
4287
|
-
* @public
|
|
4288
4287
|
* <p>The identifier of the WorkSpace image.</p>
|
|
4288
|
+
* @public
|
|
4289
4289
|
*/
|
|
4290
4290
|
ImageId?: string;
|
|
4291
4291
|
}
|
|
@@ -4294,20 +4294,20 @@ export interface ImportWorkspaceImageResult {
|
|
|
4294
4294
|
*/
|
|
4295
4295
|
export interface ListAvailableManagementCidrRangesRequest {
|
|
4296
4296
|
/**
|
|
4297
|
-
* @public
|
|
4298
4297
|
* <p>The IP address range to search. Specify an IP address range that is compatible with your
|
|
4299
4298
|
* network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).</p>
|
|
4299
|
+
* @public
|
|
4300
4300
|
*/
|
|
4301
4301
|
ManagementCidrRangeConstraint: string | undefined;
|
|
4302
4302
|
/**
|
|
4303
|
-
* @public
|
|
4304
4303
|
* <p>The maximum number of items to return.</p>
|
|
4304
|
+
* @public
|
|
4305
4305
|
*/
|
|
4306
4306
|
MaxResults?: number;
|
|
4307
4307
|
/**
|
|
4308
|
-
* @public
|
|
4309
4308
|
* <p>If you received a <code>NextToken</code> from a previous call that was paginated,
|
|
4310
4309
|
* provide this token to receive the next set of results.</p>
|
|
4310
|
+
* @public
|
|
4311
4311
|
*/
|
|
4312
4312
|
NextToken?: string;
|
|
4313
4313
|
}
|
|
@@ -4316,14 +4316,14 @@ export interface ListAvailableManagementCidrRangesRequest {
|
|
|
4316
4316
|
*/
|
|
4317
4317
|
export interface ListAvailableManagementCidrRangesResult {
|
|
4318
4318
|
/**
|
|
4319
|
-
* @public
|
|
4320
4319
|
* <p>The list of available IP address ranges, specified as IPv4 CIDR blocks.</p>
|
|
4320
|
+
* @public
|
|
4321
4321
|
*/
|
|
4322
4322
|
ManagementCidrRanges?: string[];
|
|
4323
4323
|
/**
|
|
4324
|
-
* @public
|
|
4325
4324
|
* <p>The token to use to retrieve the next page of results. This value is null when there are
|
|
4326
4325
|
* no more results to return. </p>
|
|
4326
|
+
* @public
|
|
4327
4327
|
*/
|
|
4328
4328
|
NextToken?: string;
|
|
4329
4329
|
}
|
|
@@ -4332,13 +4332,13 @@ export interface ListAvailableManagementCidrRangesResult {
|
|
|
4332
4332
|
*/
|
|
4333
4333
|
export interface MigrateWorkspaceRequest {
|
|
4334
4334
|
/**
|
|
4335
|
-
* @public
|
|
4336
4335
|
* <p>The identifier of the WorkSpace to migrate from.</p>
|
|
4336
|
+
* @public
|
|
4337
4337
|
*/
|
|
4338
4338
|
SourceWorkspaceId: string | undefined;
|
|
4339
4339
|
/**
|
|
4340
|
-
* @public
|
|
4341
4340
|
* <p>The identifier of the target bundle type to migrate the WorkSpace to.</p>
|
|
4341
|
+
* @public
|
|
4342
4342
|
*/
|
|
4343
4343
|
BundleId: string | undefined;
|
|
4344
4344
|
}
|
|
@@ -4347,21 +4347,21 @@ export interface MigrateWorkspaceRequest {
|
|
|
4347
4347
|
*/
|
|
4348
4348
|
export interface MigrateWorkspaceResult {
|
|
4349
4349
|
/**
|
|
4350
|
-
* @public
|
|
4351
4350
|
* <p>The original identifier of the WorkSpace that is being migrated.</p>
|
|
4351
|
+
* @public
|
|
4352
4352
|
*/
|
|
4353
4353
|
SourceWorkspaceId?: string;
|
|
4354
4354
|
/**
|
|
4355
|
-
* @public
|
|
4356
4355
|
* <p>The new identifier of the WorkSpace that is being migrated. If the migration does not
|
|
4357
4356
|
* succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the
|
|
4358
4357
|
* original WorkSpace ID.</p>
|
|
4358
|
+
* @public
|
|
4359
4359
|
*/
|
|
4360
4360
|
TargetWorkspaceId?: string;
|
|
4361
4361
|
}
|
|
4362
4362
|
/**
|
|
4363
|
-
* @public
|
|
4364
4363
|
* <p>The properties of this WorkSpace are currently being modified. Try again in a moment.</p>
|
|
4364
|
+
* @public
|
|
4365
4365
|
*/
|
|
4366
4366
|
export declare class OperationInProgressException extends __BaseException {
|
|
4367
4367
|
readonly name: "OperationInProgressException";
|
|
@@ -4376,17 +4376,17 @@ export declare class OperationInProgressException extends __BaseException {
|
|
|
4376
4376
|
*/
|
|
4377
4377
|
export interface ModifyAccountRequest {
|
|
4378
4378
|
/**
|
|
4379
|
-
* @public
|
|
4380
4379
|
* <p>The status of BYOL.</p>
|
|
4380
|
+
* @public
|
|
4381
4381
|
*/
|
|
4382
4382
|
DedicatedTenancySupport?: DedicatedTenancySupportEnum;
|
|
4383
4383
|
/**
|
|
4384
|
-
* @public
|
|
4385
4384
|
* <p>The IP address range, specified as an IPv4 CIDR block, for the management network
|
|
4386
4385
|
* interface. Specify an IP address range that is compatible with your network and in CIDR
|
|
4387
4386
|
* notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be
|
|
4388
4387
|
* /16 (for example, 203.0.113.25/16). It must also be specified as available by the
|
|
4389
4388
|
* <code>ListAvailableManagementCidrRanges</code> operation.</p>
|
|
4389
|
+
* @public
|
|
4390
4390
|
*/
|
|
4391
4391
|
DedicatedTenancyManagementCidrRange?: string;
|
|
4392
4392
|
}
|
|
@@ -4400,18 +4400,18 @@ export interface ModifyAccountResult {
|
|
|
4400
4400
|
*/
|
|
4401
4401
|
export interface ModifyCertificateBasedAuthPropertiesRequest {
|
|
4402
4402
|
/**
|
|
4403
|
-
* @public
|
|
4404
4403
|
* <p>The resource identifiers, in the form of directory IDs.</p>
|
|
4404
|
+
* @public
|
|
4405
4405
|
*/
|
|
4406
4406
|
ResourceId: string | undefined;
|
|
4407
4407
|
/**
|
|
4408
|
-
* @public
|
|
4409
4408
|
* <p>The properties of the certificate-based authentication.</p>
|
|
4409
|
+
* @public
|
|
4410
4410
|
*/
|
|
4411
4411
|
CertificateBasedAuthProperties?: CertificateBasedAuthProperties;
|
|
4412
4412
|
/**
|
|
4413
|
-
* @public
|
|
4414
4413
|
* <p>The properties of the certificate-based authentication you want to delete.</p>
|
|
4414
|
+
* @public
|
|
4415
4415
|
*/
|
|
4416
4416
|
PropertiesToDelete?: DeletableCertificateBasedAuthProperty[];
|
|
4417
4417
|
}
|
|
@@ -4425,13 +4425,13 @@ export interface ModifyCertificateBasedAuthPropertiesResult {
|
|
|
4425
4425
|
*/
|
|
4426
4426
|
export interface ModifyClientPropertiesRequest {
|
|
4427
4427
|
/**
|
|
4428
|
-
* @public
|
|
4429
4428
|
* <p>The resource identifiers, in the form of directory IDs.</p>
|
|
4429
|
+
* @public
|
|
4430
4430
|
*/
|
|
4431
4431
|
ResourceId: string | undefined;
|
|
4432
4432
|
/**
|
|
4433
|
-
* @public
|
|
4434
4433
|
* <p>Information about the Amazon WorkSpaces client.</p>
|
|
4434
|
+
* @public
|
|
4435
4435
|
*/
|
|
4436
4436
|
ClientProperties: ClientProperties | undefined;
|
|
4437
4437
|
}
|
|
@@ -4445,17 +4445,16 @@ export interface ModifyClientPropertiesResult {
|
|
|
4445
4445
|
*/
|
|
4446
4446
|
export interface ModifySamlPropertiesRequest {
|
|
4447
4447
|
/**
|
|
4448
|
-
* @public
|
|
4449
4448
|
* <p>The directory identifier for which you want to configure SAML properties.</p>
|
|
4449
|
+
* @public
|
|
4450
4450
|
*/
|
|
4451
4451
|
ResourceId: string | undefined;
|
|
4452
4452
|
/**
|
|
4453
|
-
* @public
|
|
4454
4453
|
* <p>The properties for configuring SAML 2.0 authentication.</p>
|
|
4454
|
+
* @public
|
|
4455
4455
|
*/
|
|
4456
4456
|
SamlProperties?: SamlProperties;
|
|
4457
4457
|
/**
|
|
4458
|
-
* @public
|
|
4459
4458
|
* <p>The SAML properties to delete as part of your request.</p>
|
|
4460
4459
|
* <p>Specify one of the following options:</p>
|
|
4461
4460
|
* <ul>
|
|
@@ -4469,6 +4468,7 @@ export interface ModifySamlPropertiesRequest {
|
|
|
4469
4468
|
* relay state parameter name.</p>
|
|
4470
4469
|
* </li>
|
|
4471
4470
|
* </ul>
|
|
4471
|
+
* @public
|
|
4472
4472
|
*/
|
|
4473
4473
|
PropertiesToDelete?: DeletableSamlProperty[];
|
|
4474
4474
|
}
|
|
@@ -4482,13 +4482,13 @@ export interface ModifySamlPropertiesResult {
|
|
|
4482
4482
|
*/
|
|
4483
4483
|
export interface ModifySelfservicePermissionsRequest {
|
|
4484
4484
|
/**
|
|
4485
|
-
* @public
|
|
4486
4485
|
* <p>The identifier of the directory.</p>
|
|
4486
|
+
* @public
|
|
4487
4487
|
*/
|
|
4488
4488
|
ResourceId: string | undefined;
|
|
4489
4489
|
/**
|
|
4490
|
-
* @public
|
|
4491
4490
|
* <p>The permissions to enable or disable self-service capabilities.</p>
|
|
4491
|
+
* @public
|
|
4492
4492
|
*/
|
|
4493
4493
|
SelfservicePermissions: SelfservicePermissions | undefined;
|
|
4494
4494
|
}
|
|
@@ -4502,13 +4502,13 @@ export interface ModifySelfservicePermissionsResult {
|
|
|
4502
4502
|
*/
|
|
4503
4503
|
export interface ModifyWorkspaceAccessPropertiesRequest {
|
|
4504
4504
|
/**
|
|
4505
|
-
* @public
|
|
4506
4505
|
* <p>The identifier of the directory.</p>
|
|
4506
|
+
* @public
|
|
4507
4507
|
*/
|
|
4508
4508
|
ResourceId: string | undefined;
|
|
4509
4509
|
/**
|
|
4510
|
-
* @public
|
|
4511
4510
|
* <p>The device types and operating systems to enable or disable for access.</p>
|
|
4511
|
+
* @public
|
|
4512
4512
|
*/
|
|
4513
4513
|
WorkspaceAccessProperties: WorkspaceAccessProperties | undefined;
|
|
4514
4514
|
}
|
|
@@ -4518,14 +4518,13 @@ export interface ModifyWorkspaceAccessPropertiesRequest {
|
|
|
4518
4518
|
export interface ModifyWorkspaceAccessPropertiesResult {
|
|
4519
4519
|
}
|
|
4520
4520
|
/**
|
|
4521
|
-
* @public
|
|
4522
4521
|
* <p>Describes the default properties that are used for creating WorkSpaces. For more
|
|
4523
4522
|
* information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html">Update Directory
|
|
4524
4523
|
* Details for Your WorkSpaces</a>. </p>
|
|
4524
|
+
* @public
|
|
4525
4525
|
*/
|
|
4526
4526
|
export interface WorkspaceCreationProperties {
|
|
4527
4527
|
/**
|
|
4528
|
-
* @public
|
|
4529
4528
|
* <p>Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.</p>
|
|
4530
4529
|
* <note>
|
|
4531
4530
|
* <p>If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new
|
|
@@ -4539,15 +4538,15 @@ export interface WorkspaceCreationProperties {
|
|
|
4539
4538
|
* existing WorkSpaces and any new WorkSpaces that are launched in the directory will have
|
|
4540
4539
|
* WorkDocs enabled.</p>
|
|
4541
4540
|
* </note>
|
|
4541
|
+
* @public
|
|
4542
4542
|
*/
|
|
4543
4543
|
EnableWorkDocs?: boolean;
|
|
4544
4544
|
/**
|
|
4545
|
-
* @public
|
|
4546
4545
|
* <p>Indicates whether internet access is enabled for your WorkSpaces.</p>
|
|
4546
|
+
* @public
|
|
4547
4547
|
*/
|
|
4548
4548
|
EnableInternetAccess?: boolean;
|
|
4549
4549
|
/**
|
|
4550
|
-
* @public
|
|
4551
4550
|
* <p>The default organizational unit (OU) for your WorkSpaces directories. This string must
|
|
4552
4551
|
* be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target
|
|
4553
4552
|
* domain and OU. It must be in the form
|
|
@@ -4566,23 +4565,24 @@ export interface WorkspaceCreationProperties {
|
|
|
4566
4565
|
* </li>
|
|
4567
4566
|
* </ul>
|
|
4568
4567
|
* </important>
|
|
4568
|
+
* @public
|
|
4569
4569
|
*/
|
|
4570
4570
|
DefaultOu?: string;
|
|
4571
4571
|
/**
|
|
4572
|
-
* @public
|
|
4573
4572
|
* <p>The identifier of your custom security group.</p>
|
|
4573
|
+
* @public
|
|
4574
4574
|
*/
|
|
4575
4575
|
CustomSecurityGroupId?: string;
|
|
4576
4576
|
/**
|
|
4577
|
-
* @public
|
|
4578
4577
|
* <p>Indicates whether users are local administrators of their WorkSpaces.</p>
|
|
4578
|
+
* @public
|
|
4579
4579
|
*/
|
|
4580
4580
|
UserEnabledAsLocalAdministrator?: boolean;
|
|
4581
4581
|
/**
|
|
4582
|
-
* @public
|
|
4583
4582
|
* <p>Indicates whether maintenance mode is enabled for your WorkSpaces. For more information,
|
|
4584
4583
|
* see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html">WorkSpace
|
|
4585
4584
|
* Maintenance</a>. </p>
|
|
4585
|
+
* @public
|
|
4586
4586
|
*/
|
|
4587
4587
|
EnableMaintenanceMode?: boolean;
|
|
4588
4588
|
}
|
|
@@ -4591,13 +4591,13 @@ export interface WorkspaceCreationProperties {
|
|
|
4591
4591
|
*/
|
|
4592
4592
|
export interface ModifyWorkspaceCreationPropertiesRequest {
|
|
4593
4593
|
/**
|
|
4594
|
-
* @public
|
|
4595
4594
|
* <p>The identifier of the directory.</p>
|
|
4595
|
+
* @public
|
|
4596
4596
|
*/
|
|
4597
4597
|
ResourceId: string | undefined;
|
|
4598
4598
|
/**
|
|
4599
|
-
* @public
|
|
4600
4599
|
* <p>The default properties for creating WorkSpaces.</p>
|
|
4600
|
+
* @public
|
|
4601
4601
|
*/
|
|
4602
4602
|
WorkspaceCreationProperties: WorkspaceCreationProperties | undefined;
|
|
4603
4603
|
}
|
|
@@ -4611,18 +4611,18 @@ export interface ModifyWorkspaceCreationPropertiesResult {
|
|
|
4611
4611
|
*/
|
|
4612
4612
|
export interface ModifyWorkspacePropertiesRequest {
|
|
4613
4613
|
/**
|
|
4614
|
-
* @public
|
|
4615
4614
|
* <p>The identifier of the WorkSpace.</p>
|
|
4615
|
+
* @public
|
|
4616
4616
|
*/
|
|
4617
4617
|
WorkspaceId: string | undefined;
|
|
4618
4618
|
/**
|
|
4619
|
-
* @public
|
|
4620
4619
|
* <p>The properties of the WorkSpace.</p>
|
|
4620
|
+
* @public
|
|
4621
4621
|
*/
|
|
4622
4622
|
WorkspaceProperties?: WorkspaceProperties;
|
|
4623
4623
|
/**
|
|
4624
|
-
* @public
|
|
4625
4624
|
* <p>Indicates the data replication status.</p>
|
|
4625
|
+
* @public
|
|
4626
4626
|
*/
|
|
4627
4627
|
DataReplication?: DataReplication;
|
|
4628
4628
|
}
|
|
@@ -4632,10 +4632,10 @@ export interface ModifyWorkspacePropertiesRequest {
|
|
|
4632
4632
|
export interface ModifyWorkspacePropertiesResult {
|
|
4633
4633
|
}
|
|
4634
4634
|
/**
|
|
4635
|
-
* @public
|
|
4636
4635
|
* <p>The configuration of this WorkSpace is not supported for this operation. For more information, see
|
|
4637
4636
|
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/required-service-components.html">Required
|
|
4638
4637
|
* Configuration and Service Components for WorkSpaces </a>.</p>
|
|
4638
|
+
* @public
|
|
4639
4639
|
*/
|
|
4640
4640
|
export declare class UnsupportedWorkspaceConfigurationException extends __BaseException {
|
|
4641
4641
|
readonly name: "UnsupportedWorkspaceConfigurationException";
|
|
@@ -4662,13 +4662,13 @@ export type TargetWorkspaceState = (typeof TargetWorkspaceState)[keyof typeof Ta
|
|
|
4662
4662
|
*/
|
|
4663
4663
|
export interface ModifyWorkspaceStateRequest {
|
|
4664
4664
|
/**
|
|
4665
|
-
* @public
|
|
4666
4665
|
* <p>The identifier of the WorkSpace.</p>
|
|
4666
|
+
* @public
|
|
4667
4667
|
*/
|
|
4668
4668
|
WorkspaceId: string | undefined;
|
|
4669
4669
|
/**
|
|
4670
|
-
* @public
|
|
4671
4670
|
* <p>The WorkSpace state.</p>
|
|
4671
|
+
* @public
|
|
4672
4672
|
*/
|
|
4673
4673
|
WorkspaceState: TargetWorkspaceState | undefined;
|
|
4674
4674
|
}
|
|
@@ -4678,13 +4678,13 @@ export interface ModifyWorkspaceStateRequest {
|
|
|
4678
4678
|
export interface ModifyWorkspaceStateResult {
|
|
4679
4679
|
}
|
|
4680
4680
|
/**
|
|
4681
|
-
* @public
|
|
4682
4681
|
* <p>Describes the information used to reboot a WorkSpace.</p>
|
|
4682
|
+
* @public
|
|
4683
4683
|
*/
|
|
4684
4684
|
export interface RebootRequest {
|
|
4685
4685
|
/**
|
|
4686
|
-
* @public
|
|
4687
4686
|
* <p>The identifier of the WorkSpace.</p>
|
|
4687
|
+
* @public
|
|
4688
4688
|
*/
|
|
4689
4689
|
WorkspaceId: string | undefined;
|
|
4690
4690
|
}
|
|
@@ -4693,8 +4693,8 @@ export interface RebootRequest {
|
|
|
4693
4693
|
*/
|
|
4694
4694
|
export interface RebootWorkspacesRequest {
|
|
4695
4695
|
/**
|
|
4696
|
-
* @public
|
|
4697
4696
|
* <p>The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.</p>
|
|
4697
|
+
* @public
|
|
4698
4698
|
*/
|
|
4699
4699
|
RebootWorkspaceRequests: RebootRequest[] | undefined;
|
|
4700
4700
|
}
|
|
@@ -4703,19 +4703,19 @@ export interface RebootWorkspacesRequest {
|
|
|
4703
4703
|
*/
|
|
4704
4704
|
export interface RebootWorkspacesResult {
|
|
4705
4705
|
/**
|
|
4706
|
-
* @public
|
|
4707
4706
|
* <p>Information about the WorkSpaces that could not be rebooted.</p>
|
|
4707
|
+
* @public
|
|
4708
4708
|
*/
|
|
4709
4709
|
FailedRequests?: FailedWorkspaceChangeRequest[];
|
|
4710
4710
|
}
|
|
4711
4711
|
/**
|
|
4712
|
-
* @public
|
|
4713
4712
|
* <p>Describes the information used to rebuild a WorkSpace.</p>
|
|
4713
|
+
* @public
|
|
4714
4714
|
*/
|
|
4715
4715
|
export interface RebuildRequest {
|
|
4716
4716
|
/**
|
|
4717
|
-
* @public
|
|
4718
4717
|
* <p>The identifier of the WorkSpace.</p>
|
|
4718
|
+
* @public
|
|
4719
4719
|
*/
|
|
4720
4720
|
WorkspaceId: string | undefined;
|
|
4721
4721
|
}
|
|
@@ -4724,8 +4724,8 @@ export interface RebuildRequest {
|
|
|
4724
4724
|
*/
|
|
4725
4725
|
export interface RebuildWorkspacesRequest {
|
|
4726
4726
|
/**
|
|
4727
|
-
* @public
|
|
4728
4727
|
* <p>The WorkSpace to rebuild. You can specify a single WorkSpace.</p>
|
|
4728
|
+
* @public
|
|
4729
4729
|
*/
|
|
4730
4730
|
RebuildWorkspaceRequests: RebuildRequest[] | undefined;
|
|
4731
4731
|
}
|
|
@@ -4734,8 +4734,8 @@ export interface RebuildWorkspacesRequest {
|
|
|
4734
4734
|
*/
|
|
4735
4735
|
export interface RebuildWorkspacesResult {
|
|
4736
4736
|
/**
|
|
4737
|
-
* @public
|
|
4738
4737
|
* <p>Information about the WorkSpace that could not be rebuilt.</p>
|
|
4738
|
+
* @public
|
|
4739
4739
|
*/
|
|
4740
4740
|
FailedRequests?: FailedWorkspaceChangeRequest[];
|
|
4741
4741
|
}
|
|
@@ -4744,48 +4744,48 @@ export interface RebuildWorkspacesResult {
|
|
|
4744
4744
|
*/
|
|
4745
4745
|
export interface RegisterWorkspaceDirectoryRequest {
|
|
4746
4746
|
/**
|
|
4747
|
-
* @public
|
|
4748
4747
|
* <p>The identifier of the directory. You cannot register a directory if it does not have a
|
|
4749
4748
|
* status of Active. If the directory does not have a status of Active, you will receive an
|
|
4750
4749
|
* InvalidResourceStateException error. If you have already registered the maximum number of
|
|
4751
4750
|
* directories that you can register with Amazon WorkSpaces, you will receive a
|
|
4752
4751
|
* ResourceLimitExceededException error. Deregister directories that you are not using for
|
|
4753
4752
|
* WorkSpaces, and try again.</p>
|
|
4753
|
+
* @public
|
|
4754
4754
|
*/
|
|
4755
4755
|
DirectoryId: string | undefined;
|
|
4756
4756
|
/**
|
|
4757
|
-
* @public
|
|
4758
4757
|
* <p>The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the
|
|
4759
4758
|
* subnets are in supported Availability Zones. The subnets must also be in separate
|
|
4760
4759
|
* Availability Zones. If these conditions are not met, you will receive an
|
|
4761
4760
|
* OperationNotSupportedException error.</p>
|
|
4761
|
+
* @public
|
|
4762
4762
|
*/
|
|
4763
4763
|
SubnetIds?: string[];
|
|
4764
4764
|
/**
|
|
4765
|
-
* @public
|
|
4766
4765
|
* <p>Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this
|
|
4767
4766
|
* parameter and WorkDocs is not available in the Region, you will receive an
|
|
4768
4767
|
* OperationNotSupportedException error. Set <code>EnableWorkDocs</code> to disabled, and try
|
|
4769
4768
|
* again.</p>
|
|
4769
|
+
* @public
|
|
4770
4770
|
*/
|
|
4771
4771
|
EnableWorkDocs: boolean | undefined;
|
|
4772
4772
|
/**
|
|
4773
|
-
* @public
|
|
4774
4773
|
* <p>Indicates whether self-service capabilities are enabled or disabled.</p>
|
|
4774
|
+
* @public
|
|
4775
4775
|
*/
|
|
4776
4776
|
EnableSelfService?: boolean;
|
|
4777
4777
|
/**
|
|
4778
|
-
* @public
|
|
4779
4778
|
* <p>Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own
|
|
4780
4779
|
* License (BYOL) images, this value must be set to <code>DEDICATED</code> and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for
|
|
4781
4780
|
* BYOL, you will receive an InvalidParameterValuesException error. For more information about
|
|
4782
4781
|
* BYOL images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html">Bring Your Own Windows
|
|
4783
4782
|
* Desktop Images</a>.</p>
|
|
4783
|
+
* @public
|
|
4784
4784
|
*/
|
|
4785
4785
|
Tenancy?: Tenancy;
|
|
4786
4786
|
/**
|
|
4787
|
-
* @public
|
|
4788
4787
|
* <p>The tags associated with the directory.</p>
|
|
4788
|
+
* @public
|
|
4789
4789
|
*/
|
|
4790
4790
|
Tags?: Tag[];
|
|
4791
4791
|
}
|
|
@@ -4795,11 +4795,11 @@ export interface RegisterWorkspaceDirectoryRequest {
|
|
|
4795
4795
|
export interface RegisterWorkspaceDirectoryResult {
|
|
4796
4796
|
}
|
|
4797
4797
|
/**
|
|
4798
|
-
* @public
|
|
4799
4798
|
* <p>The configuration of this network is not supported for this operation, or your network configuration
|
|
4800
4799
|
* conflicts with the Amazon WorkSpaces management network IP range. For more information, see
|
|
4801
4800
|
* <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html">
|
|
4802
4801
|
* Configure a VPC for Amazon WorkSpaces</a>.</p>
|
|
4802
|
+
* @public
|
|
4803
4803
|
*/
|
|
4804
4804
|
export declare class UnsupportedNetworkConfigurationException extends __BaseException {
|
|
4805
4805
|
readonly name: "UnsupportedNetworkConfigurationException";
|
|
@@ -4810,9 +4810,9 @@ export declare class UnsupportedNetworkConfigurationException extends __BaseExce
|
|
|
4810
4810
|
constructor(opts: __ExceptionOptionType<UnsupportedNetworkConfigurationException, __BaseException>);
|
|
4811
4811
|
}
|
|
4812
4812
|
/**
|
|
4813
|
-
* @public
|
|
4814
4813
|
* <p>The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you
|
|
4815
4814
|
* 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>
|
|
4815
|
+
* @public
|
|
4816
4816
|
*/
|
|
4817
4817
|
export declare class WorkspacesDefaultRoleNotFoundException extends __BaseException {
|
|
4818
4818
|
readonly name: "WorkspacesDefaultRoleNotFoundException";
|
|
@@ -4827,8 +4827,8 @@ export declare class WorkspacesDefaultRoleNotFoundException extends __BaseExcept
|
|
|
4827
4827
|
*/
|
|
4828
4828
|
export interface RestoreWorkspaceRequest {
|
|
4829
4829
|
/**
|
|
4830
|
-
* @public
|
|
4831
4830
|
* <p>The identifier of the WorkSpace.</p>
|
|
4831
|
+
* @public
|
|
4832
4832
|
*/
|
|
4833
4833
|
WorkspaceId: string | undefined;
|
|
4834
4834
|
}
|
|
@@ -4842,13 +4842,13 @@ export interface RestoreWorkspaceResult {
|
|
|
4842
4842
|
*/
|
|
4843
4843
|
export interface RevokeIpRulesRequest {
|
|
4844
4844
|
/**
|
|
4845
|
-
* @public
|
|
4846
4845
|
* <p>The identifier of the group.</p>
|
|
4846
|
+
* @public
|
|
4847
4847
|
*/
|
|
4848
4848
|
GroupId: string | undefined;
|
|
4849
4849
|
/**
|
|
4850
|
-
* @public
|
|
4851
4850
|
* <p>The rules to remove from the group.</p>
|
|
4851
|
+
* @public
|
|
4852
4852
|
*/
|
|
4853
4853
|
UserRules: string[] | undefined;
|
|
4854
4854
|
}
|
|
@@ -4858,13 +4858,13 @@ export interface RevokeIpRulesRequest {
|
|
|
4858
4858
|
export interface RevokeIpRulesResult {
|
|
4859
4859
|
}
|
|
4860
4860
|
/**
|
|
4861
|
-
* @public
|
|
4862
4861
|
* <p>Information used to start a WorkSpace.</p>
|
|
4862
|
+
* @public
|
|
4863
4863
|
*/
|
|
4864
4864
|
export interface StartRequest {
|
|
4865
4865
|
/**
|
|
4866
|
-
* @public
|
|
4867
4866
|
* <p>The identifier of the WorkSpace.</p>
|
|
4867
|
+
* @public
|
|
4868
4868
|
*/
|
|
4869
4869
|
WorkspaceId?: string;
|
|
4870
4870
|
}
|
|
@@ -4873,8 +4873,8 @@ export interface StartRequest {
|
|
|
4873
4873
|
*/
|
|
4874
4874
|
export interface StartWorkspacesRequest {
|
|
4875
4875
|
/**
|
|
4876
|
-
* @public
|
|
4877
4876
|
* <p>The WorkSpaces to start. You can specify up to 25 WorkSpaces.</p>
|
|
4877
|
+
* @public
|
|
4878
4878
|
*/
|
|
4879
4879
|
StartWorkspaceRequests: StartRequest[] | undefined;
|
|
4880
4880
|
}
|
|
@@ -4883,19 +4883,19 @@ export interface StartWorkspacesRequest {
|
|
|
4883
4883
|
*/
|
|
4884
4884
|
export interface StartWorkspacesResult {
|
|
4885
4885
|
/**
|
|
4886
|
-
* @public
|
|
4887
4886
|
* <p>Information about the WorkSpaces that could not be started.</p>
|
|
4887
|
+
* @public
|
|
4888
4888
|
*/
|
|
4889
4889
|
FailedRequests?: FailedWorkspaceChangeRequest[];
|
|
4890
4890
|
}
|
|
4891
4891
|
/**
|
|
4892
|
-
* @public
|
|
4893
4892
|
* <p>Describes the information used to stop a WorkSpace.</p>
|
|
4893
|
+
* @public
|
|
4894
4894
|
*/
|
|
4895
4895
|
export interface StopRequest {
|
|
4896
4896
|
/**
|
|
4897
|
-
* @public
|
|
4898
4897
|
* <p>The identifier of the WorkSpace.</p>
|
|
4898
|
+
* @public
|
|
4899
4899
|
*/
|
|
4900
4900
|
WorkspaceId?: string;
|
|
4901
4901
|
}
|
|
@@ -4904,8 +4904,8 @@ export interface StopRequest {
|
|
|
4904
4904
|
*/
|
|
4905
4905
|
export interface StopWorkspacesRequest {
|
|
4906
4906
|
/**
|
|
4907
|
-
* @public
|
|
4908
4907
|
* <p>The WorkSpaces to stop. You can specify up to 25 WorkSpaces.</p>
|
|
4908
|
+
* @public
|
|
4909
4909
|
*/
|
|
4910
4910
|
StopWorkspaceRequests: StopRequest[] | undefined;
|
|
4911
4911
|
}
|
|
@@ -4914,19 +4914,19 @@ export interface StopWorkspacesRequest {
|
|
|
4914
4914
|
*/
|
|
4915
4915
|
export interface StopWorkspacesResult {
|
|
4916
4916
|
/**
|
|
4917
|
-
* @public
|
|
4918
4917
|
* <p>Information about the WorkSpaces that could not be stopped.</p>
|
|
4918
|
+
* @public
|
|
4919
4919
|
*/
|
|
4920
4920
|
FailedRequests?: FailedWorkspaceChangeRequest[];
|
|
4921
4921
|
}
|
|
4922
4922
|
/**
|
|
4923
|
-
* @public
|
|
4924
4923
|
* <p>Describes the information used to terminate a WorkSpace.</p>
|
|
4924
|
+
* @public
|
|
4925
4925
|
*/
|
|
4926
4926
|
export interface TerminateRequest {
|
|
4927
4927
|
/**
|
|
4928
|
-
* @public
|
|
4929
4928
|
* <p>The identifier of the WorkSpace.</p>
|
|
4929
|
+
* @public
|
|
4930
4930
|
*/
|
|
4931
4931
|
WorkspaceId: string | undefined;
|
|
4932
4932
|
}
|
|
@@ -4935,8 +4935,8 @@ export interface TerminateRequest {
|
|
|
4935
4935
|
*/
|
|
4936
4936
|
export interface TerminateWorkspacesRequest {
|
|
4937
4937
|
/**
|
|
4938
|
-
* @public
|
|
4939
4938
|
* <p>The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.</p>
|
|
4939
|
+
* @public
|
|
4940
4940
|
*/
|
|
4941
4941
|
TerminateWorkspaceRequests: TerminateRequest[] | undefined;
|
|
4942
4942
|
}
|
|
@@ -4945,8 +4945,8 @@ export interface TerminateWorkspacesRequest {
|
|
|
4945
4945
|
*/
|
|
4946
4946
|
export interface TerminateWorkspacesResult {
|
|
4947
4947
|
/**
|
|
4948
|
-
* @public
|
|
4949
4948
|
* <p>Information about the WorkSpaces that could not be terminated.</p>
|
|
4949
|
+
* @public
|
|
4950
4950
|
*/
|
|
4951
4951
|
FailedRequests?: FailedWorkspaceChangeRequest[];
|
|
4952
4952
|
}
|
|
@@ -4955,23 +4955,23 @@ export interface TerminateWorkspacesResult {
|
|
|
4955
4955
|
*/
|
|
4956
4956
|
export interface UpdateConnectClientAddInRequest {
|
|
4957
4957
|
/**
|
|
4958
|
-
* @public
|
|
4959
4958
|
* <p>The identifier of the client add-in to update.</p>
|
|
4959
|
+
* @public
|
|
4960
4960
|
*/
|
|
4961
4961
|
AddInId: string | undefined;
|
|
4962
4962
|
/**
|
|
4963
|
-
* @public
|
|
4964
4963
|
* <p>The directory identifier for which the client add-in is configured.</p>
|
|
4964
|
+
* @public
|
|
4965
4965
|
*/
|
|
4966
4966
|
ResourceId: string | undefined;
|
|
4967
4967
|
/**
|
|
4968
|
-
* @public
|
|
4969
4968
|
* <p>The name of the client add-in.</p>
|
|
4969
|
+
* @public
|
|
4970
4970
|
*/
|
|
4971
4971
|
Name?: string;
|
|
4972
4972
|
/**
|
|
4973
|
-
* @public
|
|
4974
4973
|
* <p>The endpoint URL of the Amazon Connect client add-in.</p>
|
|
4974
|
+
* @public
|
|
4975
4975
|
*/
|
|
4976
4976
|
URL?: string;
|
|
4977
4977
|
}
|
|
@@ -4985,13 +4985,13 @@ export interface UpdateConnectClientAddInResult {
|
|
|
4985
4985
|
*/
|
|
4986
4986
|
export interface UpdateConnectionAliasPermissionRequest {
|
|
4987
4987
|
/**
|
|
4988
|
-
* @public
|
|
4989
4988
|
* <p>The identifier of the connection alias that you want to update permissions for.</p>
|
|
4989
|
+
* @public
|
|
4990
4990
|
*/
|
|
4991
4991
|
AliasId: string | undefined;
|
|
4992
4992
|
/**
|
|
4993
|
-
* @public
|
|
4994
4993
|
* <p>Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.</p>
|
|
4994
|
+
* @public
|
|
4995
4995
|
*/
|
|
4996
4996
|
ConnectionAliasPermission: ConnectionAliasPermission | undefined;
|
|
4997
4997
|
}
|
|
@@ -5005,13 +5005,13 @@ export interface UpdateConnectionAliasPermissionResult {
|
|
|
5005
5005
|
*/
|
|
5006
5006
|
export interface UpdateRulesOfIpGroupRequest {
|
|
5007
5007
|
/**
|
|
5008
|
-
* @public
|
|
5009
5008
|
* <p>The identifier of the group.</p>
|
|
5009
|
+
* @public
|
|
5010
5010
|
*/
|
|
5011
5011
|
GroupId: string | undefined;
|
|
5012
5012
|
/**
|
|
5013
|
-
* @public
|
|
5014
5013
|
* <p>One or more rules.</p>
|
|
5014
|
+
* @public
|
|
5015
5015
|
*/
|
|
5016
5016
|
UserRules: IpRuleItem[] | undefined;
|
|
5017
5017
|
}
|
|
@@ -5025,13 +5025,13 @@ export interface UpdateRulesOfIpGroupResult {
|
|
|
5025
5025
|
*/
|
|
5026
5026
|
export interface UpdateWorkspaceBundleRequest {
|
|
5027
5027
|
/**
|
|
5028
|
-
* @public
|
|
5029
5028
|
* <p>The identifier of the bundle.</p>
|
|
5029
|
+
* @public
|
|
5030
5030
|
*/
|
|
5031
5031
|
BundleId?: string;
|
|
5032
5032
|
/**
|
|
5033
|
-
* @public
|
|
5034
5033
|
* <p>The identifier of the image.</p>
|
|
5034
|
+
* @public
|
|
5035
5035
|
*/
|
|
5036
5036
|
ImageId?: string;
|
|
5037
5037
|
}
|
|
@@ -5045,23 +5045,23 @@ export interface UpdateWorkspaceBundleResult {
|
|
|
5045
5045
|
*/
|
|
5046
5046
|
export interface UpdateWorkspaceImagePermissionRequest {
|
|
5047
5047
|
/**
|
|
5048
|
-
* @public
|
|
5049
5048
|
* <p>The identifier of the image.</p>
|
|
5049
|
+
* @public
|
|
5050
5050
|
*/
|
|
5051
5051
|
ImageId: string | undefined;
|
|
5052
5052
|
/**
|
|
5053
|
-
* @public
|
|
5054
5053
|
* <p>The permission to copy the image. This permission can be revoked only after an image has
|
|
5055
5054
|
* been shared.</p>
|
|
5055
|
+
* @public
|
|
5056
5056
|
*/
|
|
5057
5057
|
AllowCopyImage: boolean | undefined;
|
|
5058
5058
|
/**
|
|
5059
|
-
* @public
|
|
5060
5059
|
* <p>The identifier of the Amazon Web Services account to share or unshare the image
|
|
5061
5060
|
* with.</p>
|
|
5062
5061
|
* <important>
|
|
5063
5062
|
* <p>Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.</p>
|
|
5064
5063
|
* </important>
|
|
5064
|
+
* @public
|
|
5065
5065
|
*/
|
|
5066
5066
|
SharedAccountId: string | undefined;
|
|
5067
5067
|
}
|