# Serialized Form

## Package com.amazonaws.services.workspaces.model

### Class com.amazonaws.services.workspaces.model.AccessDeniedException extends AmazonWorkspacesException implements Serializable

serialVersionUID:
  1L

### Class com.amazonaws.services.workspaces.model.AmazonWorkspacesException extends AmazonServiceException implements Serializable

serialVersionUID:
  1L

### Class com.amazonaws.services.workspaces.model.ComputeType extends Object implements Serializable

### Serialized Fields

#### name

    String name

The name of the compute type for the bundle.

### Class com.amazonaws.services.workspaces.model.CreateTagsRequest extends AmazonWebServiceRequest implements Serializable

### Serialized Fields

#### resourceId

    String resourceId

The resource ID of the request.

#### tags

    com.amazonaws.internal.SdkInternalList<T> tags

The tags of the request.

### Class com.amazonaws.services.workspaces.model.CreateTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

### Class com.amazonaws.services.workspaces.model.CreateWorkspacesRequest extends AmazonWebServiceRequest implements Serializable

### Serialized Fields

#### workspaces

    com.amazonaws.internal.SdkInternalList<T> workspaces

An array of structures that specify the WorkSpaces to create.

### Class com.amazonaws.services.workspaces.model.CreateWorkspacesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

### Serialized Fields

#### failedRequests

    com.amazonaws.internal.SdkInternalList<T> failedRequests

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

#### pendingRequests

    com.amazonaws.internal.SdkInternalList<T> pendingRequests

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.

### Class com.amazonaws.services.workspaces.model.DefaultWorkspaceCreationProperties extends Object implements Serializable

### Serialized Fields

#### enableWorkDocs

    Boolean enableWorkDocs

Specifies if the directory is enabled for Amazon WorkDocs.

#### enableInternetAccess

    Boolean enableInternetAccess

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

#### defaultOu

    String defaultOu

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

#### customSecurityGroupId

    String customSecurityGroupId

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

#### userEnabledAsLocalAdministrator

    Boolean userEnabledAsLocalAdministrator

The WorkSpace user is an administrator on the WorkSpace.

### Class com.amazonaws.services.workspaces.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable

### Serialized Fields

#### resourceId

    String resourceId

The resource ID of the request.

#### tagKeys

    com.amazonaws.internal.SdkInternalList<T> tagKeys

The tag keys of the request.

### Class com.amazonaws.services.workspaces.model.DeleteTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

### Class com.amazonaws.services.workspaces.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable

### Serialized Fields

#### resourceId

    String resourceId

The resource ID of the request.

### Class com.amazonaws.services.workspaces.model.DescribeTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

### Serialized Fields

#### tagList

    com.amazonaws.internal.SdkInternalList<T> tagList

The list of tags.

### Class com.amazonaws.services.workspaces.model.DescribeWorkspaceBundlesRequest extends AmazonWebServiceRequest implements Serializable

### Serialized Fields

#### bundleIds

    com.amazonaws.internal.SdkInternalList<T> bundleIds

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

#### owner

    String owner

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.

#### nextToken

    String nextToken

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

### Class com.amazonaws.services.workspaces.model.DescribeWorkspaceBundlesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

### Serialized Fields

#### bundles

    com.amazonaws.internal.SdkInternalList<T> bundles

An array of structures that contain information about the bundles.

#### nextToken

    String nextToken

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.

### Class com.amazonaws.services.workspaces.model.DescribeWorkspaceDirectoriesRequest extends AmazonWebServiceRequest implements Serializable

### Serialized Fields

#### directoryIds

    com.amazonaws.internal.SdkInternalList<T> directoryIds

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

#### nextToken

    String nextToken

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

### Class com.amazonaws.services.workspaces.model.DescribeWorkspaceDirectoriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

### Serialized Fields

#### directories

    com.amazonaws.internal.SdkInternalList<T> directories

An array of structures that contain information about the directories.

#### nextToken

    String nextToken

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.

### Class com.amazonaws.services.workspaces.model.DescribeWorkspacesConnectionStatusRequest extends AmazonWebServiceRequest implements Serializable

### Serialized Fields

#### workspaceIds

    com.amazonaws.internal.SdkInternalList<T> workspaceIds

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

#### nextToken

    String nextToken

The next token of the request.

### Class com.amazonaws.services.workspaces.model.DescribeWorkspacesConnectionStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

### Serialized Fields

#### workspacesConnectionStatus

    com.amazonaws.internal.SdkInternalList<T> workspacesConnectionStatus

The connection status of the WorkSpace.

#### nextToken

    String nextToken

The next token of the result.

### Class com.amazonaws.services.workspaces.model.DescribeWorkspacesRequest extends AmazonWebServiceRequest implements Serializable

### Serialized Fields

#### workspaceIds

    com.amazonaws.internal.SdkInternalList<T> workspaceIds

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

    String directoryId

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

    String userName

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

#### bundleId

    String bundleId

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

    Integer limit

The maximum number of items to return.

#### nextToken

    String nextToken

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

### Class com.amazonaws.services.workspaces.model.DescribeWorkspacesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

### Serialized Fields

#### workspaces

    com.amazonaws.internal.SdkInternalList<T> workspaces

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

    String nextToken

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.

### Class com.amazonaws.services.workspaces.model.FailedCreateWorkspaceRequest extends Object implements Serializable

### Serialized Fields

#### workspaceRequest

    WorkspaceRequest workspaceRequest

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

#### errorCode

    String errorCode

The error code.

#### errorMessage

    String errorMessage

The textual error message.

### Class com.amazonaws.services.workspaces.model.FailedWorkspaceChangeRequest extends Object implements Serializable

### Serialized Fields

#### workspaceId

    String workspaceId

The identifier of the WorkSpace.

#### errorCode

    String errorCode

The error code.

#### errorMessage

    String errorMessage

The textual error message.

### Class com.amazonaws.services.workspaces.model.InvalidParameterValuesException extends AmazonWorkspacesException implements Serializable

serialVersionUID:
  1L

### Class com.amazonaws.services.workspaces.model.InvalidResourceStateException extends AmazonWorkspacesException implements Serializable

serialVersionUID:
  1L

### Class com.amazonaws.services.workspaces.model.ModifyWorkspacePropertiesRequest extends AmazonWebServiceRequest implements Serializable

### Serialized Fields

#### workspaceId

    String workspaceId

The ID of the WorkSpace.

#### workspaceProperties

    WorkspaceProperties workspaceProperties

The WorkSpace properties of the request.

### Class com.amazonaws.services.workspaces.model.ModifyWorkspacePropertiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

### Class com.amazonaws.services.workspaces.model.OperationInProgressException extends AmazonWorkspacesException implements Serializable

serialVersionUID:
  1L

### Class com.amazonaws.services.workspaces.model.RebootRequest extends Object implements Serializable

### Serialized Fields

#### workspaceId

    String workspaceId

The identifier of the WorkSpace to reboot.

### Class com.amazonaws.services.workspaces.model.RebootWorkspacesRequest extends AmazonWebServiceRequest implements Serializable

### Serialized Fields

#### rebootWorkspaceRequests

    com.amazonaws.internal.SdkInternalList<T> rebootWorkspaceRequests

An array of structures that specify the WorkSpaces to reboot.

### Class com.amazonaws.services.workspaces.model.RebootWorkspacesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

### Serialized Fields

#### failedRequests

    com.amazonaws.internal.SdkInternalList<T> failedRequests

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

### Class com.amazonaws.services.workspaces.model.RebuildRequest extends Object implements Serializable

### Serialized Fields

#### workspaceId

    String workspaceId

The identifier of the WorkSpace to rebuild.

### Class com.amazonaws.services.workspaces.model.RebuildWorkspacesRequest extends AmazonWebServiceRequest implements Serializable

### Serialized Fields

#### rebuildWorkspaceRequests

    com.amazonaws.internal.SdkInternalList<T> rebuildWorkspaceRequests

An array of structures that specify the WorkSpaces to rebuild.

### Class com.amazonaws.services.workspaces.model.RebuildWorkspacesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

### Serialized Fields

#### failedRequests

    com.amazonaws.internal.SdkInternalList<T> failedRequests

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

### Class com.amazonaws.services.workspaces.model.ResourceLimitExceededException extends AmazonWorkspacesException implements Serializable

serialVersionUID:
  1L

### Class com.amazonaws.services.workspaces.model.ResourceNotFoundException extends AmazonWorkspacesException implements Serializable

serialVersionUID:
  1L

### Serialized Fields

#### resourceId

    String resourceId

The resource could not be found.

### Class com.amazonaws.services.workspaces.model.ResourceUnavailableException extends AmazonWorkspacesException implements Serializable

serialVersionUID:
  1L

### Serialized Fields

#### resourceId

    String resourceId

The identifier of the resource that is not available.

### Class com.amazonaws.services.workspaces.model.StartRequest extends Object implements Serializable

### Serialized Fields

#### workspaceId

    String workspaceId

The ID of the WorkSpace.

### Class com.amazonaws.services.workspaces.model.StartWorkspacesRequest extends AmazonWebServiceRequest implements Serializable

### Serialized Fields

#### startWorkspaceRequests

    com.amazonaws.internal.SdkInternalList<T> startWorkspaceRequests

The requests.

### Class com.amazonaws.services.workspaces.model.StartWorkspacesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

### Serialized Fields

#### failedRequests

    com.amazonaws.internal.SdkInternalList<T> failedRequests

The failed requests.

### Class com.amazonaws.services.workspaces.model.StopRequest extends Object implements Serializable

### Serialized Fields

#### workspaceId

    String workspaceId

The ID of the WorkSpace.

### Class com.amazonaws.services.workspaces.model.StopWorkspacesRequest extends AmazonWebServiceRequest implements Serializable

### Serialized Fields

#### stopWorkspaceRequests

    com.amazonaws.internal.SdkInternalList<T> stopWorkspaceRequests

The requests.

### Class com.amazonaws.services.workspaces.model.StopWorkspacesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

### Serialized Fields

#### failedRequests

    com.amazonaws.internal.SdkInternalList<T> failedRequests

The failed requests.

### Class com.amazonaws.services.workspaces.model.Tag extends Object implements Serializable

### Serialized Fields

#### key

    String key

The key of the tag.

#### value

    String value

The value of the tag.

### Class com.amazonaws.services.workspaces.model.TerminateRequest extends Object implements Serializable

### Serialized Fields

#### workspaceId

    String workspaceId

The identifier of the WorkSpace to terminate.

### Class com.amazonaws.services.workspaces.model.TerminateWorkspacesRequest extends AmazonWebServiceRequest implements Serializable

### Serialized Fields

#### terminateWorkspaceRequests

    com.amazonaws.internal.SdkInternalList<T> terminateWorkspaceRequests

An array of structures that specify the WorkSpaces to terminate.

### Class com.amazonaws.services.workspaces.model.TerminateWorkspacesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

### Serialized Fields

#### failedRequests

    com.amazonaws.internal.SdkInternalList<T> failedRequests

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

### Class com.amazonaws.services.workspaces.model.UnsupportedWorkspaceConfigurationException extends AmazonWorkspacesException implements Serializable

serialVersionUID:
  1L

### Class com.amazonaws.services.workspaces.model.UserStorage extends Object implements Serializable

### Serialized Fields

#### capacity

    String capacity

The amount of user storage for the bundle.

### Class com.amazonaws.services.workspaces.model.Workspace extends Object implements Serializable

### Serialized Fields

#### workspaceId

    String workspaceId

The identifier of the WorkSpace.

#### directoryId

    String directoryId

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

#### userName

    String userName

The user that the WorkSpace is assigned to.

#### ipAddress

    String ipAddress

The IP address of the WorkSpace.

#### state

    String state

The operational state of the WorkSpace.

#### bundleId

    String bundleId

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

#### subnetId

    String subnetId

The identifier of the subnet that the WorkSpace is in.

#### errorMessage

    String errorMessage

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

#### errorCode

    String errorCode

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

#### computerName

    String computerName

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

#### volumeEncryptionKey

    String volumeEncryptionKey

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

#### userVolumeEncryptionEnabled

    Boolean userVolumeEncryptionEnabled

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

#### rootVolumeEncryptionEnabled

    Boolean rootVolumeEncryptionEnabled

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

#### workspaceProperties

    WorkspaceProperties workspaceProperties

### Class com.amazonaws.services.workspaces.model.WorkspaceBundle extends Object implements Serializable

### Serialized Fields

#### bundleId

    String bundleId

The bundle identifier.

#### name

    String name

The name of the bundle.

#### owner

    String owner

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

#### description

    String description

The bundle description.

#### userStorage

    UserStorage userStorage

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

#### computeType

    ComputeType computeType

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

### Class com.amazonaws.services.workspaces.model.WorkspaceConnectionStatus extends Object implements Serializable

### Serialized Fields

#### workspaceId

    String workspaceId

The ID of the WorkSpace.

#### connectionState

    String connectionState

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

#### connectionStateCheckTimestamp

    Date connectionStateCheckTimestamp

The timestamp of the connection state check.

#### lastKnownUserConnectionTimestamp

    Date lastKnownUserConnectionTimestamp

The timestamp of the last known user connection.

### Class com.amazonaws.services.workspaces.model.WorkspaceDirectory extends Object implements Serializable

### Serialized Fields

#### directoryId

    String directoryId

The directory identifier.

#### alias

    String alias

The directory alias.

#### directoryName

    String directoryName

The name of the directory.

#### registrationCode

    String registrationCode

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

    com.amazonaws.internal.SdkInternalList<T> subnetIds

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

#### dnsIpAddresses

    com.amazonaws.internal.SdkInternalList<T> dnsIpAddresses

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

#### customerUserName

    String customerUserName

The user name for the service account.

#### iamRoleId

    String iamRoleId

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

    String directoryType

The directory type.

#### workspaceSecurityGroupId

    String workspaceSecurityGroupId

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

#### state

    String state

The state of the directory's registration with Amazon WorkSpaces

#### workspaceCreationProperties

    DefaultWorkspaceCreationProperties workspaceCreationProperties

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

### Class com.amazonaws.services.workspaces.model.WorkspaceProperties extends Object implements Serializable

### Serialized Fields

#### runningMode

    String runningMode

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

    Integer runningModeAutoStopTimeoutInMinutes

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

### Class com.amazonaws.services.workspaces.model.WorkspaceRequest extends Object implements Serializable

### Serialized Fields

#### directoryId

    String directoryId

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

    String userName

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

#### bundleId

    String bundleId

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

    String volumeEncryptionKey

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

#### userVolumeEncryptionEnabled

    Boolean userVolumeEncryptionEnabled

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

#### rootVolumeEncryptionEnabled

    Boolean rootVolumeEncryptionEnabled

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

#### workspaceProperties

    WorkspaceProperties workspaceProperties

#### tags

    com.amazonaws.internal.SdkInternalList<T> tags

The tags of the WorkSpace request.