2024/08/13 - Amazon AppStream - 4 new 8 updated api methods
Changes This release includes following new APIs: CreateThemeForStack, DescribeThemeForStack, UpdateThemeForStack, DeleteThemeForStack to support custom branding programmatically.
Updates custom branding that customizes the appearance of the streaming application catalog page.
See also: AWS API Documentation
Request Syntax
client.update_theme_for_stack( StackName='string', FooterLinks=[ { 'DisplayName': 'string', 'FooterLinkURL': 'string' }, ], TitleText='string', ThemeStyling='LIGHT_BLUE'|'BLUE'|'PINK'|'RED', OrganizationLogoS3Location={ 'S3Bucket': 'string', 'S3Key': 'string' }, FaviconS3Location={ 'S3Bucket': 'string', 'S3Key': 'string' }, State='ENABLED'|'DISABLED', AttributesToDelete=[ 'FOOTER_LINKS', ] )
string
[REQUIRED]
The name of the stack for the theme.
list
The links that are displayed in the footer of the streaming application catalog page. These links are helpful resources for users, such as the organization's IT support and product marketing sites.
(dict) --
The website links that display in the catalog page footer.
DisplayName (string) --
The name of the websites that display in the catalog page footer.
FooterLinkURL (string) --
The URL of the websites that display in the catalog page footer.
string
The title that is displayed at the top of the browser tab during users' application streaming sessions.
string
The color theme that is applied to website links, text, and buttons. These colors are also applied as accents in the background for the streaming application catalog page.
dict
The organization logo that appears on the streaming application catalog page.
S3Bucket (string) -- [REQUIRED]
The S3 bucket of the S3 object.
S3Key (string) --
The S3 key of the S3 object.
This is required when used for the following:
IconS3Location (Actions: CreateApplication and UpdateApplication)
SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)
ScriptDetails (Actions: CreateAppBlock)
SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)
SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)
dict
The S3 location of the favicon. The favicon enables users to recognize their application streaming site in a browser full of tabs or bookmarks. It is displayed at the top of the browser tab for the application streaming site during users' streaming sessions.
S3Bucket (string) -- [REQUIRED]
The S3 bucket of the S3 object.
S3Key (string) --
The S3 key of the S3 object.
This is required when used for the following:
IconS3Location (Actions: CreateApplication and UpdateApplication)
SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)
ScriptDetails (Actions: CreateAppBlock)
SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)
SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)
string
Specifies whether custom branding should be applied to catalog page or not.
list
The attributes to delete.
(string) --
dict
Response Syntax
{ 'Theme': { 'StackName': 'string', 'State': 'ENABLED'|'DISABLED', 'ThemeTitleText': 'string', 'ThemeStyling': 'LIGHT_BLUE'|'BLUE'|'PINK'|'RED', 'ThemeFooterLinks': [ { 'DisplayName': 'string', 'FooterLinkURL': 'string' }, ], 'ThemeOrganizationLogoURL': 'string', 'ThemeFaviconURL': 'string', 'CreatedTime': datetime(2015, 1, 1) } }
Response Structure
(dict) --
Theme (dict) --
The theme object that contains the metadata of the custom branding.
StackName (string) --
The stack that has the custom branding theme.
State (string) --
The state of the theme.
ThemeTitleText (string) --
The browser tab page title.
ThemeStyling (string) --
The color that is used for the website links, text, buttons, and catalog page background.
ThemeFooterLinks (list) --
The website links that display in the catalog page footer.
(dict) --
The website links that display in the catalog page footer.
DisplayName (string) --
The name of the websites that display in the catalog page footer.
FooterLinkURL (string) --
The URL of the websites that display in the catalog page footer.
ThemeOrganizationLogoURL (string) --
The URL of the logo that displays in the catalog page header.
ThemeFaviconURL (string) --
The URL of the icon that displays at the top of a user's browser tab during streaming sessions.
CreatedTime (datetime) --
The time the theme was created.
Creates custom branding that customizes the appearance of the streaming application catalog page.
See also: AWS API Documentation
Request Syntax
client.create_theme_for_stack( StackName='string', FooterLinks=[ { 'DisplayName': 'string', 'FooterLinkURL': 'string' }, ], TitleText='string', ThemeStyling='LIGHT_BLUE'|'BLUE'|'PINK'|'RED', OrganizationLogoS3Location={ 'S3Bucket': 'string', 'S3Key': 'string' }, FaviconS3Location={ 'S3Bucket': 'string', 'S3Key': 'string' } )
string
[REQUIRED]
The name of the stack for the theme.
list
The links that are displayed in the footer of the streaming application catalog page. These links are helpful resources for users, such as the organization's IT support and product marketing sites.
(dict) --
The website links that display in the catalog page footer.
DisplayName (string) --
The name of the websites that display in the catalog page footer.
FooterLinkURL (string) --
The URL of the websites that display in the catalog page footer.
string
[REQUIRED]
The title that is displayed at the top of the browser tab during users' application streaming sessions.
string
[REQUIRED]
The color theme that is applied to website links, text, and buttons. These colors are also applied as accents in the background for the streaming application catalog page.
dict
[REQUIRED]
The organization logo that appears on the streaming application catalog page.
S3Bucket (string) -- [REQUIRED]
The S3 bucket of the S3 object.
S3Key (string) --
The S3 key of the S3 object.
This is required when used for the following:
IconS3Location (Actions: CreateApplication and UpdateApplication)
SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)
ScriptDetails (Actions: CreateAppBlock)
SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)
SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)
dict
[REQUIRED]
The S3 location of the favicon. The favicon enables users to recognize their application streaming site in a browser full of tabs or bookmarks. It is displayed at the top of the browser tab for the application streaming site during users' streaming sessions.
S3Bucket (string) -- [REQUIRED]
The S3 bucket of the S3 object.
S3Key (string) --
The S3 key of the S3 object.
This is required when used for the following:
IconS3Location (Actions: CreateApplication and UpdateApplication)
SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)
ScriptDetails (Actions: CreateAppBlock)
SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)
SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)
dict
Response Syntax
{ 'Theme': { 'StackName': 'string', 'State': 'ENABLED'|'DISABLED', 'ThemeTitleText': 'string', 'ThemeStyling': 'LIGHT_BLUE'|'BLUE'|'PINK'|'RED', 'ThemeFooterLinks': [ { 'DisplayName': 'string', 'FooterLinkURL': 'string' }, ], 'ThemeOrganizationLogoURL': 'string', 'ThemeFaviconURL': 'string', 'CreatedTime': datetime(2015, 1, 1) } }
Response Structure
(dict) --
Theme (dict) --
The theme object that contains the metadata of the custom branding.
StackName (string) --
The stack that has the custom branding theme.
State (string) --
The state of the theme.
ThemeTitleText (string) --
The browser tab page title.
ThemeStyling (string) --
The color that is used for the website links, text, buttons, and catalog page background.
ThemeFooterLinks (list) --
The website links that display in the catalog page footer.
(dict) --
The website links that display in the catalog page footer.
DisplayName (string) --
The name of the websites that display in the catalog page footer.
FooterLinkURL (string) --
The URL of the websites that display in the catalog page footer.
ThemeOrganizationLogoURL (string) --
The URL of the logo that displays in the catalog page header.
ThemeFaviconURL (string) --
The URL of the icon that displays at the top of a user's browser tab during streaming sessions.
CreatedTime (datetime) --
The time the theme was created.
Deletes custom branding that customizes the appearance of the streaming application catalog page.
See also: AWS API Documentation
Request Syntax
client.delete_theme_for_stack( StackName='string' )
string
[REQUIRED]
The name of the stack for the theme.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a list that describes the theme for a specified stack. A theme is custom branding that customizes the appearance of the streaming application catalog page.
See also: AWS API Documentation
Request Syntax
client.describe_theme_for_stack( StackName='string' )
string
[REQUIRED]
The name of the stack for the theme.
dict
Response Syntax
{ 'Theme': { 'StackName': 'string', 'State': 'ENABLED'|'DISABLED', 'ThemeTitleText': 'string', 'ThemeStyling': 'LIGHT_BLUE'|'BLUE'|'PINK'|'RED', 'ThemeFooterLinks': [ { 'DisplayName': 'string', 'FooterLinkURL': 'string' }, ], 'ThemeOrganizationLogoURL': 'string', 'ThemeFaviconURL': 'string', 'CreatedTime': datetime(2015, 1, 1) } }
Response Structure
(dict) --
Theme (dict) --
The theme object that contains the metadata of the custom branding.
StackName (string) --
The stack that has the custom branding theme.
State (string) --
The state of the theme.
ThemeTitleText (string) --
The browser tab page title.
ThemeStyling (string) --
The color that is used for the website links, text, buttons, and catalog page background.
ThemeFooterLinks (list) --
The website links that display in the catalog page footer.
(dict) --
The website links that display in the catalog page footer.
DisplayName (string) --
The name of the websites that display in the catalog page footer.
FooterLinkURL (string) --
The URL of the websites that display in the catalog page footer.
ThemeOrganizationLogoURL (string) --
The URL of the logo that displays in the catalog page header.
ThemeFaviconURL (string) --
The URL of the icon that displays at the top of a user's browser tab during streaming sessions.
CreatedTime (datetime) --
The time the theme was created.
{'ImageBuilder': {'LatestAppstreamAgentVersion': 'TRUE | FALSE'}}
Creates an image builder. An image builder is a virtual machine that is used to create an image.
The initial state of the builder is PENDING . When it is ready, the state is RUNNING .
See also: AWS API Documentation
Request Syntax
client.create_image_builder( Name='string', ImageName='string', ImageArn='string', InstanceType='string', Description='string', DisplayName='string', VpcConfig={ 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, IamRoleArn='string', EnableDefaultInternetAccess=True|False, DomainJoinInfo={ 'DirectoryName': 'string', 'OrganizationalUnitDistinguishedName': 'string' }, AppstreamAgentVersion='string', Tags={ 'string': 'string' }, AccessEndpoints=[ { 'EndpointType': 'STREAMING', 'VpceId': 'string' }, ] )
string
[REQUIRED]
A unique name for the image builder.
string
The name of the image used to create the image builder.
string
The ARN of the public, private, or shared image to use.
string
[REQUIRED]
The instance type to use when launching the image builder. The following instance types are available:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.compute.large
stream.compute.xlarge
stream.compute.2xlarge
stream.compute.4xlarge
stream.compute.8xlarge
stream.memory.large
stream.memory.xlarge
stream.memory.2xlarge
stream.memory.4xlarge
stream.memory.8xlarge
stream.memory.z1d.large
stream.memory.z1d.xlarge
stream.memory.z1d.2xlarge
stream.memory.z1d.3xlarge
stream.memory.z1d.6xlarge
stream.memory.z1d.12xlarge
stream.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge
string
The description to display.
string
The image builder name to display.
dict
The VPC configuration for the image builder. You can specify only one subnet.
SubnetIds (list) --
The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.
(string) --
SecurityGroupIds (list) --
The identifiers of the security groups for the fleet or image builder.
(string) --
string
The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
boolean
Enables or disables default internet access for the image builder.
dict
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
DirectoryName (string) --
The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit for computer accounts.
string
The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
dict
The tags to associate with the image builder. 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 .
(string) --
(string) --
list
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) -- [REQUIRED]
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
dict
Response Syntax
{ 'ImageBuilder': { 'Name': 'string', 'Arn': 'string', 'ImageArn': 'string', 'Description': 'string', 'DisplayName': 'string', 'VpcConfig': { 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, 'InstanceType': 'string', 'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8', 'IamRoleArn': 'string', 'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION', 'StateChangeReason': { 'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE', 'Message': 'string' }, 'CreatedTime': datetime(2015, 1, 1), 'EnableDefaultInternetAccess': True|False, 'DomainJoinInfo': { 'DirectoryName': 'string', 'OrganizationalUnitDistinguishedName': 'string' }, 'NetworkAccessConfiguration': { 'EniPrivateIpAddress': 'string', 'EniId': 'string' }, 'ImageBuilderErrors': [ { 'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR', 'ErrorMessage': 'string', 'ErrorTimestamp': datetime(2015, 1, 1) }, ], 'AppstreamAgentVersion': 'string', 'AccessEndpoints': [ { 'EndpointType': 'STREAMING', 'VpceId': 'string' }, ], 'LatestAppstreamAgentVersion': 'TRUE'|'FALSE' } }
Response Structure
(dict) --
ImageBuilder (dict) --
Information about the image builder.
Name (string) --
The name of the image builder.
Arn (string) --
The ARN for the image builder.
ImageArn (string) --
The ARN of the image from which this builder was created.
Description (string) --
The description to display.
DisplayName (string) --
The image builder name to display.
VpcConfig (dict) --
The VPC configuration of the image builder.
SubnetIds (list) --
The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.
(string) --
SecurityGroupIds (list) --
The identifiers of the security groups for the fleet or image builder.
(string) --
InstanceType (string) --
The instance type for the image builder. The following instance types are available:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.compute.large
stream.compute.xlarge
stream.compute.2xlarge
stream.compute.4xlarge
stream.compute.8xlarge
stream.memory.large
stream.memory.xlarge
stream.memory.2xlarge
stream.memory.4xlarge
stream.memory.8xlarge
stream.memory.z1d.large
stream.memory.z1d.xlarge
stream.memory.z1d.2xlarge
stream.memory.z1d.3xlarge
stream.memory.z1d.6xlarge
stream.memory.z1d.12xlarge
stream.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge
Platform (string) --
The operating system platform of the image builder.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
State (string) --
The state of the image builder.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
CreatedTime (datetime) --
The time stamp when the image builder was created.
EnableDefaultInternetAccess (boolean) --
Enables or disables default internet access for the image builder.
DomainJoinInfo (dict) --
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
DirectoryName (string) --
The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit for computer accounts.
NetworkAccessConfiguration (dict) --
Describes the network details of the fleet or image builder instance.
EniPrivateIpAddress (string) --
The private IP address of the elastic network interface that is attached to instances in your VPC.
EniId (string) --
The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
ImageBuilderErrors (list) --
The image builder errors.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent that is currently being used by the image builder.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
LatestAppstreamAgentVersion (string) --
Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.
{'image': {'DynamicAppProvidersEnabled': 'ENABLED | DISABLED', 'ImageSharedWithOthers': 'TRUE | FALSE', 'LatestAppstreamAgentVersion': 'TRUE | FALSE', 'SupportedInstanceFamilies': ['string']}}
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 .
See also: AWS API Documentation
Request Syntax
client.create_updated_image( existingImageName='string', newImageName='string', newImageDescription='string', newImageDisplayName='string', newImageTags={ 'string': 'string' }, dryRun=True|False )
string
[REQUIRED]
The name of the image to update.
string
[REQUIRED]
The name of the new image. The name must be unique within the AWS account and Region.
string
The description to display for the new image.
string
The name to display for the new image.
dict
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 .
(string) --
(string) --
boolean
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.
dict
Response Syntax
{ 'image': { 'Name': 'string', 'Arn': 'string', 'BaseImageArn': 'string', 'DisplayName': 'string', 'State': 'PENDING'|'AVAILABLE'|'FAILED'|'COPYING'|'DELETING'|'CREATING'|'IMPORTING', 'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED', 'ImageBuilderSupported': True|False, 'ImageBuilderName': 'string', 'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8', 'Description': 'string', 'StateChangeReason': { 'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE', 'Message': 'string' }, 'Applications': [ { 'Name': 'string', 'DisplayName': 'string', 'IconURL': 'string', 'LaunchPath': 'string', 'LaunchParameters': 'string', 'Enabled': True|False, 'Metadata': { 'string': 'string' }, 'WorkingDirectory': 'string', 'Description': 'string', 'Arn': 'string', 'AppBlockArn': 'string', 'IconS3Location': { 'S3Bucket': 'string', 'S3Key': 'string' }, 'Platforms': [ 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8', ], 'InstanceFamilies': [ 'string', ], 'CreatedTime': datetime(2015, 1, 1) }, ], 'CreatedTime': datetime(2015, 1, 1), 'PublicBaseImageReleasedDate': datetime(2015, 1, 1), 'AppstreamAgentVersion': 'string', 'ImagePermissions': { 'allowFleet': True|False, 'allowImageBuilder': True|False }, 'ImageErrors': [ { 'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR', 'ErrorMessage': 'string', 'ErrorTimestamp': datetime(2015, 1, 1) }, ], 'LatestAppstreamAgentVersion': 'TRUE'|'FALSE', 'SupportedInstanceFamilies': [ 'string', ], 'DynamicAppProvidersEnabled': 'ENABLED'|'DISABLED', 'ImageSharedWithOthers': 'TRUE'|'FALSE' }, 'canUpdateImage': True|False }
Response Structure
(dict) --
image (dict) --
Describes an image.
Name (string) --
The name of the image.
Arn (string) --
The ARN of the image.
BaseImageArn (string) --
The ARN of the image from which this image was created.
DisplayName (string) --
The image name to display.
State (string) --
The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE . If image creation fails, the state is FAILED .
Visibility (string) --
Indicates whether the image is public or private.
ImageBuilderSupported (boolean) --
Indicates whether an image builder can be launched from this image.
ImageBuilderName (string) --
The name of the image builder that was used to create the private image. If the image is shared, this value is null.
Platform (string) --
The operating system platform of the image.
Description (string) --
The description to display.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
Applications (list) --
The applications associated with the image.
(dict) --
Describes an application in the application catalog.
Name (string) --
The name of the application.
DisplayName (string) --
The application name to display.
IconURL (string) --
The URL for the application icon. This URL might be time-limited.
LaunchPath (string) --
The path to the application executable in the instance.
LaunchParameters (string) --
The arguments that are passed to the application at launch.
Enabled (boolean) --
If there is a problem, the application can be disabled after image creation.
Metadata (dict) --
Additional attributes that describe the application.
(string) --
(string) --
WorkingDirectory (string) --
The working directory for the application.
Description (string) --
The description of the application.
Arn (string) --
The ARN of the application.
AppBlockArn (string) --
The app block ARN of the application.
IconS3Location (dict) --
The S3 location of the application icon.
S3Bucket (string) --
The S3 bucket of the S3 object.
S3Key (string) --
The S3 key of the S3 object.
This is required when used for the following:
IconS3Location (Actions: CreateApplication and UpdateApplication)
SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)
ScriptDetails (Actions: CreateAppBlock)
SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)
SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)
Platforms (list) --
The platforms on which the application can run.
(string) --
InstanceFamilies (list) --
The instance families for the application.
(string) --
CreatedTime (datetime) --
The time at which the application was created within the app block.
CreatedTime (datetime) --
The time the image was created.
PublicBaseImageReleasedDate (datetime) --
The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
ImagePermissions (dict) --
The permissions to provide to the destination AWS account for the specified image.
allowFleet (boolean) --
Indicates whether the image can be used for a fleet.
allowImageBuilder (boolean) --
Indicates whether the image can be used for an image builder.
ImageErrors (list) --
Describes the errors that are returned when a new image can't be created.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
LatestAppstreamAgentVersion (string) --
Indicates whether the image is using the latest AppStream 2.0 agent version or not.
SupportedInstanceFamilies (list) --
The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder. The following instances families are supported:
General Purpose
Compute Optimized
Memory Optimized
Graphics
Graphics Design
Graphics Pro
Graphics G4
Graphics G5
(string) --
DynamicAppProvidersEnabled (string) --
Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.
ImageSharedWithOthers (string) --
Indicates whether the image is shared with another account ID.
canUpdateImage (boolean) --
Indicates whether a new image can be created.
{'Image': {'DynamicAppProvidersEnabled': 'ENABLED | DISABLED', 'ImageSharedWithOthers': 'TRUE | FALSE', 'LatestAppstreamAgentVersion': 'TRUE | FALSE', 'SupportedInstanceFamilies': ['string']}}
Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.
See also: AWS API Documentation
Request Syntax
client.delete_image( Name='string' )
string
[REQUIRED]
The name of the image.
dict
Response Syntax
{ 'Image': { 'Name': 'string', 'Arn': 'string', 'BaseImageArn': 'string', 'DisplayName': 'string', 'State': 'PENDING'|'AVAILABLE'|'FAILED'|'COPYING'|'DELETING'|'CREATING'|'IMPORTING', 'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED', 'ImageBuilderSupported': True|False, 'ImageBuilderName': 'string', 'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8', 'Description': 'string', 'StateChangeReason': { 'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE', 'Message': 'string' }, 'Applications': [ { 'Name': 'string', 'DisplayName': 'string', 'IconURL': 'string', 'LaunchPath': 'string', 'LaunchParameters': 'string', 'Enabled': True|False, 'Metadata': { 'string': 'string' }, 'WorkingDirectory': 'string', 'Description': 'string', 'Arn': 'string', 'AppBlockArn': 'string', 'IconS3Location': { 'S3Bucket': 'string', 'S3Key': 'string' }, 'Platforms': [ 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8', ], 'InstanceFamilies': [ 'string', ], 'CreatedTime': datetime(2015, 1, 1) }, ], 'CreatedTime': datetime(2015, 1, 1), 'PublicBaseImageReleasedDate': datetime(2015, 1, 1), 'AppstreamAgentVersion': 'string', 'ImagePermissions': { 'allowFleet': True|False, 'allowImageBuilder': True|False }, 'ImageErrors': [ { 'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR', 'ErrorMessage': 'string', 'ErrorTimestamp': datetime(2015, 1, 1) }, ], 'LatestAppstreamAgentVersion': 'TRUE'|'FALSE', 'SupportedInstanceFamilies': [ 'string', ], 'DynamicAppProvidersEnabled': 'ENABLED'|'DISABLED', 'ImageSharedWithOthers': 'TRUE'|'FALSE' } }
Response Structure
(dict) --
Image (dict) --
Information about the image.
Name (string) --
The name of the image.
Arn (string) --
The ARN of the image.
BaseImageArn (string) --
The ARN of the image from which this image was created.
DisplayName (string) --
The image name to display.
State (string) --
The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE . If image creation fails, the state is FAILED .
Visibility (string) --
Indicates whether the image is public or private.
ImageBuilderSupported (boolean) --
Indicates whether an image builder can be launched from this image.
ImageBuilderName (string) --
The name of the image builder that was used to create the private image. If the image is shared, this value is null.
Platform (string) --
The operating system platform of the image.
Description (string) --
The description to display.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
Applications (list) --
The applications associated with the image.
(dict) --
Describes an application in the application catalog.
Name (string) --
The name of the application.
DisplayName (string) --
The application name to display.
IconURL (string) --
The URL for the application icon. This URL might be time-limited.
LaunchPath (string) --
The path to the application executable in the instance.
LaunchParameters (string) --
The arguments that are passed to the application at launch.
Enabled (boolean) --
If there is a problem, the application can be disabled after image creation.
Metadata (dict) --
Additional attributes that describe the application.
(string) --
(string) --
WorkingDirectory (string) --
The working directory for the application.
Description (string) --
The description of the application.
Arn (string) --
The ARN of the application.
AppBlockArn (string) --
The app block ARN of the application.
IconS3Location (dict) --
The S3 location of the application icon.
S3Bucket (string) --
The S3 bucket of the S3 object.
S3Key (string) --
The S3 key of the S3 object.
This is required when used for the following:
IconS3Location (Actions: CreateApplication and UpdateApplication)
SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)
ScriptDetails (Actions: CreateAppBlock)
SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)
SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)
Platforms (list) --
The platforms on which the application can run.
(string) --
InstanceFamilies (list) --
The instance families for the application.
(string) --
CreatedTime (datetime) --
The time at which the application was created within the app block.
CreatedTime (datetime) --
The time the image was created.
PublicBaseImageReleasedDate (datetime) --
The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
ImagePermissions (dict) --
The permissions to provide to the destination AWS account for the specified image.
allowFleet (boolean) --
Indicates whether the image can be used for a fleet.
allowImageBuilder (boolean) --
Indicates whether the image can be used for an image builder.
ImageErrors (list) --
Describes the errors that are returned when a new image can't be created.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
LatestAppstreamAgentVersion (string) --
Indicates whether the image is using the latest AppStream 2.0 agent version or not.
SupportedInstanceFamilies (list) --
The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder. The following instances families are supported:
General Purpose
Compute Optimized
Memory Optimized
Graphics
Graphics Design
Graphics Pro
Graphics G4
Graphics G5
(string) --
DynamicAppProvidersEnabled (string) --
Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.
ImageSharedWithOthers (string) --
Indicates whether the image is shared with another account ID.
{'ImageBuilder': {'LatestAppstreamAgentVersion': 'TRUE | FALSE'}}
Deletes the specified image builder and releases the capacity.
See also: AWS API Documentation
Request Syntax
client.delete_image_builder( Name='string' )
string
[REQUIRED]
The name of the image builder.
dict
Response Syntax
{ 'ImageBuilder': { 'Name': 'string', 'Arn': 'string', 'ImageArn': 'string', 'Description': 'string', 'DisplayName': 'string', 'VpcConfig': { 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, 'InstanceType': 'string', 'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8', 'IamRoleArn': 'string', 'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION', 'StateChangeReason': { 'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE', 'Message': 'string' }, 'CreatedTime': datetime(2015, 1, 1), 'EnableDefaultInternetAccess': True|False, 'DomainJoinInfo': { 'DirectoryName': 'string', 'OrganizationalUnitDistinguishedName': 'string' }, 'NetworkAccessConfiguration': { 'EniPrivateIpAddress': 'string', 'EniId': 'string' }, 'ImageBuilderErrors': [ { 'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR', 'ErrorMessage': 'string', 'ErrorTimestamp': datetime(2015, 1, 1) }, ], 'AppstreamAgentVersion': 'string', 'AccessEndpoints': [ { 'EndpointType': 'STREAMING', 'VpceId': 'string' }, ], 'LatestAppstreamAgentVersion': 'TRUE'|'FALSE' } }
Response Structure
(dict) --
ImageBuilder (dict) --
Information about the image builder.
Name (string) --
The name of the image builder.
Arn (string) --
The ARN for the image builder.
ImageArn (string) --
The ARN of the image from which this builder was created.
Description (string) --
The description to display.
DisplayName (string) --
The image builder name to display.
VpcConfig (dict) --
The VPC configuration of the image builder.
SubnetIds (list) --
The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.
(string) --
SecurityGroupIds (list) --
The identifiers of the security groups for the fleet or image builder.
(string) --
InstanceType (string) --
The instance type for the image builder. The following instance types are available:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.compute.large
stream.compute.xlarge
stream.compute.2xlarge
stream.compute.4xlarge
stream.compute.8xlarge
stream.memory.large
stream.memory.xlarge
stream.memory.2xlarge
stream.memory.4xlarge
stream.memory.8xlarge
stream.memory.z1d.large
stream.memory.z1d.xlarge
stream.memory.z1d.2xlarge
stream.memory.z1d.3xlarge
stream.memory.z1d.6xlarge
stream.memory.z1d.12xlarge
stream.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge
Platform (string) --
The operating system platform of the image builder.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
State (string) --
The state of the image builder.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
CreatedTime (datetime) --
The time stamp when the image builder was created.
EnableDefaultInternetAccess (boolean) --
Enables or disables default internet access for the image builder.
DomainJoinInfo (dict) --
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
DirectoryName (string) --
The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit for computer accounts.
NetworkAccessConfiguration (dict) --
Describes the network details of the fleet or image builder instance.
EniPrivateIpAddress (string) --
The private IP address of the elastic network interface that is attached to instances in your VPC.
EniId (string) --
The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
ImageBuilderErrors (list) --
The image builder errors.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent that is currently being used by the image builder.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
LatestAppstreamAgentVersion (string) --
Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.
{'ImageBuilders': {'LatestAppstreamAgentVersion': 'TRUE | FALSE'}}
Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.
See also: AWS API Documentation
Request Syntax
client.describe_image_builders( Names=[ 'string', ], MaxResults=123, NextToken='string' )
list
The names of the image builders to describe.
(string) --
integer
The maximum size of each page of results.
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
dict
Response Syntax
{ 'ImageBuilders': [ { 'Name': 'string', 'Arn': 'string', 'ImageArn': 'string', 'Description': 'string', 'DisplayName': 'string', 'VpcConfig': { 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, 'InstanceType': 'string', 'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8', 'IamRoleArn': 'string', 'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION', 'StateChangeReason': { 'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE', 'Message': 'string' }, 'CreatedTime': datetime(2015, 1, 1), 'EnableDefaultInternetAccess': True|False, 'DomainJoinInfo': { 'DirectoryName': 'string', 'OrganizationalUnitDistinguishedName': 'string' }, 'NetworkAccessConfiguration': { 'EniPrivateIpAddress': 'string', 'EniId': 'string' }, 'ImageBuilderErrors': [ { 'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR', 'ErrorMessage': 'string', 'ErrorTimestamp': datetime(2015, 1, 1) }, ], 'AppstreamAgentVersion': 'string', 'AccessEndpoints': [ { 'EndpointType': 'STREAMING', 'VpceId': 'string' }, ], 'LatestAppstreamAgentVersion': 'TRUE'|'FALSE' }, ], 'NextToken': 'string' }
Response Structure
(dict) --
ImageBuilders (list) --
Information about the image builders.
(dict) --
Describes a virtual machine that is used to create an image.
Name (string) --
The name of the image builder.
Arn (string) --
The ARN for the image builder.
ImageArn (string) --
The ARN of the image from which this builder was created.
Description (string) --
The description to display.
DisplayName (string) --
The image builder name to display.
VpcConfig (dict) --
The VPC configuration of the image builder.
SubnetIds (list) --
The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.
(string) --
SecurityGroupIds (list) --
The identifiers of the security groups for the fleet or image builder.
(string) --
InstanceType (string) --
The instance type for the image builder. The following instance types are available:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.compute.large
stream.compute.xlarge
stream.compute.2xlarge
stream.compute.4xlarge
stream.compute.8xlarge
stream.memory.large
stream.memory.xlarge
stream.memory.2xlarge
stream.memory.4xlarge
stream.memory.8xlarge
stream.memory.z1d.large
stream.memory.z1d.xlarge
stream.memory.z1d.2xlarge
stream.memory.z1d.3xlarge
stream.memory.z1d.6xlarge
stream.memory.z1d.12xlarge
stream.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge
Platform (string) --
The operating system platform of the image builder.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
State (string) --
The state of the image builder.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
CreatedTime (datetime) --
The time stamp when the image builder was created.
EnableDefaultInternetAccess (boolean) --
Enables or disables default internet access for the image builder.
DomainJoinInfo (dict) --
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
DirectoryName (string) --
The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit for computer accounts.
NetworkAccessConfiguration (dict) --
Describes the network details of the fleet or image builder instance.
EniPrivateIpAddress (string) --
The private IP address of the elastic network interface that is attached to instances in your VPC.
EniId (string) --
The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
ImageBuilderErrors (list) --
The image builder errors.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent that is currently being used by the image builder.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
LatestAppstreamAgentVersion (string) --
Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'Images': {'DynamicAppProvidersEnabled': 'ENABLED | DISABLED', 'ImageSharedWithOthers': 'TRUE | FALSE', 'LatestAppstreamAgentVersion': 'TRUE | FALSE', 'SupportedInstanceFamilies': ['string']}}
Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.
See also: AWS API Documentation
Request Syntax
client.describe_images( Names=[ 'string', ], Arns=[ 'string', ], Type='PUBLIC'|'PRIVATE'|'SHARED', NextToken='string', MaxResults=123 )
list
The names of the public or private images to describe.
(string) --
list
The ARNs of the public, private, and shared images to describe.
(string) --
string
The type of image (public, private, or shared) to describe.
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
integer
The maximum size of each page of results.
dict
Response Syntax
{ 'Images': [ { 'Name': 'string', 'Arn': 'string', 'BaseImageArn': 'string', 'DisplayName': 'string', 'State': 'PENDING'|'AVAILABLE'|'FAILED'|'COPYING'|'DELETING'|'CREATING'|'IMPORTING', 'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED', 'ImageBuilderSupported': True|False, 'ImageBuilderName': 'string', 'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8', 'Description': 'string', 'StateChangeReason': { 'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE', 'Message': 'string' }, 'Applications': [ { 'Name': 'string', 'DisplayName': 'string', 'IconURL': 'string', 'LaunchPath': 'string', 'LaunchParameters': 'string', 'Enabled': True|False, 'Metadata': { 'string': 'string' }, 'WorkingDirectory': 'string', 'Description': 'string', 'Arn': 'string', 'AppBlockArn': 'string', 'IconS3Location': { 'S3Bucket': 'string', 'S3Key': 'string' }, 'Platforms': [ 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8', ], 'InstanceFamilies': [ 'string', ], 'CreatedTime': datetime(2015, 1, 1) }, ], 'CreatedTime': datetime(2015, 1, 1), 'PublicBaseImageReleasedDate': datetime(2015, 1, 1), 'AppstreamAgentVersion': 'string', 'ImagePermissions': { 'allowFleet': True|False, 'allowImageBuilder': True|False }, 'ImageErrors': [ { 'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR', 'ErrorMessage': 'string', 'ErrorTimestamp': datetime(2015, 1, 1) }, ], 'LatestAppstreamAgentVersion': 'TRUE'|'FALSE', 'SupportedInstanceFamilies': [ 'string', ], 'DynamicAppProvidersEnabled': 'ENABLED'|'DISABLED', 'ImageSharedWithOthers': 'TRUE'|'FALSE' }, ], 'NextToken': 'string' }
Response Structure
(dict) --
Images (list) --
Information about the images.
(dict) --
Describes an image.
Name (string) --
The name of the image.
Arn (string) --
The ARN of the image.
BaseImageArn (string) --
The ARN of the image from which this image was created.
DisplayName (string) --
The image name to display.
State (string) --
The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE . If image creation fails, the state is FAILED .
Visibility (string) --
Indicates whether the image is public or private.
ImageBuilderSupported (boolean) --
Indicates whether an image builder can be launched from this image.
ImageBuilderName (string) --
The name of the image builder that was used to create the private image. If the image is shared, this value is null.
Platform (string) --
The operating system platform of the image.
Description (string) --
The description to display.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
Applications (list) --
The applications associated with the image.
(dict) --
Describes an application in the application catalog.
Name (string) --
The name of the application.
DisplayName (string) --
The application name to display.
IconURL (string) --
The URL for the application icon. This URL might be time-limited.
LaunchPath (string) --
The path to the application executable in the instance.
LaunchParameters (string) --
The arguments that are passed to the application at launch.
Enabled (boolean) --
If there is a problem, the application can be disabled after image creation.
Metadata (dict) --
Additional attributes that describe the application.
(string) --
(string) --
WorkingDirectory (string) --
The working directory for the application.
Description (string) --
The description of the application.
Arn (string) --
The ARN of the application.
AppBlockArn (string) --
The app block ARN of the application.
IconS3Location (dict) --
The S3 location of the application icon.
S3Bucket (string) --
The S3 bucket of the S3 object.
S3Key (string) --
The S3 key of the S3 object.
This is required when used for the following:
IconS3Location (Actions: CreateApplication and UpdateApplication)
SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)
ScriptDetails (Actions: CreateAppBlock)
SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)
SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)
Platforms (list) --
The platforms on which the application can run.
(string) --
InstanceFamilies (list) --
The instance families for the application.
(string) --
CreatedTime (datetime) --
The time at which the application was created within the app block.
CreatedTime (datetime) --
The time the image was created.
PublicBaseImageReleasedDate (datetime) --
The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
ImagePermissions (dict) --
The permissions to provide to the destination AWS account for the specified image.
allowFleet (boolean) --
Indicates whether the image can be used for a fleet.
allowImageBuilder (boolean) --
Indicates whether the image can be used for an image builder.
ImageErrors (list) --
Describes the errors that are returned when a new image can't be created.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
LatestAppstreamAgentVersion (string) --
Indicates whether the image is using the latest AppStream 2.0 agent version or not.
SupportedInstanceFamilies (list) --
The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder. The following instances families are supported:
General Purpose
Compute Optimized
Memory Optimized
Graphics
Graphics Design
Graphics Pro
Graphics G4
Graphics G5
(string) --
DynamicAppProvidersEnabled (string) --
Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.
ImageSharedWithOthers (string) --
Indicates whether the image is shared with another account ID.
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'ImageBuilder': {'LatestAppstreamAgentVersion': 'TRUE | FALSE'}}
Starts the specified image builder.
See also: AWS API Documentation
Request Syntax
client.start_image_builder( Name='string', AppstreamAgentVersion='string' )
string
[REQUIRED]
The name of the image builder.
string
The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
dict
Response Syntax
{ 'ImageBuilder': { 'Name': 'string', 'Arn': 'string', 'ImageArn': 'string', 'Description': 'string', 'DisplayName': 'string', 'VpcConfig': { 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, 'InstanceType': 'string', 'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8', 'IamRoleArn': 'string', 'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION', 'StateChangeReason': { 'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE', 'Message': 'string' }, 'CreatedTime': datetime(2015, 1, 1), 'EnableDefaultInternetAccess': True|False, 'DomainJoinInfo': { 'DirectoryName': 'string', 'OrganizationalUnitDistinguishedName': 'string' }, 'NetworkAccessConfiguration': { 'EniPrivateIpAddress': 'string', 'EniId': 'string' }, 'ImageBuilderErrors': [ { 'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR', 'ErrorMessage': 'string', 'ErrorTimestamp': datetime(2015, 1, 1) }, ], 'AppstreamAgentVersion': 'string', 'AccessEndpoints': [ { 'EndpointType': 'STREAMING', 'VpceId': 'string' }, ], 'LatestAppstreamAgentVersion': 'TRUE'|'FALSE' } }
Response Structure
(dict) --
ImageBuilder (dict) --
Information about the image builder.
Name (string) --
The name of the image builder.
Arn (string) --
The ARN for the image builder.
ImageArn (string) --
The ARN of the image from which this builder was created.
Description (string) --
The description to display.
DisplayName (string) --
The image builder name to display.
VpcConfig (dict) --
The VPC configuration of the image builder.
SubnetIds (list) --
The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.
(string) --
SecurityGroupIds (list) --
The identifiers of the security groups for the fleet or image builder.
(string) --
InstanceType (string) --
The instance type for the image builder. The following instance types are available:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.compute.large
stream.compute.xlarge
stream.compute.2xlarge
stream.compute.4xlarge
stream.compute.8xlarge
stream.memory.large
stream.memory.xlarge
stream.memory.2xlarge
stream.memory.4xlarge
stream.memory.8xlarge
stream.memory.z1d.large
stream.memory.z1d.xlarge
stream.memory.z1d.2xlarge
stream.memory.z1d.3xlarge
stream.memory.z1d.6xlarge
stream.memory.z1d.12xlarge
stream.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge
Platform (string) --
The operating system platform of the image builder.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
State (string) --
The state of the image builder.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
CreatedTime (datetime) --
The time stamp when the image builder was created.
EnableDefaultInternetAccess (boolean) --
Enables or disables default internet access for the image builder.
DomainJoinInfo (dict) --
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
DirectoryName (string) --
The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit for computer accounts.
NetworkAccessConfiguration (dict) --
Describes the network details of the fleet or image builder instance.
EniPrivateIpAddress (string) --
The private IP address of the elastic network interface that is attached to instances in your VPC.
EniId (string) --
The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
ImageBuilderErrors (list) --
The image builder errors.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent that is currently being used by the image builder.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
LatestAppstreamAgentVersion (string) --
Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.
{'ImageBuilder': {'LatestAppstreamAgentVersion': 'TRUE | FALSE'}}
Stops the specified image builder.
See also: AWS API Documentation
Request Syntax
client.stop_image_builder( Name='string' )
string
[REQUIRED]
The name of the image builder.
dict
Response Syntax
{ 'ImageBuilder': { 'Name': 'string', 'Arn': 'string', 'ImageArn': 'string', 'Description': 'string', 'DisplayName': 'string', 'VpcConfig': { 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, 'InstanceType': 'string', 'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8', 'IamRoleArn': 'string', 'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION', 'StateChangeReason': { 'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE', 'Message': 'string' }, 'CreatedTime': datetime(2015, 1, 1), 'EnableDefaultInternetAccess': True|False, 'DomainJoinInfo': { 'DirectoryName': 'string', 'OrganizationalUnitDistinguishedName': 'string' }, 'NetworkAccessConfiguration': { 'EniPrivateIpAddress': 'string', 'EniId': 'string' }, 'ImageBuilderErrors': [ { 'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR', 'ErrorMessage': 'string', 'ErrorTimestamp': datetime(2015, 1, 1) }, ], 'AppstreamAgentVersion': 'string', 'AccessEndpoints': [ { 'EndpointType': 'STREAMING', 'VpceId': 'string' }, ], 'LatestAppstreamAgentVersion': 'TRUE'|'FALSE' } }
Response Structure
(dict) --
ImageBuilder (dict) --
Information about the image builder.
Name (string) --
The name of the image builder.
Arn (string) --
The ARN for the image builder.
ImageArn (string) --
The ARN of the image from which this builder was created.
Description (string) --
The description to display.
DisplayName (string) --
The image builder name to display.
VpcConfig (dict) --
The VPC configuration of the image builder.
SubnetIds (list) --
The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.
(string) --
SecurityGroupIds (list) --
The identifiers of the security groups for the fleet or image builder.
(string) --
InstanceType (string) --
The instance type for the image builder. The following instance types are available:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.compute.large
stream.compute.xlarge
stream.compute.2xlarge
stream.compute.4xlarge
stream.compute.8xlarge
stream.memory.large
stream.memory.xlarge
stream.memory.2xlarge
stream.memory.4xlarge
stream.memory.8xlarge
stream.memory.z1d.large
stream.memory.z1d.xlarge
stream.memory.z1d.2xlarge
stream.memory.z1d.3xlarge
stream.memory.z1d.6xlarge
stream.memory.z1d.12xlarge
stream.graphics-design.large
stream.graphics-design.xlarge
stream.graphics-design.2xlarge
stream.graphics-design.4xlarge
stream.graphics-desktop.2xlarge
stream.graphics.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics-pro.4xlarge
stream.graphics-pro.8xlarge
stream.graphics-pro.16xlarge
Platform (string) --
The operating system platform of the image builder.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
State (string) --
The state of the image builder.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
CreatedTime (datetime) --
The time stamp when the image builder was created.
EnableDefaultInternetAccess (boolean) --
Enables or disables default internet access for the image builder.
DomainJoinInfo (dict) --
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
DirectoryName (string) --
The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit for computer accounts.
NetworkAccessConfiguration (dict) --
Describes the network details of the fleet or image builder instance.
EniPrivateIpAddress (string) --
The private IP address of the elastic network interface that is attached to instances in your VPC.
EniId (string) --
The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
ImageBuilderErrors (list) --
The image builder errors.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent that is currently being used by the image builder.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
LatestAppstreamAgentVersion (string) --
Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.