Amazonka.WorkSpaces.Types.WorkspaceImage

Documentation

data WorkspaceImage

Describes a WorkSpace image.

See: newWorkspaceImage smart constructor.

Constructors

WorkspaceImage'

Fields

• created :: Maybe POSIX

  The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.

• description :: Maybe Text

  The description of the image.

• errorCode :: Maybe Text

  The error code that is returned for the image.

• errorMessage :: Maybe Text

  The text of the error message that is returned for the image.

• imageId :: Maybe Text

  The identifier of the image.

• name :: Maybe Text

  The name of the image.

• operatingSystem :: Maybe OperatingSystem

  The operating system that the image is running.

• ownerAccountId :: Maybe Text

  The identifier of the Amazon Web Services account that owns the image.

• requiredTenancy :: Maybe WorkspaceImageRequiredTenancy

  Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

• state :: Maybe WorkspaceImageState

  The status of the image.

• updates :: Maybe UpdateResult

  The updates (if any) that are available for the specified image.

Instances

FromJSON WorkspaceImage

Defined in Amazonka.WorkSpaces.Types.WorkspaceImage

Methods

parseJSON :: Value -> Parser WorkspaceImage

parseJSONList :: Value -> Parser [WorkspaceImage]

Generic WorkspaceImage

Defined in Amazonka.WorkSpaces.Types.WorkspaceImage

Associated Types

type Rep WorkspaceImage :: Type -> Type

Methods

from :: WorkspaceImage -> Rep WorkspaceImage x

to :: Rep WorkspaceImage x -> WorkspaceImage

Read WorkspaceImage

Defined in Amazonka.WorkSpaces.Types.WorkspaceImage

Methods

readsPrec :: Int -> ReadS WorkspaceImage

readList :: ReadS [WorkspaceImage]

readPrec :: ReadPrec WorkspaceImage

readListPrec :: ReadPrec [WorkspaceImage]

Show WorkspaceImage

Defined in Amazonka.WorkSpaces.Types.WorkspaceImage

Methods

showsPrec :: Int -> WorkspaceImage -> ShowS

show :: WorkspaceImage -> String

showList :: [WorkspaceImage] -> ShowS

NFData WorkspaceImage

Defined in Amazonka.WorkSpaces.Types.WorkspaceImage

Methods

rnf :: WorkspaceImage -> ()

Eq WorkspaceImage

Defined in Amazonka.WorkSpaces.Types.WorkspaceImage

Methods

(==) :: WorkspaceImage -> WorkspaceImage -> Bool

(/=) :: WorkspaceImage -> WorkspaceImage -> Bool

Hashable WorkspaceImage

Defined in Amazonka.WorkSpaces.Types.WorkspaceImage

Methods

hashWithSalt :: Int -> WorkspaceImage -> Int

hash :: WorkspaceImage -> Int

type Rep WorkspaceImage

Defined in Amazonka.WorkSpaces.Types.WorkspaceImage

type Rep WorkspaceImage = D1 ('MetaData "WorkspaceImage" "Amazonka.WorkSpaces.Types.WorkspaceImage" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "WorkspaceImage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") '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 "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "operatingSystem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OperatingSystem)) :*: S1 ('MetaSel ('Just "ownerAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "requiredTenancy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkspaceImageRequiredTenancy)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkspaceImageState)) :*: S1 ('MetaSel ('Just "updates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpdateResult)))))))

newWorkspaceImage :: WorkspaceImage

Create a value of WorkspaceImage 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:created:WorkspaceImage', workspaceImage_created - The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.

WorkspaceImage, workspaceImage_description - The description of the image.

$sel:errorCode:WorkspaceImage', workspaceImage_errorCode - The error code that is returned for the image.

$sel:errorMessage:WorkspaceImage', workspaceImage_errorMessage - The text of the error message that is returned for the image.

$sel:imageId:WorkspaceImage', workspaceImage_imageId - The identifier of the image.

$sel:name:WorkspaceImage', workspaceImage_name - The name of the image.

$sel:operatingSystem:WorkspaceImage', workspaceImage_operatingSystem - The operating system that the image is running.

$sel:ownerAccountId:WorkspaceImage', workspaceImage_ownerAccountId - The identifier of the Amazon Web Services account that owns the image.

$sel:requiredTenancy:WorkspaceImage', workspaceImage_requiredTenancy - Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

$sel:state:WorkspaceImage', workspaceImage_state - The status of the image.

$sel:updates:WorkspaceImage', workspaceImage_updates - The updates (if any) that are available for the specified image.

workspaceImage_created :: Lens' WorkspaceImage (Maybe UTCTime)

The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.

workspaceImage_description :: Lens' WorkspaceImage (Maybe Text)

The description of the image.

workspaceImage_errorCode :: Lens' WorkspaceImage (Maybe Text)

The error code that is returned for the image.

workspaceImage_errorMessage :: Lens' WorkspaceImage (Maybe Text)

The text of the error message that is returned for the image.

workspaceImage_imageId :: Lens' WorkspaceImage (Maybe Text)

The identifier of the image.

workspaceImage_name :: Lens' WorkspaceImage (Maybe Text)

The name of the image.

workspaceImage_operatingSystem :: Lens' WorkspaceImage (Maybe OperatingSystem)

The operating system that the image is running.

workspaceImage_ownerAccountId :: Lens' WorkspaceImage (Maybe Text)

The identifier of the Amazon Web Services account that owns the image.

workspaceImage_requiredTenancy :: Lens' WorkspaceImage (Maybe WorkspaceImageRequiredTenancy)

Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

workspaceImage_state :: Lens' WorkspaceImage (Maybe WorkspaceImageState)

The status of the image.

workspaceImage_updates :: Lens' WorkspaceImage (Maybe UpdateResult)

The updates (if any) that are available for the specified image.