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.CreateWorkspaceImage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new WorkSpace image from an existing WorkSpace.

Synopsis

data CreateWorkspaceImage = CreateWorkspaceImage' {
- tags :: Maybe [Tag]
- name :: Text
- description :: Text
- workspaceId :: Text
}
newCreateWorkspaceImage :: Text -> Text -> Text -> CreateWorkspaceImage
createWorkspaceImage_tags :: Lens' CreateWorkspaceImage (Maybe [Tag])
createWorkspaceImage_name :: Lens' CreateWorkspaceImage Text
createWorkspaceImage_description :: Lens' CreateWorkspaceImage Text
createWorkspaceImage_workspaceId :: Lens' CreateWorkspaceImage Text
data CreateWorkspaceImageResponse = CreateWorkspaceImageResponse' {
- created :: Maybe POSIX
- description :: Maybe Text
- imageId :: Maybe Text
- name :: Maybe Text
- operatingSystem :: Maybe OperatingSystem
- ownerAccountId :: Maybe Text
- requiredTenancy :: Maybe WorkspaceImageRequiredTenancy
- state :: Maybe WorkspaceImageState
- httpStatus :: Int
}
newCreateWorkspaceImageResponse :: Int -> CreateWorkspaceImageResponse
createWorkspaceImageResponse_created :: Lens' CreateWorkspaceImageResponse (Maybe UTCTime)
createWorkspaceImageResponse_description :: Lens' CreateWorkspaceImageResponse (Maybe Text)
createWorkspaceImageResponse_imageId :: Lens' CreateWorkspaceImageResponse (Maybe Text)
createWorkspaceImageResponse_name :: Lens' CreateWorkspaceImageResponse (Maybe Text)
createWorkspaceImageResponse_operatingSystem :: Lens' CreateWorkspaceImageResponse (Maybe OperatingSystem)
createWorkspaceImageResponse_ownerAccountId :: Lens' CreateWorkspaceImageResponse (Maybe Text)
createWorkspaceImageResponse_requiredTenancy :: Lens' CreateWorkspaceImageResponse (Maybe WorkspaceImageRequiredTenancy)
createWorkspaceImageResponse_state :: Lens' CreateWorkspaceImageResponse (Maybe WorkspaceImageState)
createWorkspaceImageResponse_httpStatus :: Lens' CreateWorkspaceImageResponse Int

Creating a Request

data CreateWorkspaceImage Source #

See: newCreateWorkspaceImage smart constructor.

Constructors

CreateWorkspaceImage'

Fields

tags :: Maybe [Tag]
The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags.
name :: Text
The name of the new WorkSpace image.
description :: Text
The description of the new WorkSpace image.
workspaceId :: Text
The identifier of the source WorkSpace

Instances

Instances details

ToJSON CreateWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Methods toJSON :: CreateWorkspaceImage -> Value # toEncoding :: CreateWorkspaceImage -> Encoding # toJSONList :: [CreateWorkspaceImage] -> Value # toEncodingList :: [CreateWorkspaceImage] -> Encoding #
ToHeaders CreateWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Methods toHeaders :: CreateWorkspaceImage -> [Header] #
ToPath CreateWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Methods toPath :: CreateWorkspaceImage -> ByteString #
ToQuery CreateWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Methods toQuery :: CreateWorkspaceImage -> QueryString #
AWSRequest CreateWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Associated Types type AWSResponse CreateWorkspaceImage # Methods request :: (Service -> Service) -> CreateWorkspaceImage -> Request CreateWorkspaceImage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateWorkspaceImage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateWorkspaceImage))) #
Generic CreateWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Associated Types type Rep CreateWorkspaceImage :: Type -> Type # Methods from :: CreateWorkspaceImage -> Rep CreateWorkspaceImage x # to :: Rep CreateWorkspaceImage x -> CreateWorkspaceImage #
Read CreateWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Methods readsPrec :: Int -> ReadS CreateWorkspaceImage # readList :: ReadS [CreateWorkspaceImage] # readPrec :: ReadPrec CreateWorkspaceImage # readListPrec :: ReadPrec [CreateWorkspaceImage] #
Show CreateWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Methods showsPrec :: Int -> CreateWorkspaceImage -> ShowS # show :: CreateWorkspaceImage -> String # showList :: [CreateWorkspaceImage] -> ShowS #
NFData CreateWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Methods rnf :: CreateWorkspaceImage -> () #
Eq CreateWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Methods (==) :: CreateWorkspaceImage -> CreateWorkspaceImage -> Bool # (/=) :: CreateWorkspaceImage -> CreateWorkspaceImage -> Bool #
Hashable CreateWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Methods hashWithSalt :: Int -> CreateWorkspaceImage -> Int # hash :: CreateWorkspaceImage -> Int #
type AWSResponse CreateWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage type AWSResponse CreateWorkspaceImage = CreateWorkspaceImageResponse
type Rep CreateWorkspaceImage Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage type Rep CreateWorkspaceImage = D1 ('MetaData "CreateWorkspaceImage" "Amazonka.WorkSpaces.CreateWorkspaceImage" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "CreateWorkspaceImage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateWorkspaceImage Source #

Arguments

:: Text	`CreateWorkspaceImage`
-> Text	`CreateWorkspaceImage`
-> Text	`CreateWorkspaceImage`
-> CreateWorkspaceImage

Create a value of CreateWorkspaceImage 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:

CreateWorkspaceImage, createWorkspaceImage_tags - The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags.

CreateWorkspaceImage, createWorkspaceImage_name - The name of the new WorkSpace image.

CreateWorkspaceImage, createWorkspaceImage_description - The description of the new WorkSpace image.

CreateWorkspaceImage, createWorkspaceImage_workspaceId - The identifier of the source WorkSpace

Request Lenses

createWorkspaceImage_tags :: Lens' CreateWorkspaceImage (Maybe [Tag]) Source #

The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags.

createWorkspaceImage_name :: Lens' CreateWorkspaceImage Text Source #

The name of the new WorkSpace image.

createWorkspaceImage_description :: Lens' CreateWorkspaceImage Text Source #

The description of the new WorkSpace image.

createWorkspaceImage_workspaceId :: Lens' CreateWorkspaceImage Text Source #

The identifier of the source WorkSpace

Destructuring the Response

data CreateWorkspaceImageResponse Source #

See: newCreateWorkspaceImageResponse smart constructor.

Constructors

CreateWorkspaceImageResponse'

Fields

created :: Maybe POSIX
The date when the image was created.
description :: Maybe Text
The description of the image.
imageId :: Maybe Text
The identifier of the new WorkSpace 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 availability status of the image.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateWorkspaceImageResponse Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Associated Types type Rep CreateWorkspaceImageResponse :: Type -> Type # Methods from :: CreateWorkspaceImageResponse -> Rep CreateWorkspaceImageResponse x # to :: Rep CreateWorkspaceImageResponse x -> CreateWorkspaceImageResponse #
Read CreateWorkspaceImageResponse Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Methods readsPrec :: Int -> ReadS CreateWorkspaceImageResponse # readList :: ReadS [CreateWorkspaceImageResponse] # readPrec :: ReadPrec CreateWorkspaceImageResponse # readListPrec :: ReadPrec [CreateWorkspaceImageResponse] #
Show CreateWorkspaceImageResponse Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Methods showsPrec :: Int -> CreateWorkspaceImageResponse -> ShowS # show :: CreateWorkspaceImageResponse -> String # showList :: [CreateWorkspaceImageResponse] -> ShowS #
NFData CreateWorkspaceImageResponse Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Methods rnf :: CreateWorkspaceImageResponse -> () #
Eq CreateWorkspaceImageResponse Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage Methods (==) :: CreateWorkspaceImageResponse -> CreateWorkspaceImageResponse -> Bool # (/=) :: CreateWorkspaceImageResponse -> CreateWorkspaceImageResponse -> Bool #
type Rep CreateWorkspaceImageResponse Source #
Instance details Defined in Amazonka.WorkSpaces.CreateWorkspaceImage type Rep CreateWorkspaceImageResponse = D1 ('MetaData "CreateWorkspaceImageResponse" "Amazonka.WorkSpaces.CreateWorkspaceImage" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "CreateWorkspaceImageResponse'" '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 "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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateWorkspaceImageResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateWorkspaceImageResponse'`
-> CreateWorkspaceImageResponse

Create a value of CreateWorkspaceImageResponse 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:

CreateWorkspaceImageResponse, createWorkspaceImageResponse_created - The date when the image was created.

CreateWorkspaceImage, createWorkspaceImageResponse_description - The description of the image.

CreateWorkspaceImageResponse, createWorkspaceImageResponse_imageId - The identifier of the new WorkSpace image.

CreateWorkspaceImage, createWorkspaceImageResponse_name - The name of the image.

CreateWorkspaceImageResponse, createWorkspaceImageResponse_operatingSystem - The operating system that the image is running.

CreateWorkspaceImageResponse, createWorkspaceImageResponse_ownerAccountId - The identifier of the Amazon Web Services account that owns the image.

CreateWorkspaceImageResponse, createWorkspaceImageResponse_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..

CreateWorkspaceImageResponse, createWorkspaceImageResponse_state - The availability status of the image.

$sel:httpStatus:CreateWorkspaceImageResponse', createWorkspaceImageResponse_httpStatus - The response's http status code.

Response Lenses

createWorkspaceImageResponse_created :: Lens' CreateWorkspaceImageResponse (Maybe UTCTime) Source #

The date when the image was created.

createWorkspaceImageResponse_description :: Lens' CreateWorkspaceImageResponse (Maybe Text) Source #

The description of the image.

createWorkspaceImageResponse_imageId :: Lens' CreateWorkspaceImageResponse (Maybe Text) Source #

The identifier of the new WorkSpace image.

createWorkspaceImageResponse_name :: Lens' CreateWorkspaceImageResponse (Maybe Text) Source #

The name of the image.

createWorkspaceImageResponse_operatingSystem :: Lens' CreateWorkspaceImageResponse (Maybe OperatingSystem) Source #

The operating system that the image is running.

createWorkspaceImageResponse_ownerAccountId :: Lens' CreateWorkspaceImageResponse (Maybe Text) Source #

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

createWorkspaceImageResponse_requiredTenancy :: Lens' CreateWorkspaceImageResponse (Maybe WorkspaceImageRequiredTenancy) Source #

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..

createWorkspaceImageResponse_state :: Lens' CreateWorkspaceImageResponse (Maybe WorkspaceImageState) Source #

The availability status of the image.

createWorkspaceImageResponse_httpStatus :: Lens' CreateWorkspaceImageResponse Int Source #

The response's http status code.