Skip to content

CreateUpdatedImageRequest

Source code in docs_src/capo_appstream/types/create_updated_image_request.py
class CreateUpdatedImageRequest(TypedDict, closed=True):
    existing_image_name: NotRequired["capo_appstream.types.name.Name"]
    """<p>The name of the image to update.</p>"""
    new_image_name: NotRequired["capo_appstream.types.name.Name"]
    """<p>The name of the new image. The name must be unique within the AWS account and Region.</p>"""
    new_image_description: NotRequired["capo_appstream.types.description.Description"]
    """<p>The description to display for the new image.</p>"""
    new_image_display_name: NotRequired["capo_appstream.types.display_name.DisplayName"]
    """<p>The name to display for the new image.</p>"""
    new_image_tags: NotRequired["capo_appstream.types.tags.Tags"]
    r"""<p>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=. </p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \ - @</p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>For more information about tags, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>"""
    dry_run: NotRequired["capo_appstream.types.boolean.Boolean"]
    """<p>Indicates whether to display the status of image update availability before WorkSpaces Applications initiates the process of creating a new updated image. If this value is set to <code>true</code>, WorkSpaces Applications displays whether image updates are available. If this value is set to <code>false</code>, WorkSpaces Applications initiates the process of creating a new updated image without displaying whether image updates are available.</p>"""

dry_run instance-attribute

dry_run: NotRequired[Boolean]

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

existing_image_name instance-attribute

existing_image_name: NotRequired[Name]

The name of the image to update.

new_image_description instance-attribute

new_image_description: NotRequired[Description]

The description to display for the new image.

new_image_display_name instance-attribute

new_image_display_name: NotRequired[DisplayName]

The name to display for the new image.

new_image_name instance-attribute

new_image_name: NotRequired[Name]

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

new_image_tags instance-attribute

new_image_tags: NotRequired[Tags]

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 WorkSpaces Applications Administration Guide.