Serialized Form (AWS Java SDK for Amazon WorkSpaces 1.9.31 API)

Package com.amazonaws.services.workspaces.model
- 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.
      Constraints:
      Allowed Values: VALUE, STANDARD, PERFORMANCE
- Class com.amazonaws.services.workspaces.model.CreateWorkspacesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - workspaces
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> workspaces
```
      An array of structures that specify the WorkSpaces to create.
      Constraints:
      Length: 1 - 25
- Class com.amazonaws.services.workspaces.model.CreateWorkspacesResult extends Object implements Serializable
  - Serialized Fields
    - failedRequests
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> failedRequests
```
      An array of structures that represent the WorkSpaces that could not be created.
    - pendingRequests
```
com.amazonaws.internal.ListWithAutoConstructFlag<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.
      Constraints:
      Pattern: ^(sg-[0-9a-f]{8})$
    - userEnabledAsLocalAdministrator
```
Boolean userEnabledAsLocalAdministrator
```
      The WorkSpace user is an administrator on the WorkSpace.
- Class com.amazonaws.services.workspaces.model.DescribeWorkspaceBundlesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - bundleIds
```
com.amazonaws.internal.ListWithAutoConstructFlag<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.
      Constraints:
      Length: 1 - 25
    - 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.
      Constraints:
      Length: 1 - 63
- Class com.amazonaws.services.workspaces.model.DescribeWorkspaceBundlesResult extends Object implements Serializable
  - Serialized Fields
    - bundles
```
com.amazonaws.internal.ListWithAutoConstructFlag<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 timeframe.
      Constraints:
      Length: 1 - 63
- Class com.amazonaws.services.workspaces.model.DescribeWorkspaceDirectoriesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryIds
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> directoryIds
```
      An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.
      Constraints:
      Length: 1 - 25
    - nextToken
```
String nextToken
```
      The NextToken value from a previous call to this operation. Pass null if this is the first call.
      Constraints:
      Length: 1 - 63
- Class com.amazonaws.services.workspaces.model.DescribeWorkspaceDirectoriesResult extends Object implements Serializable
  - Serialized Fields
    - directories
```
com.amazonaws.internal.ListWithAutoConstructFlag<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 timeframe.
      Constraints:
      Length: 1 - 63
- Class com.amazonaws.services.workspaces.model.DescribeWorkspacesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - workspaceIds
```
com.amazonaws.internal.ListWithAutoConstructFlag<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 returned by CreateWorkspaces is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.
      Constraints:
      Length: 1 - 25
    - 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.
      Constraints:
      Pattern: ^d-[0-9a-f]{8,63}$
    - userName
```
String userName
```
      Used with the DirectoryId parameter to specify the directory user for which to obtain the WorkSpace.
      Constraints:
      Length: 1 - 63
    - 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.
      Constraints:
      Pattern: ^wsb-[0-9a-z]{8,63}$
    - limit
```
Integer limit
```
      The maximum number of items to return.
      Constraints:
      Range: 1 - 25
    - nextToken
```
String nextToken
```
      The NextToken value from a previous call to this operation. Pass null if this is the first call.
      Constraints:
      Length: 1 - 63
- Class com.amazonaws.services.workspaces.model.DescribeWorkspacesResult extends Object implements Serializable
  - Serialized Fields
    - workspaces
```
com.amazonaws.internal.ListWithAutoConstructFlag<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 timeframe.
      Constraints:
      Length: 1 - 63
- Class com.amazonaws.services.workspaces.model.FailedCreateWorkspaceRequest extends Object implements Serializable
  - Serialized Fields
    - workspaceRequest
```
WorkspaceRequest workspaceRequest
```
      A 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.
      Constraints:
      Pattern: ^ws-[0-9a-z]{8,63}$
    - errorCode
```
String errorCode
```
      The error code.
    - errorMessage
```
String errorMessage
```
      The textual error message.
- Class com.amazonaws.services.workspaces.model.InvalidParameterValuesException extends AmazonServiceException 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.
      Constraints:
      Pattern: ^ws-[0-9a-z]{8,63}$
- Class com.amazonaws.services.workspaces.model.RebootWorkspacesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - rebootWorkspaceRequests
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> rebootWorkspaceRequests
```
      An array of structures that specify the WorkSpaces to reboot.
      Constraints:
      Length: 1 - 25
- Class com.amazonaws.services.workspaces.model.RebootWorkspacesResult extends Object implements Serializable
  - Serialized Fields
    - failedRequests
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> failedRequests
```
      An array of structures that represent 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.
      Constraints:
      Pattern: ^ws-[0-9a-z]{8,63}$
- Class com.amazonaws.services.workspaces.model.RebuildWorkspacesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - rebuildWorkspaceRequests
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> rebuildWorkspaceRequests
```
      An array of structures that specify the WorkSpaces to rebuild.
      Constraints:
      Length: 1 - 1
- Class com.amazonaws.services.workspaces.model.RebuildWorkspacesResult extends Object implements Serializable
  - Serialized Fields
    - failedRequests
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> failedRequests
```
      An array of structures that represent any WorkSpaces that could not be rebuilt.
- Class com.amazonaws.services.workspaces.model.ResourceLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.workspaces.model.ResourceUnavailableException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
- Class com.amazonaws.services.workspaces.model.TerminateRequest extends Object implements Serializable
  - Serialized Fields
    - workspaceId
```
String workspaceId
```
      The identifier of the WorkSpace to terminate.
      Constraints:
      Pattern: ^ws-[0-9a-z]{8,63}$
- Class com.amazonaws.services.workspaces.model.TerminateWorkspacesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - terminateWorkspaceRequests
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminateWorkspaceRequests
```
      An array of structures that specify the WorkSpaces to terminate.
      Constraints:
      Length: 1 - 25
- Class com.amazonaws.services.workspaces.model.TerminateWorkspacesResult extends Object implements Serializable
  - Serialized Fields
    - failedRequests
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> failedRequests
```
      An array of structures that represent any WorkSpaces that could not be terminated.
- Class com.amazonaws.services.workspaces.model.UserStorage extends Object implements Serializable
  - Serialized Fields
    - capacity
```
String capacity
```
      The amount of user storage for the bundle.
      Constraints:
      Length: 1 -
- Class com.amazonaws.services.workspaces.model.Workspace extends Object implements Serializable
  - Serialized Fields
    - workspaceId
```
String workspaceId
```
      The identifier of the WorkSpace.
      Constraints:
      Pattern: ^ws-[0-9a-z]{8,63}$
    - directoryId
```
String directoryId
```
      The identifier of the AWS Directory Service directory that the WorkSpace belongs to.
      Constraints:
      Pattern: ^d-[0-9a-f]{8,63}$
    - userName
```
String userName
```
      The user that the WorkSpace is assigned to.
      Constraints:
      Length: 1 - 63
    - ipAddress
```
String ipAddress
```
      The IP address of the WorkSpace.
    - state
```
String state
```
      The operational state of the WorkSpace.
      Constraints:
      Allowed Values: PENDING, AVAILABLE, IMPAIRED, UNHEALTHY, REBOOTING, REBUILDING, TERMINATING, TERMINATED, SUSPENDED, ERROR
    - bundleId
```
String bundleId
```
      The identifier of the bundle that the WorkSpace was created from.
      Constraints:
      Pattern: ^wsb-[0-9a-z]{8,63}$
    - subnetId
```
String subnetId
```
      The identifier of the subnet that the WorkSpace is in.
      Constraints:
      Pattern: ^(subnet-[0-9a-f]{8})$
    - 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.
- Class com.amazonaws.services.workspaces.model.WorkspaceBundle extends Object implements Serializable
  - Serialized Fields
    - bundleId
```
String bundleId
```
      The bundle identifier.
      Constraints:
      Pattern: ^wsb-[0-9a-z]{8,63}$
    - name
```
String name
```
      The name of the bundle.
      Constraints:
      Length: 1 -
    - 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.WorkspaceDirectory extends Object implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The directory identifier.
      Constraints:
      Pattern: ^d-[0-9a-f]{8,63}$
    - 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.
      Constraints:
      Length: 1 - 20
    - subnetIds
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
```
      An array of strings that contains the identifiers of the subnets used with the directory.
    - dnsIpAddresses
```
com.amazonaws.internal.ListWithAutoConstructFlag<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.
      Constraints:
      Length: 1 - 63
    - 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.
      Constraints:
      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}$
    - directoryType
```
String directoryType
```
      The directory type.
      Constraints:
      Allowed Values: SIMPLE_AD, AD_CONNECTOR
    - workspaceSecurityGroupId
```
String workspaceSecurityGroupId
```
      The identifier of the security group that is assigned to new WorkSpaces.
      Constraints:
      Pattern: ^(sg-[0-9a-f]{8})$
    - state
```
String state
```
      The state of the directory's registration with Amazon WorkSpaces
      Constraints:
      Allowed Values: REGISTERING, REGISTERED, DEREGISTERING, DEREGISTERED, ERROR
    - workspaceCreationProperties
```
DefaultWorkspaceCreationProperties workspaceCreationProperties
```
      A structure that specifies the default creation properties for all WorkSpaces in the directory.
- 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.
      Constraints:
      Pattern: ^d-[0-9a-f]{8,63}$
    - 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.
      Constraints:
      Length: 1 - 63
    - 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.
      Constraints:
      Pattern: ^wsb-[0-9a-z]{8,63}$

Serialized Form

Package com.amazonaws.services.workspaces.model

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

Serialized Fields

name

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

Serialized Fields

workspaces

Class com.amazonaws.services.workspaces.model.CreateWorkspacesResult extends Object implements Serializable

Serialized Fields

failedRequests

pendingRequests

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

Serialized Fields

enableWorkDocs

enableInternetAccess

defaultOu

customSecurityGroupId

userEnabledAsLocalAdministrator

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

Serialized Fields

bundleIds

owner

nextToken

Class com.amazonaws.services.workspaces.model.DescribeWorkspaceBundlesResult extends Object implements Serializable

Serialized Fields

bundles

nextToken

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

Serialized Fields

directoryIds

nextToken

Class com.amazonaws.services.workspaces.model.DescribeWorkspaceDirectoriesResult extends Object implements Serializable

Serialized Fields

directories

nextToken

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

Serialized Fields

workspaceIds

directoryId

userName

bundleId

limit

nextToken

Class com.amazonaws.services.workspaces.model.DescribeWorkspacesResult extends Object implements Serializable

Serialized Fields

workspaces

nextToken

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

Serialized Fields

workspaceRequest

errorCode

errorMessage

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

Serialized Fields

workspaceId

errorCode

errorMessage

Class com.amazonaws.services.workspaces.model.InvalidParameterValuesException extends AmazonServiceException implements Serializable

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

Serialized Fields

workspaceId

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

Serialized Fields

rebootWorkspaceRequests

Class com.amazonaws.services.workspaces.model.RebootWorkspacesResult extends Object implements Serializable

Serialized Fields

failedRequests

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

Serialized Fields

workspaceId

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

Serialized Fields

rebuildWorkspaceRequests

Class com.amazonaws.services.workspaces.model.RebuildWorkspacesResult extends Object implements Serializable

Serialized Fields

failedRequests

Class com.amazonaws.services.workspaces.model.ResourceLimitExceededException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.workspaces.model.ResourceUnavailableException extends AmazonServiceException implements Serializable

Serialized Fields