{ "version":"2.0", "metadata":{ "apiVersion":"2015-04-08", "endpointPrefix":"workspaces", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon WorkSpaces", "signatureVersion":"v4", "targetPrefix":"WorkspacesService", "uid":"workspaces-2015-04-08" }, "operations":{ "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTagsRequest"}, "output":{"shape":"CreateTagsResult"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValuesException"}, {"shape":"ResourceLimitExceededException"} ], "documentation":"

Creates tags for a WorkSpace.

" }, "CreateWorkspaces":{ "name":"CreateWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateWorkspacesRequest"}, "output":{"shape":"CreateWorkspacesResult"}, "errors":[ {"shape":"ResourceLimitExceededException"}, {"shape":"InvalidParameterValuesException"} ], "documentation":"

Creates one or more WorkSpaces.

This operation is asynchronous and returns before the WorkSpaces are created.

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsRequest"}, "output":{"shape":"DeleteTagsResult"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValuesException"} ], "documentation":"

Deletes tags from a WorkSpace.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResult"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes tags for a WorkSpace.

" }, "DescribeWorkspaceBundles":{ "name":"DescribeWorkspaceBundles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWorkspaceBundlesRequest"}, "output":{"shape":"DescribeWorkspaceBundlesResult"}, "errors":[ {"shape":"InvalidParameterValuesException"} ], "documentation":"

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.

" }, "DescribeWorkspaceDirectories":{ "name":"DescribeWorkspaceDirectories", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWorkspaceDirectoriesRequest"}, "output":{"shape":"DescribeWorkspaceDirectoriesResult"}, "errors":[ {"shape":"InvalidParameterValuesException"} ], "documentation":"

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.

" }, "DescribeWorkspaces":{ "name":"DescribeWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWorkspacesRequest"}, "output":{"shape":"DescribeWorkspacesResult"}, "errors":[ {"shape":"InvalidParameterValuesException"}, {"shape":"ResourceUnavailableException"} ], "documentation":"

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.

" }, "DescribeWorkspacesConnectionStatus":{ "name":"DescribeWorkspacesConnectionStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWorkspacesConnectionStatusRequest"}, "output":{"shape":"DescribeWorkspacesConnectionStatusResult"}, "errors":[ {"shape":"InvalidParameterValuesException"} ], "documentation":"

Describes the connection status of a specified WorkSpace.

" }, "ModifyWorkspaceProperties":{ "name":"ModifyWorkspaceProperties", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyWorkspacePropertiesRequest"}, "output":{"shape":"ModifyWorkspacePropertiesResult"}, "errors":[ {"shape":"InvalidParameterValuesException"}, {"shape":"InvalidResourceStateException"}, {"shape":"OperationInProgressException"}, {"shape":"UnsupportedWorkspaceConfigurationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceUnavailableException"} ], "documentation":"

Modifies the WorkSpace properties, including the running mode and AutoStop time.

" }, "RebootWorkspaces":{ "name":"RebootWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootWorkspacesRequest"}, "output":{"shape":"RebootWorkspacesResult"}, "documentation":"

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.

" }, "RebuildWorkspaces":{ "name":"RebuildWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebuildWorkspacesRequest"}, "output":{"shape":"RebuildWorkspacesResult"}, "documentation":"

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:

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.

" }, "StartWorkspaces":{ "name":"StartWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartWorkspacesRequest"}, "output":{"shape":"StartWorkspacesResult"}, "documentation":"

Starts the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of STOPPED.

" }, "StopWorkspaces":{ "name":"StopWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopWorkspacesRequest"}, "output":{"shape":"StopWorkspacesResult"}, "documentation":"

Stops the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

" }, "TerminateWorkspaces":{ "name":"TerminateWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateWorkspacesRequest"}, "output":{"shape":"TerminateWorkspacesResult"}, "documentation":"

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.

" } }, "shapes":{ "ARN":{ "type":"string", "pattern":"^arn:aws:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$" }, "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"

The user is not authorized to access a resource.

", "exception":true }, "Alias":{"type":"string"}, "BooleanObject":{"type":"boolean"}, "BundleId":{ "type":"string", "pattern":"^wsb-[0-9a-z]{8,63}$" }, "BundleIdList":{ "type":"list", "member":{"shape":"BundleId"}, "max":25, "min":1 }, "BundleList":{ "type":"list", "member":{"shape":"WorkspaceBundle"} }, "BundleOwner":{"type":"string"}, "Compute":{ "type":"string", "enum":[ "VALUE", "STANDARD", "PERFORMANCE" ] }, "ComputeType":{ "type":"structure", "members":{ "Name":{ "shape":"Compute", "documentation":"

The name of the compute type for the bundle.

" } }, "documentation":"

Contains information about the compute type of a WorkSpace bundle.

" }, "ComputerName":{"type":"string"}, "ConnectionState":{ "type":"string", "enum":[ "CONNECTED", "DISCONNECTED", "UNKNOWN" ] }, "CreateTagsRequest":{ "type":"structure", "required":[ "ResourceId", "Tags" ], "members":{ "ResourceId":{ "shape":"NonEmptyString", "documentation":"

The resource ID of the request.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags of the request.

" } }, "documentation":"

The request of the CreateTags operation.

" }, "CreateTagsResult":{ "type":"structure", "members":{ }, "documentation":"

The result of the CreateTags operation.

" }, "CreateWorkspacesRequest":{ "type":"structure", "required":["Workspaces"], "members":{ "Workspaces":{ "shape":"WorkspaceRequestList", "documentation":"

An array of structures that specify the WorkSpaces to create.

" } }, "documentation":"

Contains the inputs for the CreateWorkspaces operation.

" }, "CreateWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{ "shape":"FailedCreateWorkspaceRequests", "documentation":"

An array of structures that represent the WorkSpaces that could not be created.

" }, "PendingRequests":{ "shape":"WorkspaceList", "documentation":"

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.

" } }, "documentation":"

Contains the result of the CreateWorkspaces operation.

" }, "DefaultOu":{"type":"string"}, "DefaultWorkspaceCreationProperties":{ "type":"structure", "members":{ "EnableWorkDocs":{ "shape":"BooleanObject", "documentation":"

Specifies if the directory is enabled for Amazon WorkDocs.

" }, "EnableInternetAccess":{ "shape":"BooleanObject", "documentation":"

A public IP address will be attached to all WorkSpaces that are created or rebuilt.

" }, "DefaultOu":{ "shape":"DefaultOu", "documentation":"

The organizational unit (OU) in the directory that the WorkSpace machine accounts are placed in.

" }, "CustomSecurityGroupId":{ "shape":"SecurityGroupId", "documentation":"

The identifier of any custom security groups that are applied to the WorkSpaces when they are created.

" }, "UserEnabledAsLocalAdministrator":{ "shape":"BooleanObject", "documentation":"

The WorkSpace user is an administrator on the WorkSpace.

" } }, "documentation":"

Contains default WorkSpace creation information.

" }, "DeleteTagsRequest":{ "type":"structure", "required":[ "ResourceId", "TagKeys" ], "members":{ "ResourceId":{ "shape":"NonEmptyString", "documentation":"

The resource ID of the request.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

The tag keys of the request.

" } }, "documentation":"

The request of the DeleteTags operation.

" }, "DeleteTagsResult":{ "type":"structure", "members":{ }, "documentation":"

The result of the DeleteTags operation.

" }, "DescribeTagsRequest":{ "type":"structure", "required":["ResourceId"], "members":{ "ResourceId":{ "shape":"NonEmptyString", "documentation":"

The resource ID of the request.

" } }, "documentation":"

The request of the DescribeTags operation.

" }, "DescribeTagsResult":{ "type":"structure", "members":{ "TagList":{ "shape":"TagList", "documentation":"

The list of tags.

" } }, "documentation":"

The result of the DescribeTags operation.

" }, "DescribeWorkspaceBundlesRequest":{ "type":"structure", "members":{ "BundleIds":{ "shape":"BundleIdList", "documentation":"

An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

" }, "Owner":{ "shape":"BundleOwner", "documentation":"

The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

This contains one of the following values:

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

The NextToken value from a previous call to this operation. Pass null if this is the first call.

" } }, "documentation":"

Contains the inputs for the DescribeWorkspaceBundles operation.

" }, "DescribeWorkspaceBundlesResult":{ "type":"structure", "members":{ "Bundles":{ "shape":"BundleList", "documentation":"

An array of structures that contain information about the bundles.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

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.

" } }, "documentation":"

Contains the results of the DescribeWorkspaceBundles operation.

" }, "DescribeWorkspaceDirectoriesRequest":{ "type":"structure", "members":{ "DirectoryIds":{ "shape":"DirectoryIdList", "documentation":"

An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

The NextToken value from a previous call to this operation. Pass null if this is the first call.

" } }, "documentation":"

Contains the inputs for the DescribeWorkspaceDirectories operation.

" }, "DescribeWorkspaceDirectoriesResult":{ "type":"structure", "members":{ "Directories":{ "shape":"DirectoryList", "documentation":"

An array of structures that contain information about the directories.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

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.

" } }, "documentation":"

Contains the results of the DescribeWorkspaceDirectories operation.

" }, "DescribeWorkspacesConnectionStatusRequest":{ "type":"structure", "members":{ "WorkspaceIds":{ "shape":"WorkspaceIdList", "documentation":"

An array of strings that contain the identifiers of the WorkSpaces.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

The next token of the request.

" } } }, "DescribeWorkspacesConnectionStatusResult":{ "type":"structure", "members":{ "WorkspacesConnectionStatus":{ "shape":"WorkspaceConnectionStatusList", "documentation":"

The connection status of the WorkSpace.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

The next token of the result.

" } } }, "DescribeWorkspacesRequest":{ "type":"structure", "members":{ "WorkspaceIds":{ "shape":"WorkspaceIdList", "documentation":"

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.

" }, "DirectoryId":{ "shape":"DirectoryId", "documentation":"

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.

" }, "UserName":{ "shape":"UserName", "documentation":"

Used with the DirectoryId parameter to specify the directory user for whom to obtain the WorkSpace.

" }, "BundleId":{ "shape":"BundleId", "documentation":"

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.

" }, "Limit":{ "shape":"Limit", "documentation":"

The maximum number of items to return.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

The NextToken value from a previous call to this operation. Pass null if this is the first call.

" } }, "documentation":"

Contains the inputs for the DescribeWorkspaces operation.

" }, "DescribeWorkspacesResult":{ "type":"structure", "members":{ "Workspaces":{ "shape":"WorkspaceList", "documentation":"

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.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

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.

" } }, "documentation":"

Contains the results for the DescribeWorkspaces operation.

" }, "Description":{"type":"string"}, "DirectoryId":{ "type":"string", "pattern":"^d-[0-9a-f]{8,63}$" }, "DirectoryIdList":{ "type":"list", "member":{"shape":"DirectoryId"}, "max":25, "min":1 }, "DirectoryList":{ "type":"list", "member":{"shape":"WorkspaceDirectory"} }, "DirectoryName":{"type":"string"}, "DnsIpAddresses":{ "type":"list", "member":{"shape":"IpAddress"} }, "ErrorType":{"type":"string"}, "ExceptionMessage":{"type":"string"}, "FailedCreateWorkspaceRequest":{ "type":"structure", "members":{ "WorkspaceRequest":{ "shape":"WorkspaceRequest", "documentation":"

A FailedCreateWorkspaceRequest$WorkspaceRequest object that contains the information about the WorkSpace that could not be created.

" }, "ErrorCode":{ "shape":"ErrorType", "documentation":"

The error code.

" }, "ErrorMessage":{ "shape":"Description", "documentation":"

The textual error message.

" } }, "documentation":"

Contains information about a WorkSpace that could not be created.

" }, "FailedCreateWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedCreateWorkspaceRequest"} }, "FailedRebootWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedWorkspaceChangeRequest"} }, "FailedRebuildWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedWorkspaceChangeRequest"} }, "FailedStartWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedWorkspaceChangeRequest"} }, "FailedStopWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedWorkspaceChangeRequest"} }, "FailedTerminateWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedWorkspaceChangeRequest"} }, "FailedWorkspaceChangeRequest":{ "type":"structure", "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The identifier of the WorkSpace.

" }, "ErrorCode":{ "shape":"ErrorType", "documentation":"

The error code.

" }, "ErrorMessage":{ "shape":"Description", "documentation":"

The textual error message.

" } }, "documentation":"

Contains information about a WorkSpace that could not be rebooted (RebootWorkspaces), rebuilt (RebuildWorkspaces), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).

" }, "InvalidParameterValuesException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The exception error message.

" } }, "documentation":"

One or more parameter values are not valid.

", "exception":true }, "InvalidResourceStateException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"

The state of the WorkSpace is not valid for this operation.

", "exception":true }, "IpAddress":{"type":"string"}, "Limit":{ "type":"integer", "max":25, "min":1 }, "ModifyWorkspacePropertiesRequest":{ "type":"structure", "required":[ "WorkspaceId", "WorkspaceProperties" ], "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The ID of the WorkSpace.

" }, "WorkspaceProperties":{ "shape":"WorkspaceProperties", "documentation":"

The WorkSpace properties of the request.

" } } }, "ModifyWorkspacePropertiesResult":{ "type":"structure", "members":{ } }, "NonEmptyString":{ "type":"string", "min":1 }, "OperationInProgressException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"

The properties of this WorkSpace are currently being modified. Try again in a moment.

", "exception":true }, "PaginationToken":{ "type":"string", "max":63, "min":1 }, "RebootRequest":{ "type":"structure", "required":["WorkspaceId"], "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The identifier of the WorkSpace to reboot.

" } }, "documentation":"

Contains information used with the RebootWorkspaces operation to reboot a WorkSpace.

" }, "RebootWorkspaceRequests":{ "type":"list", "member":{"shape":"RebootRequest"}, "max":25, "min":1 }, "RebootWorkspacesRequest":{ "type":"structure", "required":["RebootWorkspaceRequests"], "members":{ "RebootWorkspaceRequests":{ "shape":"RebootWorkspaceRequests", "documentation":"

An array of structures that specify the WorkSpaces to reboot.

" } }, "documentation":"

Contains the inputs for the RebootWorkspaces operation.

" }, "RebootWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{ "shape":"FailedRebootWorkspaceRequests", "documentation":"

An array of structures representing any WorkSpaces that could not be rebooted.

" } }, "documentation":"

Contains the results of the RebootWorkspaces operation.

" }, "RebuildRequest":{ "type":"structure", "required":["WorkspaceId"], "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The identifier of the WorkSpace to rebuild.

" } }, "documentation":"

Contains information used with the RebuildWorkspaces operation to rebuild a WorkSpace.

" }, "RebuildWorkspaceRequests":{ "type":"list", "member":{"shape":"RebuildRequest"}, "max":1, "min":1 }, "RebuildWorkspacesRequest":{ "type":"structure", "required":["RebuildWorkspaceRequests"], "members":{ "RebuildWorkspaceRequests":{ "shape":"RebuildWorkspaceRequests", "documentation":"

An array of structures that specify the WorkSpaces to rebuild.

" } }, "documentation":"

Contains the inputs for the RebuildWorkspaces operation.

" }, "RebuildWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{ "shape":"FailedRebuildWorkspaceRequests", "documentation":"

An array of structures representing any WorkSpaces that could not be rebuilt.

" } }, "documentation":"

Contains the results of the RebuildWorkspaces operation.

" }, "RegistrationCode":{ "type":"string", "max":20, "min":1 }, "ResourceLimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The exception error message.

" } }, "documentation":"

Your resource limits have been exceeded.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The resource could not be found.

" }, "ResourceId":{ "shape":"NonEmptyString", "documentation":"

The resource could not be found.

" } }, "documentation":"

The resource could not be found.

", "exception":true }, "ResourceUnavailableException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The exception error message.

" }, "ResourceId":{ "shape":"NonEmptyString", "documentation":"

The identifier of the resource that is not available.

" } }, "documentation":"

The specified resource is not available.

", "exception":true }, "RunningMode":{ "type":"string", "enum":[ "AUTO_STOP", "ALWAYS_ON" ] }, "RunningModeAutoStopTimeoutInMinutes":{"type":"integer"}, "SecurityGroupId":{ "type":"string", "pattern":"^(sg-[0-9a-f]{8})$" }, "StartRequest":{ "type":"structure", "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The ID of the WorkSpace.

" } }, "documentation":"

Describes the start request.

" }, "StartWorkspaceRequests":{ "type":"list", "member":{"shape":"StartRequest"}, "max":25, "min":1 }, "StartWorkspacesRequest":{ "type":"structure", "required":["StartWorkspaceRequests"], "members":{ "StartWorkspaceRequests":{ "shape":"StartWorkspaceRequests", "documentation":"

The requests.

" } } }, "StartWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{ "shape":"FailedStartWorkspaceRequests", "documentation":"

The failed requests.

" } } }, "StopRequest":{ "type":"structure", "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The ID of the WorkSpace.

" } }, "documentation":"

Describes the stop request.

" }, "StopWorkspaceRequests":{ "type":"list", "member":{"shape":"StopRequest"}, "max":25, "min":1 }, "StopWorkspacesRequest":{ "type":"structure", "required":["StopWorkspaceRequests"], "members":{ "StopWorkspaceRequests":{ "shape":"StopWorkspaceRequests", "documentation":"

The requests.

" } } }, "StopWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{ "shape":"FailedStopWorkspaceRequests", "documentation":"

The failed requests.

" } } }, "SubnetId":{ "type":"string", "pattern":"^(subnet-[0-9a-f]{8})$" }, "SubnetIds":{ "type":"list", "member":{"shape":"SubnetId"} }, "Tag":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The key of the tag.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value of the tag.

" } }, "documentation":"

Describes the tag of the WorkSpace.

" }, "TagKey":{ "type":"string", "max":127, "min":1 }, "TagKeyList":{ "type":"list", "member":{"shape":"NonEmptyString"} }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagValue":{ "type":"string", "max":255 }, "TerminateRequest":{ "type":"structure", "required":["WorkspaceId"], "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The identifier of the WorkSpace to terminate.

" } }, "documentation":"

Contains information used with the TerminateWorkspaces operation to terminate a WorkSpace.

" }, "TerminateWorkspaceRequests":{ "type":"list", "member":{"shape":"TerminateRequest"}, "max":25, "min":1 }, "TerminateWorkspacesRequest":{ "type":"structure", "required":["TerminateWorkspaceRequests"], "members":{ "TerminateWorkspaceRequests":{ "shape":"TerminateWorkspaceRequests", "documentation":"

An array of structures that specify the WorkSpaces to terminate.

" } }, "documentation":"

Contains the inputs for the TerminateWorkspaces operation.

" }, "TerminateWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{ "shape":"FailedTerminateWorkspaceRequests", "documentation":"

An array of structures representing any WorkSpaces that could not be terminated.

" } }, "documentation":"

Contains the results of the TerminateWorkspaces operation.

" }, "Timestamp":{"type":"timestamp"}, "UnsupportedWorkspaceConfigurationException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"

The configuration of this WorkSpace is not supported for this operation. For more information, see the Amazon WorkSpaces Administration Guide.

", "exception":true }, "UserName":{ "type":"string", "max":63, "min":1 }, "UserStorage":{ "type":"structure", "members":{ "Capacity":{ "shape":"NonEmptyString", "documentation":"

The amount of user storage for the bundle.

" } }, "documentation":"

Contains information about the user storage for a WorkSpace bundle.

" }, "VolumeEncryptionKey":{"type":"string"}, "Workspace":{ "type":"structure", "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The identifier of the WorkSpace.

" }, "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the AWS Directory Service directory that the WorkSpace belongs to.

" }, "UserName":{ "shape":"UserName", "documentation":"

The user that the WorkSpace is assigned to.

" }, "IpAddress":{ "shape":"IpAddress", "documentation":"

The IP address of the WorkSpace.

" }, "State":{ "shape":"WorkspaceState", "documentation":"

The operational state of the WorkSpace.

" }, "BundleId":{ "shape":"BundleId", "documentation":"

The identifier of the bundle that the WorkSpace was created from.

" }, "SubnetId":{ "shape":"SubnetId", "documentation":"

The identifier of the subnet that the WorkSpace is in.

" }, "ErrorMessage":{ "shape":"Description", "documentation":"

If the WorkSpace could not be created, this contains a textual error message that describes the failure.

" }, "ErrorCode":{ "shape":"WorkspaceErrorCode", "documentation":"

If the WorkSpace could not be created, this contains the error code.

" }, "ComputerName":{ "shape":"ComputerName", "documentation":"

The name of the WorkSpace as seen by the operating system.

" }, "VolumeEncryptionKey":{ "shape":"VolumeEncryptionKey", "documentation":"

The KMS key used to encrypt data stored on your WorkSpace.

" }, "UserVolumeEncryptionEnabled":{ "shape":"BooleanObject", "documentation":"

Specifies whether the data stored on the user volume, or D: drive, is encrypted.

" }, "RootVolumeEncryptionEnabled":{ "shape":"BooleanObject", "documentation":"

Specifies whether the data stored on the root volume, or C: drive, is encrypted.

" }, "WorkspaceProperties":{"shape":"WorkspaceProperties"} }, "documentation":"

Contains information about a WorkSpace.

" }, "WorkspaceBundle":{ "type":"structure", "members":{ "BundleId":{ "shape":"BundleId", "documentation":"

The bundle identifier.

" }, "Name":{ "shape":"NonEmptyString", "documentation":"

The name of the bundle.

" }, "Owner":{ "shape":"BundleOwner", "documentation":"

The owner of the bundle. This contains the owner's account identifier, or AMAZON if the bundle is provided by AWS.

" }, "Description":{ "shape":"Description", "documentation":"

The bundle description.

" }, "UserStorage":{ "shape":"UserStorage", "documentation":"

A UserStorage object that specifies the amount of user storage that the bundle contains.

" }, "ComputeType":{ "shape":"ComputeType", "documentation":"

A ComputeType object that specifies the compute type for the bundle.

" } }, "documentation":"

Contains information about a WorkSpace bundle.

" }, "WorkspaceConnectionStatus":{ "type":"structure", "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The ID of the WorkSpace.

" }, "ConnectionState":{ "shape":"ConnectionState", "documentation":"

The connection state of the WorkSpace. Returns UNKOWN if the WorkSpace is in a Stopped state.

" }, "ConnectionStateCheckTimestamp":{ "shape":"Timestamp", "documentation":"

The timestamp of the connection state check.

" }, "LastKnownUserConnectionTimestamp":{ "shape":"Timestamp", "documentation":"

The timestamp of the last known user connection.

" } }, "documentation":"

Describes the connection status of a WorkSpace.

" }, "WorkspaceConnectionStatusList":{ "type":"list", "member":{"shape":"WorkspaceConnectionStatus"} }, "WorkspaceDirectory":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The directory identifier.

" }, "Alias":{ "shape":"Alias", "documentation":"

The directory alias.

" }, "DirectoryName":{ "shape":"DirectoryName", "documentation":"

The name of the directory.

" }, "RegistrationCode":{ "shape":"RegistrationCode", "documentation":"

The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

" }, "SubnetIds":{ "shape":"SubnetIds", "documentation":"

An array of strings that contains the identifiers of the subnets used with the directory.

" }, "DnsIpAddresses":{ "shape":"DnsIpAddresses", "documentation":"

An array of strings that contains the IP addresses of the DNS servers for the directory.

" }, "CustomerUserName":{ "shape":"UserName", "documentation":"

The user name for the service account.

" }, "IamRoleId":{ "shape":"ARN", "documentation":"

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.

" }, "DirectoryType":{ "shape":"WorkspaceDirectoryType", "documentation":"

The directory type.

" }, "WorkspaceSecurityGroupId":{ "shape":"SecurityGroupId", "documentation":"

The identifier of the security group that is assigned to new WorkSpaces.

" }, "State":{ "shape":"WorkspaceDirectoryState", "documentation":"

The state of the directory's registration with Amazon WorkSpaces

" }, "WorkspaceCreationProperties":{ "shape":"DefaultWorkspaceCreationProperties", "documentation":"

A structure that specifies the default creation properties for all WorkSpaces in the directory.

" } }, "documentation":"

Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.

" }, "WorkspaceDirectoryState":{ "type":"string", "enum":[ "REGISTERING", "REGISTERED", "DEREGISTERING", "DEREGISTERED", "ERROR" ] }, "WorkspaceDirectoryType":{ "type":"string", "enum":[ "SIMPLE_AD", "AD_CONNECTOR" ] }, "WorkspaceErrorCode":{"type":"string"}, "WorkspaceId":{ "type":"string", "pattern":"^ws-[0-9a-z]{8,63}$" }, "WorkspaceIdList":{ "type":"list", "member":{"shape":"WorkspaceId"}, "max":25, "min":1 }, "WorkspaceList":{ "type":"list", "member":{"shape":"Workspace"} }, "WorkspaceProperties":{ "type":"structure", "members":{ "RunningMode":{ "shape":"RunningMode", "documentation":"

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.

" }, "RunningModeAutoStopTimeoutInMinutes":{ "shape":"RunningModeAutoStopTimeoutInMinutes", "documentation":"

The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.

" } }, "documentation":"

Describes the properties of a WorkSpace.

" }, "WorkspaceRequest":{ "type":"structure", "required":[ "DirectoryId", "UserName", "BundleId" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

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.

" }, "UserName":{ "shape":"UserName", "documentation":"

The username that the WorkSpace is assigned to. This username must exist in the AWS Directory Service directory specified by the DirectoryId member.

" }, "BundleId":{ "shape":"BundleId", "documentation":"

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.

" }, "VolumeEncryptionKey":{ "shape":"VolumeEncryptionKey", "documentation":"

The KMS key used to encrypt data stored on your WorkSpace.

" }, "UserVolumeEncryptionEnabled":{ "shape":"BooleanObject", "documentation":"

Specifies whether the data stored on the user volume, or D: drive, is encrypted.

" }, "RootVolumeEncryptionEnabled":{ "shape":"BooleanObject", "documentation":"

Specifies whether the data stored on the root volume, or C: drive, is encrypted.

" }, "WorkspaceProperties":{"shape":"WorkspaceProperties"}, "Tags":{ "shape":"TagList", "documentation":"

The tags of the WorkSpace request.

" } }, "documentation":"

Contains information about a WorkSpace creation request.

" }, "WorkspaceRequestList":{ "type":"list", "member":{"shape":"WorkspaceRequest"}, "max":25, "min":1 }, "WorkspaceState":{ "type":"string", "enum":[ "PENDING", "AVAILABLE", "IMPAIRED", "UNHEALTHY", "REBOOTING", "STARTING", "REBUILDING", "MAINTENANCE", "TERMINATING", "TERMINATED", "SUSPENDED", "STOPPING", "STOPPED", "ERROR" ] } }, "documentation":"Amazon WorkSpaces Service

This reference provides detailed information about the Amazon WorkSpaces operations.

" }