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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.

For more information, see the "Update an Image by Using Managed AppStream 2.0 Image Updates" section in Administer Your AppStream 2.0 Images, in the Amazon AppStream 2.0 Administration Guide.

Synopsis

data CreateUpdatedImage = CreateUpdatedImage' {
- dryRun :: Maybe Bool
- newImageDescription' :: Maybe Text
- newImageDisplayName' :: Maybe Text
- newImageTags' :: Maybe (HashMap Text Text)
- existingImageName :: Text
- newImageName' :: Text
}
newCreateUpdatedImage :: Text -> Text -> CreateUpdatedImage
createUpdatedImage_dryRun :: Lens' CreateUpdatedImage (Maybe Bool)
createUpdatedImage_newImageDescription :: Lens' CreateUpdatedImage (Maybe Text)
createUpdatedImage_newImageDisplayName :: Lens' CreateUpdatedImage (Maybe Text)
createUpdatedImage_newImageTags :: Lens' CreateUpdatedImage (Maybe (HashMap Text Text))
createUpdatedImage_existingImageName :: Lens' CreateUpdatedImage Text
createUpdatedImage_newImageName :: Lens' CreateUpdatedImage Text
data CreateUpdatedImageResponse = CreateUpdatedImageResponse' {
- canUpdateImage :: Maybe Bool
- image :: Maybe Image
- httpStatus :: Int
}
newCreateUpdatedImageResponse :: Int -> CreateUpdatedImageResponse
createUpdatedImageResponse_canUpdateImage :: Lens' CreateUpdatedImageResponse (Maybe Bool)
createUpdatedImageResponse_image :: Lens' CreateUpdatedImageResponse (Maybe Image)
createUpdatedImageResponse_httpStatus :: Lens' CreateUpdatedImageResponse Int

Creating a Request

data CreateUpdatedImage Source #

See: newCreateUpdatedImage smart constructor.

Constructors

CreateUpdatedImage'

Fields

dryRun :: Maybe Bool
Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image. If this value is set to true, AppStream 2.0 displays whether image updates are available. If this value is set to false, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.
newImageDescription' :: Maybe Text
The description to display for the new image.
newImageDisplayName' :: Maybe Text
The name to display for the new image.
newImageTags' :: Maybe (HashMap Text Text)
The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
_ . : / = + \ - @
If you do not specify a value, the value is set to an empty string.
For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
existingImageName :: Text
The name of the image to update.
newImageName' :: Text
The name of the new image. The name must be unique within the AWS account and Region.

Instances

Instances details

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

newCreateUpdatedImage Source #

Arguments

:: Text	`$sel:existingImageName:CreateUpdatedImage'`
-> Text	`$sel:newImageName':CreateUpdatedImage'`
-> CreateUpdatedImage

Create a value of CreateUpdatedImage 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:dryRun:CreateUpdatedImage', createUpdatedImage_dryRun - Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image. If this value is set to true, AppStream 2.0 displays whether image updates are available. If this value is set to false, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.

$sel:newImageDescription':CreateUpdatedImage', createUpdatedImage_newImageDescription - The description to display for the new image.

$sel:newImageDisplayName':CreateUpdatedImage', createUpdatedImage_newImageDisplayName - The name to display for the new image.

$sel:newImageTags':CreateUpdatedImage', createUpdatedImage_newImageTags - The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

If you do not specify a value, the value is set to an empty string.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

$sel:existingImageName:CreateUpdatedImage', createUpdatedImage_existingImageName - The name of the image to update.

$sel:newImageName':CreateUpdatedImage', createUpdatedImage_newImageName - The name of the new image. The name must be unique within the AWS account and Region.

Request Lenses

createUpdatedImage_dryRun :: Lens' CreateUpdatedImage (Maybe Bool) Source #

Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image. If this value is set to true, AppStream 2.0 displays whether image updates are available. If this value is set to false, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.

createUpdatedImage_newImageDescription :: Lens' CreateUpdatedImage (Maybe Text) Source #

The description to display for the new image.

createUpdatedImage_newImageDisplayName :: Lens' CreateUpdatedImage (Maybe Text) Source #

The name to display for the new image.

createUpdatedImage_newImageTags :: Lens' CreateUpdatedImage (Maybe (HashMap Text Text)) Source #

The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

If you do not specify a value, the value is set to an empty string.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

createUpdatedImage_existingImageName :: Lens' CreateUpdatedImage Text Source #

The name of the image to update.

createUpdatedImage_newImageName :: Lens' CreateUpdatedImage Text Source #

The name of the new image. The name must be unique within the AWS account and Region.

Destructuring the Response

data CreateUpdatedImageResponse Source #

See: newCreateUpdatedImageResponse smart constructor.

Constructors

CreateUpdatedImageResponse'
Fields canUpdateImage :: Maybe Bool Indicates whether a new image can be created. image :: Maybe Image httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateUpdatedImageResponse Source #
Instance details Defined in Amazonka.AppStream.CreateUpdatedImage Associated Types type Rep CreateUpdatedImageResponse :: Type -> Type # Methods from :: CreateUpdatedImageResponse -> Rep CreateUpdatedImageResponse x # to :: Rep CreateUpdatedImageResponse x -> CreateUpdatedImageResponse #
Read CreateUpdatedImageResponse Source #
Instance details Defined in Amazonka.AppStream.CreateUpdatedImage Methods readsPrec :: Int -> ReadS CreateUpdatedImageResponse # readList :: ReadS [CreateUpdatedImageResponse] # readPrec :: ReadPrec CreateUpdatedImageResponse # readListPrec :: ReadPrec [CreateUpdatedImageResponse] #
Show CreateUpdatedImageResponse Source #
Instance details Defined in Amazonka.AppStream.CreateUpdatedImage Methods showsPrec :: Int -> CreateUpdatedImageResponse -> ShowS # show :: CreateUpdatedImageResponse -> String # showList :: [CreateUpdatedImageResponse] -> ShowS #
NFData CreateUpdatedImageResponse Source #
Instance details Defined in Amazonka.AppStream.CreateUpdatedImage Methods rnf :: CreateUpdatedImageResponse -> () #
Eq CreateUpdatedImageResponse Source #
Instance details Defined in Amazonka.AppStream.CreateUpdatedImage Methods (==) :: CreateUpdatedImageResponse -> CreateUpdatedImageResponse -> Bool # (/=) :: CreateUpdatedImageResponse -> CreateUpdatedImageResponse -> Bool #
type Rep CreateUpdatedImageResponse Source #
Instance details Defined in Amazonka.AppStream.CreateUpdatedImage type Rep CreateUpdatedImageResponse = D1 ('MetaData "CreateUpdatedImageResponse" "Amazonka.AppStream.CreateUpdatedImage" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "CreateUpdatedImageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "canUpdateImage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Image)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateUpdatedImageResponse Source #

Arguments

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

Create a value of CreateUpdatedImageResponse 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:canUpdateImage:CreateUpdatedImageResponse', createUpdatedImageResponse_canUpdateImage - Indicates whether a new image can be created.

$sel:image:CreateUpdatedImageResponse', createUpdatedImageResponse_image - Undocumented member.

$sel:httpStatus:CreateUpdatedImageResponse', createUpdatedImageResponse_httpStatus - The response's http status code.

Response Lenses

createUpdatedImageResponse_canUpdateImage :: Lens' CreateUpdatedImageResponse (Maybe Bool) Source #

Indicates whether a new image can be created.

createUpdatedImageResponse_image :: Lens' CreateUpdatedImageResponse (Maybe Image) Source #

Undocumented member.

createUpdatedImageResponse_httpStatus :: Lens' CreateUpdatedImageResponse Int Source #

The response's http status code.