CreateImportedImageRequest
¶
Source code in docs_src/capo_appstream/types/create_imported_image_request.py
agent_software_version
instance-attribute
¶
agent_software_version: NotRequired[AgentSoftwareVersion]
The version of the WorkSpaces Applications agent to use for the imported image. Choose CURRENT_LATEST to use the agent version available at the time of import, or ALWAYS_LATEST to automatically update to the latest agent version when new versions are released.
app_catalog_config
instance-attribute
¶
app_catalog_config: NotRequired[AppCatalogConfig]
Configuration for the application catalog of the imported image. This allows you to specify applications available for streaming, including their paths, icons, and launch parameters. This field contains sensitive data.
description
instance-attribute
¶
description: NotRequired[ImageImportDescription]
An optional description for the imported image. The description must match approved regex patterns and can be up to 256 characters.
display_name
instance-attribute
¶
display_name: NotRequired[ImageImportDisplayName]
An optional display name for the imported image. The display name must match approved regex patterns and can be up to 100 characters.
dry_run
instance-attribute
¶
dry_run: NotRequired[Boolean]
When set to true, performs validation checks without actually creating the imported image. Use this to verify your configuration before executing the actual import operation.
iam_role_arn
instance-attribute
¶
iam_role_arn: NotRequired[Arn]
The ARN of the IAM role that allows WorkSpaces Applications to access your AMI. The role must have permissions to modify image attributes and describe images, with a trust relationship allowing appstream.amazonaws.com to assume the role.
name
instance-attribute
¶
name: NotRequired[Name]
A unique name for the imported image. The name must be between 1 and 100 characters and can contain letters, numbers, underscores, periods, and hyphens.
runtime_validation_config
instance-attribute
¶
runtime_validation_config: NotRequired[RuntimeValidationConfig]
Configuration for runtime validation of the imported image. When specified, WorkSpaces Applications provisions an instance to test streaming functionality, which helps ensure the image is suitable for use.
source_ami_id
instance-attribute
¶
source_ami_id: NotRequired[PhotonAmiId]
The ID of the EC2 AMI to import.
tags
instance-attribute
¶
tags: NotRequired[Tags]
The tags to apply to the imported image. Tags help you organize and manage your WorkSpaces Applications resources.
workspace_image_id
instance-attribute
¶
workspace_image_id: NotRequired[WorkspaceImageId]
The ID of the Workspaces Image to import.