Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkSpaces.Types.Workspace

Description

Synopsis

data Workspace = Workspace' {
- bundleId :: Maybe Text
- computerName :: Maybe Text
- directoryId :: Maybe Text
- errorCode :: Maybe Text
- errorMessage :: Maybe Text
- ipAddress :: Maybe Text
- modificationStates :: Maybe [ModificationState]
- relatedWorkspaces :: Maybe [RelatedWorkspaceProperties]
- rootVolumeEncryptionEnabled :: Maybe Bool
- state :: Maybe WorkspaceState
- subnetId :: Maybe Text
- userName :: Maybe Text
- userVolumeEncryptionEnabled :: Maybe Bool
- volumeEncryptionKey :: Maybe Text
- workspaceId :: Maybe Text
- workspaceProperties :: Maybe WorkspaceProperties
}
newWorkspace :: Workspace
workspace_bundleId :: Lens' Workspace (Maybe Text)
workspace_computerName :: Lens' Workspace (Maybe Text)
workspace_directoryId :: Lens' Workspace (Maybe Text)
workspace_errorCode :: Lens' Workspace (Maybe Text)
workspace_errorMessage :: Lens' Workspace (Maybe Text)
workspace_ipAddress :: Lens' Workspace (Maybe Text)
workspace_modificationStates :: Lens' Workspace (Maybe [ModificationState])
workspace_relatedWorkspaces :: Lens' Workspace (Maybe [RelatedWorkspaceProperties])
workspace_rootVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool)
workspace_state :: Lens' Workspace (Maybe WorkspaceState)
workspace_subnetId :: Lens' Workspace (Maybe Text)
workspace_userName :: Lens' Workspace (Maybe Text)
workspace_userVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool)
workspace_volumeEncryptionKey :: Lens' Workspace (Maybe Text)
workspace_workspaceId :: Lens' Workspace (Maybe Text)
workspace_workspaceProperties :: Lens' Workspace (Maybe WorkspaceProperties)

Documentation

data Workspace Source #

Describes a WorkSpace.

See: newWorkspace smart constructor.

Constructors

Workspace'

Fields

bundleId :: Maybe Text
The identifier of the bundle used to create the WorkSpace.
computerName :: Maybe Text
The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
directoryId :: Maybe Text
The identifier of the Directory Service directory for the WorkSpace.
errorCode :: Maybe Text
The error code that is returned if the WorkSpace cannot be created.
errorMessage :: Maybe Text
The text of the error message that is returned if the WorkSpace cannot be created.
ipAddress :: Maybe Text
The IP address of the WorkSpace.
modificationStates :: Maybe [ModificationState]
The modification states of the WorkSpace.
relatedWorkspaces :: Maybe [RelatedWorkspaceProperties]
The Standby WorkSpace or Primary WorkSpace related to the specified WorkSpace.
rootVolumeEncryptionEnabled :: Maybe Bool
Indicates whether the data stored on the root volume is encrypted.
state :: Maybe WorkspaceState
The operational state of the WorkSpace.
After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
subnetId :: Maybe Text
The identifier of the subnet for the WorkSpace.
userName :: Maybe Text
The user for the WorkSpace.
userVolumeEncryptionEnabled :: Maybe Bool
Indicates whether the data stored on the user volume is encrypted.
volumeEncryptionKey :: Maybe Text
The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
workspaceId :: Maybe Text
The identifier of the WorkSpace.
workspaceProperties :: Maybe WorkspaceProperties
The properties of the WorkSpace.

Instances

Instances details

FromJSON Workspace Source #
Instance details Defined in Amazonka.WorkSpaces.Types.Workspace Methods parseJSON :: Value -> Parser Workspace # parseJSONList :: Value -> Parser [Workspace] #
Generic Workspace Source #
Instance details Defined in Amazonka.WorkSpaces.Types.Workspace Associated Types type Rep Workspace :: Type -> Type # Methods from :: Workspace -> Rep Workspace x # to :: Rep Workspace x -> Workspace #
Read Workspace Source #
Instance details Defined in Amazonka.WorkSpaces.Types.Workspace Methods readsPrec :: Int -> ReadS Workspace # readList :: ReadS [Workspace] # readPrec :: ReadPrec Workspace # readListPrec :: ReadPrec [Workspace] #
Show Workspace Source #
Instance details Defined in Amazonka.WorkSpaces.Types.Workspace Methods showsPrec :: Int -> Workspace -> ShowS # show :: Workspace -> String # showList :: [Workspace] -> ShowS #
NFData Workspace Source #
Instance details Defined in Amazonka.WorkSpaces.Types.Workspace Methods rnf :: Workspace -> () #
Eq Workspace Source #
Instance details Defined in Amazonka.WorkSpaces.Types.Workspace Methods (==) :: Workspace -> Workspace -> Bool # (/=) :: Workspace -> Workspace -> Bool #
Hashable Workspace Source #
Instance details Defined in Amazonka.WorkSpaces.Types.Workspace Methods hashWithSalt :: Int -> Workspace -> Int # hash :: Workspace -> Int #
type Rep Workspace Source #
Instance details Defined in Amazonka.WorkSpaces.Types.Workspace type Rep Workspace = D1 ('MetaData "Workspace" "Amazonka.WorkSpaces.Types.Workspace" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "Workspace'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "bundleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "computerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ipAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "modificationStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ModificationState])) :: S1 ('MetaSel ('Just "relatedWorkspaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RelatedWorkspaceProperties]))))) :: (((S1 ('MetaSel ('Just "rootVolumeEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkspaceState))) :: (S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "userVolumeEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "volumeEncryptionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "workspaceProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkspaceProperties)))))))

newWorkspace :: Workspace Source #

Create a value of Workspace with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bundleId:Workspace', workspace_bundleId - The identifier of the bundle used to create the WorkSpace.

$sel:computerName:Workspace', workspace_computerName - The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.

$sel:directoryId:Workspace', workspace_directoryId - The identifier of the Directory Service directory for the WorkSpace.

$sel:errorCode:Workspace', workspace_errorCode - The error code that is returned if the WorkSpace cannot be created.

$sel:errorMessage:Workspace', workspace_errorMessage - The text of the error message that is returned if the WorkSpace cannot be created.

$sel:ipAddress:Workspace', workspace_ipAddress - The IP address of the WorkSpace.

$sel:modificationStates:Workspace', workspace_modificationStates - The modification states of the WorkSpace.

$sel:relatedWorkspaces:Workspace', workspace_relatedWorkspaces - The Standby WorkSpace or Primary WorkSpace related to the specified WorkSpace.

$sel:rootVolumeEncryptionEnabled:Workspace', workspace_rootVolumeEncryptionEnabled - Indicates whether the data stored on the root volume is encrypted.

Workspace, workspace_state - The operational state of the WorkSpace.

After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

$sel:subnetId:Workspace', workspace_subnetId - The identifier of the subnet for the WorkSpace.

$sel:userName:Workspace', workspace_userName - The user for the WorkSpace.

$sel:userVolumeEncryptionEnabled:Workspace', workspace_userVolumeEncryptionEnabled - Indicates whether the data stored on the user volume is encrypted.

$sel:volumeEncryptionKey:Workspace', workspace_volumeEncryptionKey - The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

Workspace, workspace_workspaceId - The identifier of the WorkSpace.

$sel:workspaceProperties:Workspace', workspace_workspaceProperties - The properties of the WorkSpace.

workspace_bundleId :: Lens' Workspace (Maybe Text) Source #

The identifier of the bundle used to create the WorkSpace.

workspace_computerName :: Lens' Workspace (Maybe Text) Source #

The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.

workspace_directoryId :: Lens' Workspace (Maybe Text) Source #

The identifier of the Directory Service directory for the WorkSpace.

workspace_errorCode :: Lens' Workspace (Maybe Text) Source #

The error code that is returned if the WorkSpace cannot be created.

workspace_errorMessage :: Lens' Workspace (Maybe Text) Source #

The text of the error message that is returned if the WorkSpace cannot be created.

workspace_ipAddress :: Lens' Workspace (Maybe Text) Source #

The IP address of the WorkSpace.

workspace_modificationStates :: Lens' Workspace (Maybe [ModificationState]) Source #

The modification states of the WorkSpace.

The Standby WorkSpace or Primary WorkSpace related to the specified WorkSpace.

workspace_rootVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool) Source #

Indicates whether the data stored on the root volume is encrypted.

workspace_state :: Lens' Workspace (Maybe WorkspaceState) Source #

The operational state of the WorkSpace.

After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

workspace_subnetId :: Lens' Workspace (Maybe Text) Source #

The identifier of the subnet for the WorkSpace.

workspace_userName :: Lens' Workspace (Maybe Text) Source #

The user for the WorkSpace.

workspace_userVolumeEncryptionEnabled :: Lens' Workspace (Maybe Bool) Source #

Indicates whether the data stored on the user volume is encrypted.

workspace_volumeEncryptionKey :: Lens' Workspace (Maybe Text) Source #

The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

workspace_workspaceId :: Lens' Workspace (Maybe Text) Source #

The identifier of the WorkSpace.

workspace_workspaceProperties :: Lens' Workspace (Maybe WorkspaceProperties) Source #

The properties of the WorkSpace.