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 |
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' {}
- 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.
CreateUpdatedImage' | |
|
Instances
newCreateUpdatedImage Source #
:: Text | |
-> Text | |
-> 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.
CreateUpdatedImageResponse' | |
|
Instances
newCreateUpdatedImageResponse Source #
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.