workspaces.d.ts (33890B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class WorkSpaces extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: WorkSpaces.Types.ClientConfiguration) 13 config: Config & WorkSpaces.Types.ClientConfiguration; 14 /** 15 * Creates tags for a WorkSpace. 16 */ 17 createTags(params: WorkSpaces.Types.CreateTagsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.CreateTagsResult) => void): Request<WorkSpaces.Types.CreateTagsResult, AWSError>; 18 /** 19 * Creates tags for a WorkSpace. 20 */ 21 createTags(callback?: (err: AWSError, data: WorkSpaces.Types.CreateTagsResult) => void): Request<WorkSpaces.Types.CreateTagsResult, AWSError>; 22 /** 23 * Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created. 24 */ 25 createWorkspaces(params: WorkSpaces.Types.CreateWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.CreateWorkspacesResult) => void): Request<WorkSpaces.Types.CreateWorkspacesResult, AWSError>; 26 /** 27 * Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created. 28 */ 29 createWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.CreateWorkspacesResult) => void): Request<WorkSpaces.Types.CreateWorkspacesResult, AWSError>; 30 /** 31 * Deletes tags from a WorkSpace. 32 */ 33 deleteTags(params: WorkSpaces.Types.DeleteTagsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DeleteTagsResult) => void): Request<WorkSpaces.Types.DeleteTagsResult, AWSError>; 34 /** 35 * Deletes tags from a WorkSpace. 36 */ 37 deleteTags(callback?: (err: AWSError, data: WorkSpaces.Types.DeleteTagsResult) => void): Request<WorkSpaces.Types.DeleteTagsResult, AWSError>; 38 /** 39 * Describes tags for a WorkSpace. 40 */ 41 describeTags(params: WorkSpaces.Types.DescribeTagsRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeTagsResult) => void): Request<WorkSpaces.Types.DescribeTagsResult, AWSError>; 42 /** 43 * Describes tags for a WorkSpace. 44 */ 45 describeTags(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeTagsResult) => void): Request<WorkSpaces.Types.DescribeTagsResult, AWSError>; 46 /** 47 * Obtains information about the WorkSpace bundles that are available to your account in the specified region. You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items. 48 */ 49 describeWorkspaceBundles(params: WorkSpaces.Types.DescribeWorkspaceBundlesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceBundlesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceBundlesResult, AWSError>; 50 /** 51 * Obtains information about the WorkSpace bundles that are available to your account in the specified region. You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items. 52 */ 53 describeWorkspaceBundles(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceBundlesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceBundlesResult, AWSError>; 54 /** 55 * Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items. 56 */ 57 describeWorkspaceDirectories(params: WorkSpaces.Types.DescribeWorkspaceDirectoriesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceDirectoriesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceDirectoriesResult, AWSError>; 58 /** 59 * Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items. 60 */ 61 describeWorkspaceDirectories(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspaceDirectoriesResult) => void): Request<WorkSpaces.Types.DescribeWorkspaceDirectoriesResult, AWSError>; 62 /** 63 * Obtains information about the specified WorkSpaces. Only one of the filter parameters, such as BundleId, DirectoryId, or WorkspaceIds, can be specified at a time. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items. 64 */ 65 describeWorkspaces(params: WorkSpaces.Types.DescribeWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesResult, AWSError>; 66 /** 67 * Obtains information about the specified WorkSpaces. Only one of the filter parameters, such as BundleId, DirectoryId, or WorkspaceIds, can be specified at a time. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items. 68 */ 69 describeWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesResult, AWSError>; 70 /** 71 * Describes the connection status of a specified WorkSpace. 72 */ 73 describeWorkspacesConnectionStatus(params: WorkSpaces.Types.DescribeWorkspacesConnectionStatusRequest, callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult, AWSError>; 74 /** 75 * Describes the connection status of a specified WorkSpace. 76 */ 77 describeWorkspacesConnectionStatus(callback?: (err: AWSError, data: WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult) => void): Request<WorkSpaces.Types.DescribeWorkspacesConnectionStatusResult, AWSError>; 78 /** 79 * Modifies the WorkSpace properties, including the RunningMode and AutoStop time. 80 */ 81 modifyWorkspaceProperties(params: WorkSpaces.Types.ModifyWorkspacePropertiesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspacePropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspacePropertiesResult, AWSError>; 82 /** 83 * Modifies the WorkSpace properties, including the RunningMode and AutoStop time. 84 */ 85 modifyWorkspaceProperties(callback?: (err: AWSError, data: WorkSpaces.Types.ModifyWorkspacePropertiesResult) => void): Request<WorkSpaces.Types.ModifyWorkspacePropertiesResult, AWSError>; 86 /** 87 * Reboots the specified WorkSpaces. To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE, IMPAIRED, or INOPERABLE. This operation is asynchronous and returns before the WorkSpaces have rebooted. 88 */ 89 rebootWorkspaces(params: WorkSpaces.Types.RebootWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RebootWorkspacesResult) => void): Request<WorkSpaces.Types.RebootWorkspacesResult, AWSError>; 90 /** 91 * Reboots the specified WorkSpaces. To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE, IMPAIRED, or INOPERABLE. This operation is asynchronous and returns before the WorkSpaces have rebooted. 92 */ 93 rebootWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.RebootWorkspacesResult) => void): Request<WorkSpaces.Types.RebootWorkspacesResult, AWSError>; 94 /** 95 * Rebuilds the specified WorkSpaces. Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur: The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost. The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old. To be able to rebuild a WorkSpace, the WorkSpace must have a State of AVAILABLE or ERROR. This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt. 96 */ 97 rebuildWorkspaces(params: WorkSpaces.Types.RebuildWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.RebuildWorkspacesResult) => void): Request<WorkSpaces.Types.RebuildWorkspacesResult, AWSError>; 98 /** 99 * Rebuilds the specified WorkSpaces. Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur: The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost. The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old. To be able to rebuild a WorkSpace, the WorkSpace must have a State of AVAILABLE or ERROR. This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt. 100 */ 101 rebuildWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.RebuildWorkspacesResult) => void): Request<WorkSpaces.Types.RebuildWorkspacesResult, AWSError>; 102 /** 103 * Starts the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to “STOPPED.” 104 */ 105 startWorkspaces(params: WorkSpaces.Types.StartWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.StartWorkspacesResult) => void): Request<WorkSpaces.Types.StartWorkspacesResult, AWSError>; 106 /** 107 * Starts the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to “STOPPED.” 108 */ 109 startWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.StartWorkspacesResult) => void): Request<WorkSpaces.Types.StartWorkspacesResult, AWSError>; 110 /** 111 * Stops the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR. 112 */ 113 stopWorkspaces(params: WorkSpaces.Types.StopWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.StopWorkspacesResult) => void): Request<WorkSpaces.Types.StopWorkspacesResult, AWSError>; 114 /** 115 * Stops the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR. 116 */ 117 stopWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.StopWorkspacesResult) => void): Request<WorkSpaces.Types.StopWorkspacesResult, AWSError>; 118 /** 119 * Terminates the specified WorkSpaces. Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace. You can terminate a WorkSpace that is in any state except SUSPENDED. This operation is asynchronous and returns before the WorkSpaces have been completely terminated. 120 */ 121 terminateWorkspaces(params: WorkSpaces.Types.TerminateWorkspacesRequest, callback?: (err: AWSError, data: WorkSpaces.Types.TerminateWorkspacesResult) => void): Request<WorkSpaces.Types.TerminateWorkspacesResult, AWSError>; 122 /** 123 * Terminates the specified WorkSpaces. Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace. You can terminate a WorkSpace that is in any state except SUSPENDED. This operation is asynchronous and returns before the WorkSpaces have been completely terminated. 124 */ 125 terminateWorkspaces(callback?: (err: AWSError, data: WorkSpaces.Types.TerminateWorkspacesResult) => void): Request<WorkSpaces.Types.TerminateWorkspacesResult, AWSError>; 126 } 127 declare namespace WorkSpaces.Types { 128 export type ARN = string; 129 export type Alias = string; 130 export type BooleanObject = boolean; 131 export type BundleId = string; 132 export type BundleIdList = BundleId[]; 133 export type BundleList = WorkspaceBundle[]; 134 export type BundleOwner = string; 135 export type Compute = "VALUE"|"STANDARD"|"PERFORMANCE"|string; 136 export interface ComputeType { 137 /** 138 * The name of the compute type for the bundle. 139 */ 140 Name?: Compute; 141 } 142 export type ComputerName = string; 143 export type ConnectionState = "CONNECTED"|"DISCONNECTED"|"UNKNOWN"|string; 144 export interface CreateTagsRequest { 145 /** 146 * The resource ID of the request. 147 */ 148 ResourceId: NonEmptyString; 149 /** 150 * The tags of the request. 151 */ 152 Tags: TagList; 153 } 154 export interface CreateTagsResult { 155 } 156 export interface CreateWorkspacesRequest { 157 /** 158 * An array of structures that specify the WorkSpaces to create. 159 */ 160 Workspaces: WorkspaceRequestList; 161 } 162 export interface CreateWorkspacesResult { 163 /** 164 * An array of structures that represent the WorkSpaces that could not be created. 165 */ 166 FailedRequests?: FailedCreateWorkspaceRequests; 167 /** 168 * An array of structures that represent the WorkSpaces that were created. Because this operation is asynchronous, the identifier in WorkspaceId is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned. 169 */ 170 PendingRequests?: WorkspaceList; 171 } 172 export type DefaultOu = string; 173 export interface DefaultWorkspaceCreationProperties { 174 /** 175 * Specifies if the directory is enabled for Amazon WorkDocs. 176 */ 177 EnableWorkDocs?: BooleanObject; 178 /** 179 * A public IP address will be attached to all WorkSpaces that are created or rebuilt. 180 */ 181 EnableInternetAccess?: BooleanObject; 182 /** 183 * The organizational unit (OU) in the directory that the WorkSpace machine accounts are placed in. 184 */ 185 DefaultOu?: DefaultOu; 186 /** 187 * The identifier of any custom security groups that are applied to the WorkSpaces when they are created. 188 */ 189 CustomSecurityGroupId?: SecurityGroupId; 190 /** 191 * The WorkSpace user is an administrator on the WorkSpace. 192 */ 193 UserEnabledAsLocalAdministrator?: BooleanObject; 194 } 195 export interface DeleteTagsRequest { 196 /** 197 * The resource ID of the request. 198 */ 199 ResourceId: NonEmptyString; 200 /** 201 * The tag keys of the request. 202 */ 203 TagKeys: TagKeyList; 204 } 205 export interface DeleteTagsResult { 206 } 207 export interface DescribeTagsRequest { 208 /** 209 * The resource ID of the request. 210 */ 211 ResourceId: NonEmptyString; 212 } 213 export interface DescribeTagsResult { 214 /** 215 * The list of tags. 216 */ 217 TagList?: TagList; 218 } 219 export interface DescribeWorkspaceBundlesRequest { 220 /** 221 * An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter. 222 */ 223 BundleIds?: BundleIdList; 224 /** 225 * The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter. This contains one of the following values: null- Retrieves the bundles that belong to the account making the call. AMAZON- Retrieves the bundles that are provided by AWS. 226 */ 227 Owner?: BundleOwner; 228 /** 229 * The NextToken value from a previous call to this operation. Pass null if this is the first call. 230 */ 231 NextToken?: PaginationToken; 232 } 233 export interface DescribeWorkspaceBundlesResult { 234 /** 235 * An array of structures that contain information about the bundles. 236 */ 237 Bundles?: BundleList; 238 /** 239 * If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that time frame. 240 */ 241 NextToken?: PaginationToken; 242 } 243 export interface DescribeWorkspaceDirectoriesRequest { 244 /** 245 * An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved. 246 */ 247 DirectoryIds?: DirectoryIdList; 248 /** 249 * The NextToken value from a previous call to this operation. Pass null if this is the first call. 250 */ 251 NextToken?: PaginationToken; 252 } 253 export interface DescribeWorkspaceDirectoriesResult { 254 /** 255 * An array of structures that contain information about the directories. 256 */ 257 Directories?: DirectoryList; 258 /** 259 * If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that time frame. 260 */ 261 NextToken?: PaginationToken; 262 } 263 export interface DescribeWorkspacesConnectionStatusRequest { 264 /** 265 * An array of strings that contain the identifiers of the WorkSpaces. 266 */ 267 WorkspaceIds?: WorkspaceIdList; 268 /** 269 * The next token of the request. 270 */ 271 NextToken?: PaginationToken; 272 } 273 export interface DescribeWorkspacesConnectionStatusResult { 274 /** 275 * The connection status of the WorkSpace. 276 */ 277 WorkspacesConnectionStatus?: WorkspaceConnectionStatusList; 278 /** 279 * The next token of the result. 280 */ 281 NextToken?: PaginationToken; 282 } 283 export interface DescribeWorkspacesRequest { 284 /** 285 * An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter. Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned. 286 */ 287 WorkspaceIds?: WorkspaceIdList; 288 /** 289 * Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the UserName parameter. This parameter cannot be combined with any other filter parameter. 290 */ 291 DirectoryId?: DirectoryId; 292 /** 293 * Used with the DirectoryId parameter to specify the directory user for whom to obtain the WorkSpace. 294 */ 295 UserName?: UserName; 296 /** 297 * The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter. 298 */ 299 BundleId?: BundleId; 300 /** 301 * The maximum number of items to return. 302 */ 303 Limit?: Limit; 304 /** 305 * The NextToken value from a previous call to this operation. Pass null if this is the first call. 306 */ 307 NextToken?: PaginationToken; 308 } 309 export interface DescribeWorkspacesResult { 310 /** 311 * An array of structures that contain the information about the WorkSpaces. Because the CreateWorkspaces operation is asynchronous, some of this information may be incomplete for a newly-created WorkSpace. 312 */ 313 Workspaces?: WorkspaceList; 314 /** 315 * If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that time frame. 316 */ 317 NextToken?: PaginationToken; 318 } 319 export type Description = string; 320 export type DirectoryId = string; 321 export type DirectoryIdList = DirectoryId[]; 322 export type DirectoryList = WorkspaceDirectory[]; 323 export type DirectoryName = string; 324 export type DnsIpAddresses = IpAddress[]; 325 export type ErrorType = string; 326 export type ExceptionMessage = string; 327 export interface FailedCreateWorkspaceRequest { 328 /** 329 * A FailedCreateWorkspaceRequest$WorkspaceRequest object that contains the information about the WorkSpace that could not be created. 330 */ 331 WorkspaceRequest?: WorkspaceRequest; 332 /** 333 * The error code. 334 */ 335 ErrorCode?: ErrorType; 336 /** 337 * The textual error message. 338 */ 339 ErrorMessage?: Description; 340 } 341 export type FailedCreateWorkspaceRequests = FailedCreateWorkspaceRequest[]; 342 export type FailedRebootWorkspaceRequests = FailedWorkspaceChangeRequest[]; 343 export type FailedRebuildWorkspaceRequests = FailedWorkspaceChangeRequest[]; 344 export type FailedStartWorkspaceRequests = FailedWorkspaceChangeRequest[]; 345 export type FailedStopWorkspaceRequests = FailedWorkspaceChangeRequest[]; 346 export type FailedTerminateWorkspaceRequests = FailedWorkspaceChangeRequest[]; 347 export interface FailedWorkspaceChangeRequest { 348 /** 349 * The identifier of the WorkSpace. 350 */ 351 WorkspaceId?: WorkspaceId; 352 /** 353 * The error code. 354 */ 355 ErrorCode?: ErrorType; 356 /** 357 * The textual error message. 358 */ 359 ErrorMessage?: Description; 360 } 361 export type IpAddress = string; 362 export type Limit = number; 363 export interface ModifyWorkspacePropertiesRequest { 364 /** 365 * The ID of the WorkSpace. 366 */ 367 WorkspaceId: WorkspaceId; 368 /** 369 * The WorkSpace properties of the request. 370 */ 371 WorkspaceProperties: WorkspaceProperties; 372 } 373 export interface ModifyWorkspacePropertiesResult { 374 } 375 export type NonEmptyString = string; 376 export type PaginationToken = string; 377 export interface RebootRequest { 378 /** 379 * The identifier of the WorkSpace to reboot. 380 */ 381 WorkspaceId: WorkspaceId; 382 } 383 export type RebootWorkspaceRequests = RebootRequest[]; 384 export interface RebootWorkspacesRequest { 385 /** 386 * An array of structures that specify the WorkSpaces to reboot. 387 */ 388 RebootWorkspaceRequests: RebootWorkspaceRequests; 389 } 390 export interface RebootWorkspacesResult { 391 /** 392 * An array of structures representing any WorkSpaces that could not be rebooted. 393 */ 394 FailedRequests?: FailedRebootWorkspaceRequests; 395 } 396 export interface RebuildRequest { 397 /** 398 * The identifier of the WorkSpace to rebuild. 399 */ 400 WorkspaceId: WorkspaceId; 401 } 402 export type RebuildWorkspaceRequests = RebuildRequest[]; 403 export interface RebuildWorkspacesRequest { 404 /** 405 * An array of structures that specify the WorkSpaces to rebuild. 406 */ 407 RebuildWorkspaceRequests: RebuildWorkspaceRequests; 408 } 409 export interface RebuildWorkspacesResult { 410 /** 411 * An array of structures representing any WorkSpaces that could not be rebuilt. 412 */ 413 FailedRequests?: FailedRebuildWorkspaceRequests; 414 } 415 export type RegistrationCode = string; 416 export type RunningMode = "AUTO_STOP"|"ALWAYS_ON"|string; 417 export type RunningModeAutoStopTimeoutInMinutes = number; 418 export type SecurityGroupId = string; 419 export interface StartRequest { 420 /** 421 * The ID of the WorkSpace. 422 */ 423 WorkspaceId?: WorkspaceId; 424 } 425 export type StartWorkspaceRequests = StartRequest[]; 426 export interface StartWorkspacesRequest { 427 /** 428 * The requests. 429 */ 430 StartWorkspaceRequests: StartWorkspaceRequests; 431 } 432 export interface StartWorkspacesResult { 433 /** 434 * The failed requests. 435 */ 436 FailedRequests?: FailedStartWorkspaceRequests; 437 } 438 export interface StopRequest { 439 /** 440 * The ID of the WorkSpace. 441 */ 442 WorkspaceId?: WorkspaceId; 443 } 444 export type StopWorkspaceRequests = StopRequest[]; 445 export interface StopWorkspacesRequest { 446 /** 447 * The requests. 448 */ 449 StopWorkspaceRequests: StopWorkspaceRequests; 450 } 451 export interface StopWorkspacesResult { 452 /** 453 * The failed requests. 454 */ 455 FailedRequests?: FailedStopWorkspaceRequests; 456 } 457 export type SubnetId = string; 458 export type SubnetIds = SubnetId[]; 459 export interface Tag { 460 /** 461 * The key of the tag. 462 */ 463 Key: TagKey; 464 /** 465 * The value of the tag. 466 */ 467 Value?: TagValue; 468 } 469 export type TagKey = string; 470 export type TagKeyList = NonEmptyString[]; 471 export type TagList = Tag[]; 472 export type TagValue = string; 473 export interface TerminateRequest { 474 /** 475 * The identifier of the WorkSpace to terminate. 476 */ 477 WorkspaceId: WorkspaceId; 478 } 479 export type TerminateWorkspaceRequests = TerminateRequest[]; 480 export interface TerminateWorkspacesRequest { 481 /** 482 * An array of structures that specify the WorkSpaces to terminate. 483 */ 484 TerminateWorkspaceRequests: TerminateWorkspaceRequests; 485 } 486 export interface TerminateWorkspacesResult { 487 /** 488 * An array of structures representing any WorkSpaces that could not be terminated. 489 */ 490 FailedRequests?: FailedTerminateWorkspaceRequests; 491 } 492 export type Timestamp = Date; 493 export type UserName = string; 494 export interface UserStorage { 495 /** 496 * The amount of user storage for the bundle. 497 */ 498 Capacity?: NonEmptyString; 499 } 500 export type VolumeEncryptionKey = string; 501 export interface Workspace { 502 /** 503 * The identifier of the WorkSpace. 504 */ 505 WorkspaceId?: WorkspaceId; 506 /** 507 * The identifier of the AWS Directory Service directory that the WorkSpace belongs to. 508 */ 509 DirectoryId?: DirectoryId; 510 /** 511 * The user that the WorkSpace is assigned to. 512 */ 513 UserName?: UserName; 514 /** 515 * The IP address of the WorkSpace. 516 */ 517 IpAddress?: IpAddress; 518 /** 519 * The operational state of the WorkSpace. 520 */ 521 State?: WorkspaceState; 522 /** 523 * The identifier of the bundle that the WorkSpace was created from. 524 */ 525 BundleId?: BundleId; 526 /** 527 * The identifier of the subnet that the WorkSpace is in. 528 */ 529 SubnetId?: SubnetId; 530 /** 531 * If the WorkSpace could not be created, this contains a textual error message that describes the failure. 532 */ 533 ErrorMessage?: Description; 534 /** 535 * If the WorkSpace could not be created, this contains the error code. 536 */ 537 ErrorCode?: WorkspaceErrorCode; 538 /** 539 * The name of the WorkSpace as seen by the operating system. 540 */ 541 ComputerName?: ComputerName; 542 /** 543 * The KMS key used to encrypt data stored on your WorkSpace. 544 */ 545 VolumeEncryptionKey?: VolumeEncryptionKey; 546 /** 547 * Specifies whether the data stored on the user volume, or D: drive, is encrypted. 548 */ 549 UserVolumeEncryptionEnabled?: BooleanObject; 550 /** 551 * Specifies whether the data stored on the root volume, or C: drive, is encrypted. 552 */ 553 RootVolumeEncryptionEnabled?: BooleanObject; 554 WorkspaceProperties?: WorkspaceProperties; 555 } 556 export interface WorkspaceBundle { 557 /** 558 * The bundle identifier. 559 */ 560 BundleId?: BundleId; 561 /** 562 * The name of the bundle. 563 */ 564 Name?: NonEmptyString; 565 /** 566 * The owner of the bundle. This contains the owner's account identifier, or AMAZON if the bundle is provided by AWS. 567 */ 568 Owner?: BundleOwner; 569 /** 570 * The bundle description. 571 */ 572 Description?: Description; 573 /** 574 * A UserStorage object that specifies the amount of user storage that the bundle contains. 575 */ 576 UserStorage?: UserStorage; 577 /** 578 * A ComputeType object that specifies the compute type for the bundle. 579 */ 580 ComputeType?: ComputeType; 581 } 582 export interface WorkspaceConnectionStatus { 583 /** 584 * The ID of the WorkSpace. 585 */ 586 WorkspaceId?: WorkspaceId; 587 /** 588 * The connection state of the WorkSpace. Returns UNKOWN if the WorkSpace is in a Stopped state. 589 */ 590 ConnectionState?: ConnectionState; 591 /** 592 * The timestamp of the connection state check. 593 */ 594 ConnectionStateCheckTimestamp?: Timestamp; 595 /** 596 * The timestamp of the last known user connection. 597 */ 598 LastKnownUserConnectionTimestamp?: Timestamp; 599 } 600 export type WorkspaceConnectionStatusList = WorkspaceConnectionStatus[]; 601 export interface WorkspaceDirectory { 602 /** 603 * The directory identifier. 604 */ 605 DirectoryId?: DirectoryId; 606 /** 607 * The directory alias. 608 */ 609 Alias?: Alias; 610 /** 611 * The name of the directory. 612 */ 613 DirectoryName?: DirectoryName; 614 /** 615 * The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory. 616 */ 617 RegistrationCode?: RegistrationCode; 618 /** 619 * An array of strings that contains the identifiers of the subnets used with the directory. 620 */ 621 SubnetIds?: SubnetIds; 622 /** 623 * An array of strings that contains the IP addresses of the DNS servers for the directory. 624 */ 625 DnsIpAddresses?: DnsIpAddresses; 626 /** 627 * The user name for the service account. 628 */ 629 CustomerUserName?: UserName; 630 /** 631 * The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf. 632 */ 633 IamRoleId?: ARN; 634 /** 635 * The directory type. 636 */ 637 DirectoryType?: WorkspaceDirectoryType; 638 /** 639 * The identifier of the security group that is assigned to new WorkSpaces. 640 */ 641 WorkspaceSecurityGroupId?: SecurityGroupId; 642 /** 643 * The state of the directory's registration with Amazon WorkSpaces 644 */ 645 State?: WorkspaceDirectoryState; 646 /** 647 * A structure that specifies the default creation properties for all WorkSpaces in the directory. 648 */ 649 WorkspaceCreationProperties?: DefaultWorkspaceCreationProperties; 650 } 651 export type WorkspaceDirectoryState = "REGISTERING"|"REGISTERED"|"DEREGISTERING"|"DEREGISTERED"|"ERROR"|string; 652 export type WorkspaceDirectoryType = "SIMPLE_AD"|"AD_CONNECTOR"|string; 653 export type WorkspaceErrorCode = string; 654 export type WorkspaceId = string; 655 export type WorkspaceIdList = WorkspaceId[]; 656 export type WorkspaceList = Workspace[]; 657 export interface WorkspaceProperties { 658 /** 659 * The running mode of the WorkSpace. AlwaysOn WorkSpaces are billed monthly. AutoStop WorkSpaces are billed by the hour and stopped when no longer being used in order to save on costs. 660 */ 661 RunningMode?: RunningMode; 662 /** 663 * The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals. 664 */ 665 RunningModeAutoStopTimeoutInMinutes?: RunningModeAutoStopTimeoutInMinutes; 666 } 667 export interface WorkspaceRequest { 668 /** 669 * The identifier of the AWS Directory Service directory to create the WorkSpace in. You can use the DescribeWorkspaceDirectories operation to obtain a list of the directories that are available. 670 */ 671 DirectoryId: DirectoryId; 672 /** 673 * The username that the WorkSpace is assigned to. This username must exist in the AWS Directory Service directory specified by the DirectoryId member. 674 */ 675 UserName: UserName; 676 /** 677 * The identifier of the bundle to create the WorkSpace from. You can use the DescribeWorkspaceBundles operation to obtain a list of the bundles that are available. 678 */ 679 BundleId: BundleId; 680 /** 681 * The KMS key used to encrypt data stored on your WorkSpace. 682 */ 683 VolumeEncryptionKey?: VolumeEncryptionKey; 684 /** 685 * Specifies whether the data stored on the user volume, or D: drive, is encrypted. 686 */ 687 UserVolumeEncryptionEnabled?: BooleanObject; 688 /** 689 * Specifies whether the data stored on the root volume, or C: drive, is encrypted. 690 */ 691 RootVolumeEncryptionEnabled?: BooleanObject; 692 WorkspaceProperties?: WorkspaceProperties; 693 /** 694 * The tags of the WorkSpace request. 695 */ 696 Tags?: TagList; 697 } 698 export type WorkspaceRequestList = WorkspaceRequest[]; 699 export type WorkspaceState = "PENDING"|"AVAILABLE"|"IMPAIRED"|"UNHEALTHY"|"REBOOTING"|"STARTING"|"REBUILDING"|"MAINTENANCE"|"TERMINATING"|"TERMINATED"|"SUSPENDED"|"STOPPING"|"STOPPED"|"ERROR"|string; 700 /** 701 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 702 */ 703 export type apiVersion = "2015-04-08"|"latest"|string; 704 export interface ClientApiVersions { 705 /** 706 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 707 */ 708 apiVersion?: apiVersion; 709 } 710 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 711 } 712 export = WorkSpaces;