2025/11/17 - Amazon AppStream - 4 new 16 updated api methods
Changes Adding support for additional instances and extended storage
Creates a custom WorkSpaces Applications image by importing an EC2 AMI. This allows you to use your own customized AMI to create WorkSpaces Applications images that support additional instance types beyond the standard stream.* instances.
See also: AWS API Documentation
Request Syntax
client.create_imported_image(
Name='string',
SourceAmiId='string',
IamRoleArn='string',
Description='string',
DisplayName='string',
Tags={
'string': 'string'
},
RuntimeValidationConfig={
'IntendedInstanceType': 'string'
},
AgentSoftwareVersion='CURRENT_LATEST'|'ALWAYS_LATEST',
AppCatalogConfig=[
{
'Name': 'string',
'DisplayName': 'string',
'AbsoluteAppPath': 'string',
'AbsoluteIconPath': 'string',
'AbsoluteManifestPath': 'string',
'WorkingDirectory': 'string',
'LaunchParameters': 'string'
},
],
DryRun=True|False
)
string
[REQUIRED]
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.
string
[REQUIRED]
The ID of the EC2 AMI to import. The AMI must meet specific requirements including Windows Server 2022 Full Base, UEFI boot mode, TPM 2.0 support, and proper drivers.
string
[REQUIRED]
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.
string
An optional description for the imported image. The description must match approved regex patterns and can be up to 256 characters.
string
An optional display name for the imported image. The display name must match approved regex patterns and can be up to 100 characters.
dict
The tags to apply to the imported image. Tags help you organize and manage your WorkSpaces Applications resources.
(string) --
(string) --
dict
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.
IntendedInstanceType (string) --
The instance type to use for runtime validation testing. It's recommended to use the same instance type you plan to use for your fleet to ensure accurate validation results.
string
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.
list
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.
(dict) --
Configuration for an application in the imported image's application catalog. This structure defines how applications appear and launch for users.
Name (string) -- [REQUIRED]
The name of the application. This is a required field that must be unique within the application catalog and between 1-100 characters, matching the pattern ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,99}$.
DisplayName (string) --
The display name shown to users for this application. This field is optional and can be 0-100 characters, matching the pattern ^[a-zA-Z0-9][a-zA-Z0-9_. -]{0,99}$.
AbsoluteAppPath (string) -- [REQUIRED]
The absolute path to the executable file that launches the application. This is a required field that can be 1-32767 characters to support Windows extended file paths. Use escaped file path strings like "C:\\Windows\\System32\\notepad.exe".
AbsoluteIconPath (string) --
The absolute path to the icon file for the application. This field is optional and can be 1-32767 characters. If not provided, the icon is derived from the executable. Use PNG images with proper transparency for the best user experience.
AbsoluteManifestPath (string) --
The absolute path to the prewarm manifest file for this application. This field is optional and only applicable when using application-specific manifests. The path can be 1-32767 characters and should point to a text file containing file paths to prewarm.
WorkingDirectory (string) --
The working directory to use when launching the application. This field is optional and can be 0-32767 characters. Use escaped file path strings like "C:\\Path\\To\\Working\\Directory".
LaunchParameters (string) --
The launch parameters to pass to the application executable. This field is optional and can be 0-1024 characters. Use escaped strings with the full list of required parameters, such as PowerShell script paths or command-line arguments.
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.
dict
Response Syntax
{
'Image': {
'Name': 'string',
'Arn': 'string',
'BaseImageArn': 'string',
'DisplayName': 'string',
'State': 'PENDING'|'AVAILABLE'|'FAILED'|'COPYING'|'DELETING'|'CREATING'|'IMPORTING'|'VALIDATING',
'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
'ImageBuilderSupported': True|False,
'ImageBuilderName': 'string',
'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8'|'ROCKY_LINUX8',
'Description': 'string',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE'|'IMAGE_UPDATE_FAILURE'|'IMAGE_IMPORT_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'|'ROCKY_LINUX8',
],
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'LatestAppstreamAgentVersion': 'TRUE'|'FALSE',
'SupportedInstanceFamilies': [
'string',
],
'DynamicAppProvidersEnabled': 'ENABLED'|'DISABLED',
'ImageSharedWithOthers': 'TRUE'|'FALSE',
'ManagedSoftwareIncluded': True|False,
'ImageType': 'CUSTOM'|'NATIVE'
}
}
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, copied, or updated by using Managed Image Updates, 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 WorkSpaces Applications 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 WorkSpaces Applications 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 WorkSpaces Applications image or not.
ImageSharedWithOthers (string) --
Indicates whether the image is shared with another account ID.
ManagedSoftwareIncluded (boolean) --
Indicates whether the image includes license-included applications.
ImageType (string) --
The type of the image. Images created through AMI import have type "custom", while WorkSpaces Applications provided images have type "native". Custom images support additional instance types including GeneralPurpose, MemoryOptimized, ComputeOptimized, and Accelerated instance families.
Retrieves information about an export image task, including its current state, progress, and any error details.
See also: AWS API Documentation
Request Syntax
client.get_export_image_task(
TaskId='string'
)
string
The unique identifier of the export image task to retrieve information about.
dict
Response Syntax
{
'ExportImageTask': {
'TaskId': 'string',
'ImageArn': 'string',
'AmiName': 'string',
'CreatedDate': datetime(2015, 1, 1),
'AmiDescription': 'string',
'State': 'EXPORTING'|'COMPLETED'|'FAILED',
'AmiId': 'string',
'TagSpecifications': {
'string': 'string'
},
'ErrorDetails': [
{
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
}
Response Structure
(dict) --
ExportImageTask (dict) --
Information about the export image task, including its current state, created date, and any error details.
TaskId (string) --
The unique identifier for the export image task. Use this ID to track the task's progress and retrieve its details.
ImageArn (string) --
The ARN of the WorkSpaces Applications image being exported.
AmiName (string) --
The name of the EC2 AMI that will be created by this export task.
CreatedDate (datetime) --
The date and time when the export image task was created.
AmiDescription (string) --
The description that will be applied to the exported EC2 AMI.
State (string) --
The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.
AmiId (string) --
The ID of the EC2 AMI that was created by this export task. This field is only populated when the task completes successfully.
TagSpecifications (dict) --
The tags that will be applied to the exported EC2 AMI.
(string) --
(string) --
ErrorDetails (list) --
Details about any errors that occurred during the export process. This field is only populated when the task fails.
(dict) --
The error details.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Lists export image tasks, with optional filtering and pagination. Use this operation to monitor the status of multiple export operations.
See also: AWS API Documentation
Request Syntax
client.list_export_image_tasks(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
list
Optional filters to apply when listing export image tasks. Filters help you narrow down the results based on specific criteria.
(dict) --
A filter for narrowing down the results when listing export image tasks. Filters allow you to specify criteria such as task state or creation date.
Name (string) -- [REQUIRED]
The name of the filter. Valid filter names depend on the operation being performed.
Values (list) -- [REQUIRED]
The values for the filter. Multiple values can be specified for a single filter name.
(string) --
integer
The maximum number of export image tasks to return in a single request. The valid range is 1-500, with a default of 50.
string
The pagination token from a previous request. Use this to retrieve the next page of results when there are more tasks than the MaxResults limit.
dict
Response Syntax
{
'ExportImageTasks': [
{
'TaskId': 'string',
'ImageArn': 'string',
'AmiName': 'string',
'CreatedDate': datetime(2015, 1, 1),
'AmiDescription': 'string',
'State': 'EXPORTING'|'COMPLETED'|'FAILED',
'AmiId': 'string',
'TagSpecifications': {
'string': 'string'
},
'ErrorDetails': [
{
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ExportImageTasks (list) --
The list of export image tasks that match the specified criteria.
(dict) --
Information about an export image task, including its current state, timestamps, and any error details.
TaskId (string) --
The unique identifier for the export image task. Use this ID to track the task's progress and retrieve its details.
ImageArn (string) --
The ARN of the WorkSpaces Applications image being exported.
AmiName (string) --
The name of the EC2 AMI that will be created by this export task.
CreatedDate (datetime) --
The date and time when the export image task was created.
AmiDescription (string) --
The description that will be applied to the exported EC2 AMI.
State (string) --
The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.
AmiId (string) --
The ID of the EC2 AMI that was created by this export task. This field is only populated when the task completes successfully.
TagSpecifications (dict) --
The tags that will be applied to the exported EC2 AMI.
(string) --
(string) --
ErrorDetails (list) --
Details about any errors that occurred during the export process. This field is only populated when the task fails.
(dict) --
The error details.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
NextToken (string) --
The pagination token to use for retrieving the next page of results. This field is only present when there are more results available.
Creates a task to export a WorkSpaces Applications image to an EC2 AMI. This allows you to use your customized WorkSpaces Applications images with other AWS services or for backup purposes.
See also: AWS API Documentation
Request Syntax
client.create_export_image_task(
ImageName='string',
AmiName='string',
IamRoleArn='string',
TagSpecifications={
'string': 'string'
},
AmiDescription='string'
)
string
[REQUIRED]
The name of the WorkSpaces Applications image to export. The image must be in an available state and owned by your account.
string
[REQUIRED]
The name for the exported EC2 AMI. This is a required field that must be unique within your account and region.
string
[REQUIRED]
The ARN of the IAM role that allows WorkSpaces Applications to create the AMI. The role must have permissions to copy images, describe images, and create tags, with a trust relationship allowing appstream.amazonaws.com to assume the role.
dict
The tags to apply to the exported AMI. These tags help you organize and manage your EC2 AMIs.
(string) --
(string) --
string
An optional description for the exported AMI. This description will be applied to the resulting EC2 AMI.
dict
Response Syntax
{
'ExportImageTask': {
'TaskId': 'string',
'ImageArn': 'string',
'AmiName': 'string',
'CreatedDate': datetime(2015, 1, 1),
'AmiDescription': 'string',
'State': 'EXPORTING'|'COMPLETED'|'FAILED',
'AmiId': 'string',
'TagSpecifications': {
'string': 'string'
},
'ErrorDetails': [
{
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
}
Response Structure
(dict) --
ExportImageTask (dict) --
Information about the export image task that was created, including the task ID and initial state.
TaskId (string) --
The unique identifier for the export image task. Use this ID to track the task's progress and retrieve its details.
ImageArn (string) --
The ARN of the WorkSpaces Applications image being exported.
AmiName (string) --
The name of the EC2 AMI that will be created by this export task.
CreatedDate (datetime) --
The date and time when the export image task was created.
AmiDescription (string) --
The description that will be applied to the exported EC2 AMI.
State (string) --
The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.
AmiId (string) --
The ID of the EC2 AMI that was created by this export task. This field is only populated when the task completes successfully.
TagSpecifications (dict) --
The tags that will be applied to the exported EC2 AMI.
(string) --
(string) --
ErrorDetails (list) --
Details about any errors that occurred during the export process. This field is only populated when the task fails.
(dict) --
The error details.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
{'AppBlockBuilder': {'AppBlockBuilderErrors': {'ErrorCode': {'VALIDATION_ERROR'}}}}
Creates an app block builder.
See also: AWS API Documentation
Request Syntax
client.create_app_block_builder(
Name='string',
Description='string',
DisplayName='string',
Tags={
'string': 'string'
},
Platform='WINDOWS_SERVER_2019',
InstanceType='string',
VpcConfig={
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
EnableDefaultInternetAccess=True|False,
IamRoleArn='string',
AccessEndpoints=[
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
]
)
string
[REQUIRED]
The unique name for the app block builder.
string
The description of the app block builder.
string
The display name of the app block builder.
dict
The tags to associate with the app block 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=.
If you do not specify a value, the value is set to an empty string.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
_ . : / = + - @
For more information, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.
(string) --
(string) --
string
[REQUIRED]
The platform of the app block builder.
WINDOWS_SERVER_2019 is the only valid value.
string
[REQUIRED]
The instance type to use when launching the app block builder. The following instance types are available:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge
dict
[REQUIRED]
The VPC configuration for the app block builder.
App block builders require that you specify at least two subnets in different availability zones.
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) --
boolean
Enables or disables default internet access for the app block builder.
string
The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block 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. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
list
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block 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 WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications 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
{
'AppBlockBuilder': {
'Arn': 'string',
'Name': 'string',
'DisplayName': 'string',
'Description': 'string',
'Platform': 'WINDOWS_SERVER_2019',
'InstanceType': 'string',
'EnableDefaultInternetAccess': True|False,
'IamRoleArn': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
'CreatedTime': datetime(2015, 1, 1),
'AppBlockBuilderErrors': [
{
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'StateChangeReason': {
'Code': 'INTERNAL_ERROR',
'Message': 'string'
},
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
]
}
}
Response Structure
(dict) --
AppBlockBuilder (dict) --
Describes an app block builder.
Arn (string) --
The ARN of the app block builder.
Name (string) --
The name of the app block builder.
DisplayName (string) --
The display name of the app block builder.
Description (string) --
The description of the app block builder.
Platform (string) --
The platform of the app block builder.
WINDOWS_SERVER_2019 is the only valid value.
InstanceType (string) --
The instance type of the app block builder.
EnableDefaultInternetAccess (boolean) --
Indicates whether default internet access is enabled for the app block builder.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the app block builder.
VpcConfig (dict) --
The VPC configuration for the app block 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) --
State (string) --
The state of the app block builder.
CreatedTime (datetime) --
The creation time of the app block builder.
AppBlockBuilderErrors (list) --
The app block builder errors.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
StateChangeReason (dict) --
The state change reason.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
AccessEndpoints (list) --
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block 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 WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications 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.
{'RootVolumeConfig': {'VolumeSizeInGb': 'integer'}}
Response {'Fleet': {'FleetErrors': {'ErrorCode': {'VALIDATION_ERROR'}},
'RootVolumeConfig': {'VolumeSizeInGb': 'integer'}}}
Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
See also: AWS API Documentation
Request Syntax
client.create_fleet(
Name='string',
ImageName='string',
ImageArn='string',
InstanceType='string',
FleetType='ALWAYS_ON'|'ON_DEMAND'|'ELASTIC',
ComputeCapacity={
'DesiredInstances': 123,
'DesiredSessions': 123
},
VpcConfig={
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
MaxUserDurationInSeconds=123,
DisconnectTimeoutInSeconds=123,
Description='string',
DisplayName='string',
EnableDefaultInternetAccess=True|False,
DomainJoinInfo={
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
Tags={
'string': 'string'
},
IdleDisconnectTimeoutInSeconds=123,
IamRoleArn='string',
StreamView='APP'|'DESKTOP',
Platform='WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8'|'ROCKY_LINUX8',
MaxConcurrentSessions=123,
UsbDeviceFilterStrings=[
'string',
],
SessionScriptS3Location={
'S3Bucket': 'string',
'S3Key': 'string'
},
MaxSessionsPerInstance=123,
RootVolumeConfig={
'VolumeSizeInGb': 123
}
)
string
[REQUIRED]
A unique name for the fleet.
string
The name of the image used to create the fleet.
string
The ARN of the public, private, or shared image to use.
string
[REQUIRED]
The instance type to use when launching fleet instances. The following instance types are available:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge
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.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics.g5.xlarge
stream.graphics.g5.2xlarge
stream.graphics.g5.4xlarge
stream.graphics.g5.8xlarge
stream.graphics.g5.12xlarge
stream.graphics.g5.16xlarge
stream.graphics.g5.24xlarge
stream.graphics.g6.xlarge
stream.graphics.g6.2xlarge
stream.graphics.g6.4xlarge
stream.graphics.g6.8xlarge
stream.graphics.g6.16xlarge
stream.graphics.g6.12xlarge
stream.graphics.g6.24xlarge
stream.graphics.gr6.4xlarge
stream.graphics.gr6.8xlarge
stream.graphics.g6f.large
stream.graphics.g6f.xlarge
stream.graphics.g6f.2xlarge
stream.graphics.g6f.4xlarge
stream.graphics.gr6f.4xlarge
The following instance types are available for Elastic fleets:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge
string
The fleet type.
ALWAYS_ON
Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.
ON_DEMAND
Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
dict
The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
DesiredInstances (integer) --
The desired number of streaming instances.
DesiredSessions (integer) --
The desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.
When you create a fleet, you must set either the DesiredSessions or DesiredInstances attribute, based on the type of fleet you create. You can’t define both attributes or leave both attributes blank.
dict
The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
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) --
integer
The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
Specify a value between 600 and 432000.
integer
The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
Specify a value between 60 and 36000.
string
The description to display.
string
The fleet name to display.
boolean
Enables or disables default internet access for the fleet.
dict
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.
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.
dict
The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
If you do not specify a value, the value is set to an empty string.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
_ . : / = + - @
For more information, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.
(string) --
(string) --
integer
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.
string
The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance 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. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
string
The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
string
The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
integer
The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.
list
The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
(string) --
dict
The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
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)
integer
The maximum number of user sessions on an instance. This only applies to multi-session fleets.
dict
The configuration for the root volume of fleet instances. Use this to customize storage capacity from 200 GB up to 500 GB based on your application requirements.
VolumeSizeInGb (integer) --
The size of the root volume in GB. Valid range is 200-500 GB. The default is 200 GB, which is included in the hourly instance rate. Additional storage beyond 200 GB incurs extra charges and applies to instances regardless of their running state.
dict
Response Syntax
{
'Fleet': {
'Arn': 'string',
'Name': 'string',
'DisplayName': 'string',
'Description': 'string',
'ImageName': 'string',
'ImageArn': 'string',
'InstanceType': 'string',
'FleetType': 'ALWAYS_ON'|'ON_DEMAND'|'ELASTIC',
'ComputeCapacityStatus': {
'Desired': 123,
'Running': 123,
'InUse': 123,
'Available': 123,
'DesiredUserSessions': 123,
'AvailableUserSessions': 123,
'ActiveUserSessions': 123,
'ActualUserSessions': 123
},
'MaxUserDurationInSeconds': 123,
'DisconnectTimeoutInSeconds': 123,
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'CreatedTime': datetime(2015, 1, 1),
'FleetErrors': [
{
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string'
},
],
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
'IdleDisconnectTimeoutInSeconds': 123,
'IamRoleArn': 'string',
'StreamView': 'APP'|'DESKTOP',
'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8'|'ROCKY_LINUX8',
'MaxConcurrentSessions': 123,
'UsbDeviceFilterStrings': [
'string',
],
'SessionScriptS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'MaxSessionsPerInstance': 123,
'RootVolumeConfig': {
'VolumeSizeInGb': 123
}
}
}
Response Structure
(dict) --
Fleet (dict) --
Information about the fleet.
Arn (string) --
The Amazon Resource Name (ARN) for the fleet.
Name (string) --
The name of the fleet.
DisplayName (string) --
The fleet name to display.
Description (string) --
The description to display.
ImageName (string) --
The name of the image used to create the fleet.
ImageArn (string) --
The ARN for the public, private, or shared image.
InstanceType (string) --
The instance type to use when launching fleet instances. 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.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics.g5.xlarge
stream.graphics.g5.2xlarge
stream.graphics.g5.4xlarge
stream.graphics.g5.8xlarge
stream.graphics.g5.16xlarge
stream.graphics.g5.12xlarge
stream.graphics.g5.24xlarge
stream.graphics.g6.xlarge
stream.graphics.g6.2xlarge
stream.graphics.g6.4xlarge
stream.graphics.g6.8xlarge
stream.graphics.g6.16xlarge
stream.graphics.g6.12xlarge
stream.graphics.g6.24xlarge
stream.graphics.gr6.4xlarge
stream.graphics.gr6.8xlarge
stream.graphics.g6f.large
stream.graphics.g6f.xlarge
stream.graphics.g6f.2xlarge
stream.graphics.g6f.4xlarge
stream.graphics.gr6f.4xlarge
FleetType (string) --
The fleet type.
ALWAYS_ON
Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.
ON_DEMAND
Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
ComputeCapacityStatus (dict) --
The capacity status for the fleet.
Desired (integer) --
The desired number of streaming instances.
Running (integer) --
The total number of simultaneous streaming instances that are running.
InUse (integer) --
The number of instances in use for streaming.
Available (integer) --
The number of currently available instances that can be used to stream sessions.
DesiredUserSessions (integer) --
The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.
DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity
This only applies to multi-session fleets.
AvailableUserSessions (integer) --
The number of idle session slots currently available for user sessions.
AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions
This only applies to multi-session fleets.
ActiveUserSessions (integer) --
The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.
ActualUserSessions (integer) --
The total number of session slots that are available for streaming or are currently streaming.
ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions
This only applies to multi-session fleets.
MaxUserDurationInSeconds (integer) --
The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
Specify a value between 600 and 360000.
DisconnectTimeoutInSeconds (integer) --
The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
Specify a value between 60 and 36000.
State (string) --
The current state for the fleet.
VpcConfig (dict) --
The VPC configuration for the fleet.
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) --
CreatedTime (datetime) --
The time the fleet was created.
FleetErrors (list) --
The fleet errors.
(dict) --
Describes a fleet error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
EnableDefaultInternetAccess (boolean) --
Indicates whether default internet access is enabled for the fleet.
DomainJoinInfo (dict) --
The name of the directory and organizational unit (OU) to use to join the fleet 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.
IdleDisconnectTimeoutInSeconds (integer) --
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance 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. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
StreamView (string) --
The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
Platform (string) --
The platform of the fleet.
MaxConcurrentSessions (integer) --
The maximum number of concurrent sessions for the fleet.
UsbDeviceFilterStrings (list) --
The USB device filter strings associated with the fleet.
(string) --
SessionScriptS3Location (dict) --
The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
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)
MaxSessionsPerInstance (integer) --
The maximum number of user sessions on an instance. This only applies to multi-session fleets.
RootVolumeConfig (dict) --
The current configuration of the root volume for fleet instances, including the storage size in GB.
VolumeSizeInGb (integer) --
The size of the root volume in GB. Valid range is 200-500 GB. The default is 200 GB, which is included in the hourly instance rate. Additional storage beyond 200 GB incurs extra charges and applies to instances regardless of their running state.
{'RootVolumeConfig': {'VolumeSizeInGb': 'integer'}}
Response {'ImageBuilder': {'ImageBuilderErrors': {'ErrorCode': {'VALIDATION_ERROR'}},
'RootVolumeConfig': {'VolumeSizeInGb': 'integer'},
'State': {'PENDING_IMAGE_IMPORT'}}}
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'
},
],
RootVolumeConfig={
'VolumeSizeInGb': 123
},
SoftwaresToInstall=[
'string',
],
SoftwaresToUninstall=[
'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.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics.g5.xlarge
stream.graphics.g5.2xlarge
stream.graphics.g5.4xlarge
stream.graphics.g5.8xlarge
stream.graphics.g5.16xlarge
stream.graphics.g5.12xlarge
stream.graphics.g5.24xlarge
stream.graphics.g6.xlarge
stream.graphics.g6.2xlarge
stream.graphics.g6.4xlarge
stream.graphics.g6.8xlarge
stream.graphics.g6.16xlarge
stream.graphics.g6.12xlarge
stream.graphics.g6.24xlarge
stream.graphics.gr6.4xlarge
stream.graphics.gr6.8xlarge
stream.graphics.g6f.large
stream.graphics.g6f.xlarge
stream.graphics.g6f.2xlarge
stream.graphics.g6f.4xlarge
stream.graphics.gr6f.4xlarge
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. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications 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 WorkSpaces Applications agent to use for this image builder. To use the latest version of the WorkSpaces Applications 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 WorkSpaces Applications 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 WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications 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
The configuration for the root volume of the image builder. Use this to customize storage capacity from 200 GB up to 500 GB based on your application installation requirements.
VolumeSizeInGb (integer) --
The size of the root volume in GB. Valid range is 200-500 GB. The default is 200 GB, which is included in the hourly instance rate. Additional storage beyond 200 GB incurs extra charges and applies to instances regardless of their running state.
list
The list of license included applications to install on the image builder during creation.
Possible values include the following:
Microsoft_Office_2021_LTSC_Professional_Plus_32Bit
Microsoft_Office_2021_LTSC_Professional_Plus_64Bit
Microsoft_Office_2024_LTSC_Professional_Plus_32Bit
Microsoft_Office_2024_LTSC_Professional_Plus_64Bit
Microsoft_Visio_2021_LTSC_Professional_32Bit
Microsoft_Visio_2021_LTSC_Professional_64Bit
Microsoft_Visio_2024_LTSC_Professional_32Bit
Microsoft_Visio_2024_LTSC_Professional_64Bit
Microsoft_Project_2021_Professional_32Bit
Microsoft_Project_2021_Professional_64Bit
Microsoft_Project_2024_Professional_32Bit
Microsoft_Project_2024_Professional_64Bit
Microsoft_Office_2021_LTSC_Standard_32Bit
Microsoft_Office_2021_LTSC_Standard_64Bit
Microsoft_Office_2024_LTSC_Standard_32Bit
Microsoft_Office_2024_LTSC_Standard_64Bit
Microsoft_Visio_2021_LTSC_Standard_32Bit
Microsoft_Visio_2021_LTSC_Standard_64Bit
Microsoft_Visio_2024_LTSC_Standard_32Bit
Microsoft_Visio_2024_LTSC_Standard_64Bit
Microsoft_Project_2021_Standard_32Bit
Microsoft_Project_2021_Standard_64Bit
Microsoft_Project_2024_Standard_32Bit
Microsoft_Project_2024_Standard_64Bit
(string) --
list
The list of license included applications to uninstall from the image builder during creation.
Possible values include the following:
Microsoft_Office_2021_LTSC_Professional_Plus_32Bit
Microsoft_Office_2021_LTSC_Professional_Plus_64Bit
Microsoft_Office_2024_LTSC_Professional_Plus_32Bit
Microsoft_Office_2024_LTSC_Professional_Plus_64Bit
Microsoft_Visio_2021_LTSC_Professional_32Bit
Microsoft_Visio_2021_LTSC_Professional_64Bit
Microsoft_Visio_2024_LTSC_Professional_32Bit
Microsoft_Visio_2024_LTSC_Professional_64Bit
Microsoft_Project_2021_Professional_32Bit
Microsoft_Project_2021_Professional_64Bit
Microsoft_Project_2024_Professional_32Bit
Microsoft_Project_2024_Professional_64Bit
Microsoft_Office_2021_LTSC_Standard_32Bit
Microsoft_Office_2021_LTSC_Standard_64Bit
Microsoft_Office_2024_LTSC_Standard_32Bit
Microsoft_Office_2024_LTSC_Standard_64Bit
Microsoft_Visio_2021_LTSC_Standard_32Bit
Microsoft_Visio_2021_LTSC_Standard_64Bit
Microsoft_Visio_2024_LTSC_Standard_32Bit
Microsoft_Visio_2024_LTSC_Standard_64Bit
Microsoft_Project_2021_Standard_32Bit
Microsoft_Project_2021_Standard_64Bit
Microsoft_Project_2024_Standard_32Bit
Microsoft_Project_2024_Standard_64Bit
(string) --
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'|'ROCKY_LINUX8',
'IamRoleArn': 'string',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION'|'PENDING_SYNCING_APPS'|'SYNCING_APPS'|'PENDING_IMAGE_IMPORT',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
'NetworkAccessConfiguration': {
'EniPrivateIpAddress': 'string',
'EniIpv6Addresses': [
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'AppstreamAgentVersion': 'string',
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
'RootVolumeConfig': {
'VolumeSizeInGb': 123
},
'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.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics.g5.xlarge
stream.graphics.g5.2xlarge
stream.graphics.g5.4xlarge
stream.graphics.g5.8xlarge
stream.graphics.g5.16xlarge
stream.graphics.g5.12xlarge
stream.graphics.g5.24xlarge
stream.graphics.g6.xlarge
stream.graphics.g6.2xlarge
stream.graphics.g6.4xlarge
stream.graphics.g6.8xlarge
stream.graphics.g6.16xlarge
stream.graphics.g6.12xlarge
stream.graphics.g6.24xlarge
stream.graphics.gr6.4xlarge
stream.graphics.gr6.8xlarge
stream.graphics.g6f.large
stream.graphics.g6f.xlarge
stream.graphics.g6f.2xlarge
stream.graphics.g6f.4xlarge
stream.graphics.gr6f.4xlarge
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. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications 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.
EniIpv6Addresses (list) --
The IPv6 addresses assigned to the elastic network interface. This field supports IPv6 connectivity for WorkSpaces Applications instances.
(string) --
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 WorkSpaces Applications 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 WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications 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.
RootVolumeConfig (dict) --
The current configuration of the root volume for the image builder, including the storage size in GB.
VolumeSizeInGb (integer) --
The size of the root volume in GB. Valid range is 200-500 GB. The default is 200 GB, which is included in the hourly instance rate. Additional storage beyond 200 GB incurs extra charges and applies to instances regardless of their running state.
LatestAppstreamAgentVersion (string) --
Indicates whether the image builder is using the latest WorkSpaces Applications agent version or not.
{'image': {'ImageErrors': {'ErrorCode': {'VALIDATION_ERROR'}},
'ImageType': 'CUSTOM | NATIVE',
'State': {'VALIDATING'},
'StateChangeReason': {'Code': {'IMAGE_IMPORT_FAILURE',
'IMAGE_UPDATE_FAILURE'}}}}
Creates a new image with the latest Windows operating system updates, driver updates, and WorkSpaces Applications agent software.
For more information, see the "Update an Image by Using Managed WorkSpaces Applications Image Updates" section in Administer Your WorkSpaces Applications Images, in the Amazon WorkSpaces Applications 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 WorkSpaces Applications Administration Guide.
(string) --
(string) --
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.
dict
Response Syntax
{
'image': {
'Name': 'string',
'Arn': 'string',
'BaseImageArn': 'string',
'DisplayName': 'string',
'State': 'PENDING'|'AVAILABLE'|'FAILED'|'COPYING'|'DELETING'|'CREATING'|'IMPORTING'|'VALIDATING',
'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
'ImageBuilderSupported': True|False,
'ImageBuilderName': 'string',
'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8'|'ROCKY_LINUX8',
'Description': 'string',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE'|'IMAGE_UPDATE_FAILURE'|'IMAGE_IMPORT_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'|'ROCKY_LINUX8',
],
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'LatestAppstreamAgentVersion': 'TRUE'|'FALSE',
'SupportedInstanceFamilies': [
'string',
],
'DynamicAppProvidersEnabled': 'ENABLED'|'DISABLED',
'ImageSharedWithOthers': 'TRUE'|'FALSE',
'ManagedSoftwareIncluded': True|False,
'ImageType': 'CUSTOM'|'NATIVE'
},
'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, copied, or updated by using Managed Image Updates, 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 WorkSpaces Applications 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 WorkSpaces Applications 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 WorkSpaces Applications image or not.
ImageSharedWithOthers (string) --
Indicates whether the image is shared with another account ID.
ManagedSoftwareIncluded (boolean) --
Indicates whether the image includes license-included applications.
ImageType (string) --
The type of the image. Images created through AMI import have type "custom", while WorkSpaces Applications provided images have type "native". Custom images support additional instance types including GeneralPurpose, MemoryOptimized, ComputeOptimized, and Accelerated instance families.
canUpdateImage (boolean) --
Indicates whether a new image can be created.
{'Image': {'ImageErrors': {'ErrorCode': {'VALIDATION_ERROR'}},
'ImageType': 'CUSTOM | NATIVE',
'State': {'VALIDATING'},
'StateChangeReason': {'Code': {'IMAGE_IMPORT_FAILURE',
'IMAGE_UPDATE_FAILURE'}}}}
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'|'VALIDATING',
'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
'ImageBuilderSupported': True|False,
'ImageBuilderName': 'string',
'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8'|'ROCKY_LINUX8',
'Description': 'string',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE'|'IMAGE_UPDATE_FAILURE'|'IMAGE_IMPORT_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'|'ROCKY_LINUX8',
],
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'LatestAppstreamAgentVersion': 'TRUE'|'FALSE',
'SupportedInstanceFamilies': [
'string',
],
'DynamicAppProvidersEnabled': 'ENABLED'|'DISABLED',
'ImageSharedWithOthers': 'TRUE'|'FALSE',
'ManagedSoftwareIncluded': True|False,
'ImageType': 'CUSTOM'|'NATIVE'
}
}
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, copied, or updated by using Managed Image Updates, 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 WorkSpaces Applications 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 WorkSpaces Applications 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 WorkSpaces Applications image or not.
ImageSharedWithOthers (string) --
Indicates whether the image is shared with another account ID.
ManagedSoftwareIncluded (boolean) --
Indicates whether the image includes license-included applications.
ImageType (string) --
The type of the image. Images created through AMI import have type "custom", while WorkSpaces Applications provided images have type "native". Custom images support additional instance types including GeneralPurpose, MemoryOptimized, ComputeOptimized, and Accelerated instance families.
{'ImageBuilder': {'ImageBuilderErrors': {'ErrorCode': {'VALIDATION_ERROR'}},
'RootVolumeConfig': {'VolumeSizeInGb': 'integer'},
'State': {'PENDING_IMAGE_IMPORT'}}}
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'|'ROCKY_LINUX8',
'IamRoleArn': 'string',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION'|'PENDING_SYNCING_APPS'|'SYNCING_APPS'|'PENDING_IMAGE_IMPORT',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
'NetworkAccessConfiguration': {
'EniPrivateIpAddress': 'string',
'EniIpv6Addresses': [
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'AppstreamAgentVersion': 'string',
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
'RootVolumeConfig': {
'VolumeSizeInGb': 123
},
'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.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics.g5.xlarge
stream.graphics.g5.2xlarge
stream.graphics.g5.4xlarge
stream.graphics.g5.8xlarge
stream.graphics.g5.16xlarge
stream.graphics.g5.12xlarge
stream.graphics.g5.24xlarge
stream.graphics.g6.xlarge
stream.graphics.g6.2xlarge
stream.graphics.g6.4xlarge
stream.graphics.g6.8xlarge
stream.graphics.g6.16xlarge
stream.graphics.g6.12xlarge
stream.graphics.g6.24xlarge
stream.graphics.gr6.4xlarge
stream.graphics.gr6.8xlarge
stream.graphics.g6f.large
stream.graphics.g6f.xlarge
stream.graphics.g6f.2xlarge
stream.graphics.g6f.4xlarge
stream.graphics.gr6f.4xlarge
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. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications 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.
EniIpv6Addresses (list) --
The IPv6 addresses assigned to the elastic network interface. This field supports IPv6 connectivity for WorkSpaces Applications instances.
(string) --
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 WorkSpaces Applications 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 WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications 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.
RootVolumeConfig (dict) --
The current configuration of the root volume for the image builder, including the storage size in GB.
VolumeSizeInGb (integer) --
The size of the root volume in GB. Valid range is 200-500 GB. The default is 200 GB, which is included in the hourly instance rate. Additional storage beyond 200 GB incurs extra charges and applies to instances regardless of their running state.
LatestAppstreamAgentVersion (string) --
Indicates whether the image builder is using the latest WorkSpaces Applications agent version or not.
{'AppBlockBuilders': {'AppBlockBuilderErrors': {'ErrorCode': {'VALIDATION_ERROR'}}}}
Retrieves a list that describes one or more app block builders.
See also: AWS API Documentation
Request Syntax
client.describe_app_block_builders(
Names=[
'string',
],
NextToken='string',
MaxResults=123
)
list
The names of the app block builders.
(string) --
string
The pagination token used to retrieve the next page of results for this operation.
integer
The maximum size of each page of results. The maximum value is 25.
dict
Response Syntax
{
'AppBlockBuilders': [
{
'Arn': 'string',
'Name': 'string',
'DisplayName': 'string',
'Description': 'string',
'Platform': 'WINDOWS_SERVER_2019',
'InstanceType': 'string',
'EnableDefaultInternetAccess': True|False,
'IamRoleArn': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
'CreatedTime': datetime(2015, 1, 1),
'AppBlockBuilderErrors': [
{
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'StateChangeReason': {
'Code': 'INTERNAL_ERROR',
'Message': 'string'
},
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AppBlockBuilders (list) --
The list that describes one or more app block builders.
(dict) --
Describes an app block builder.
Arn (string) --
The ARN of the app block builder.
Name (string) --
The name of the app block builder.
DisplayName (string) --
The display name of the app block builder.
Description (string) --
The description of the app block builder.
Platform (string) --
The platform of the app block builder.
WINDOWS_SERVER_2019 is the only valid value.
InstanceType (string) --
The instance type of the app block builder.
EnableDefaultInternetAccess (boolean) --
Indicates whether default internet access is enabled for the app block builder.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the app block builder.
VpcConfig (dict) --
The VPC configuration for the app block 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) --
State (string) --
The state of the app block builder.
CreatedTime (datetime) --
The creation time of the app block builder.
AppBlockBuilderErrors (list) --
The app block builder errors.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
StateChangeReason (dict) --
The state change reason.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
AccessEndpoints (list) --
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block 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 WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications 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.
NextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
{'Fleets': {'FleetErrors': {'ErrorCode': {'VALIDATION_ERROR'}},
'RootVolumeConfig': {'VolumeSizeInGb': 'integer'}}}
Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
See also: AWS API Documentation
Request Syntax
client.describe_fleets(
Names=[
'string',
],
NextToken='string'
)
list
The names of the fleets to describe.
(string) --
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
{
'Fleets': [
{
'Arn': 'string',
'Name': 'string',
'DisplayName': 'string',
'Description': 'string',
'ImageName': 'string',
'ImageArn': 'string',
'InstanceType': 'string',
'FleetType': 'ALWAYS_ON'|'ON_DEMAND'|'ELASTIC',
'ComputeCapacityStatus': {
'Desired': 123,
'Running': 123,
'InUse': 123,
'Available': 123,
'DesiredUserSessions': 123,
'AvailableUserSessions': 123,
'ActiveUserSessions': 123,
'ActualUserSessions': 123
},
'MaxUserDurationInSeconds': 123,
'DisconnectTimeoutInSeconds': 123,
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'CreatedTime': datetime(2015, 1, 1),
'FleetErrors': [
{
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string'
},
],
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
'IdleDisconnectTimeoutInSeconds': 123,
'IamRoleArn': 'string',
'StreamView': 'APP'|'DESKTOP',
'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8'|'ROCKY_LINUX8',
'MaxConcurrentSessions': 123,
'UsbDeviceFilterStrings': [
'string',
],
'SessionScriptS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'MaxSessionsPerInstance': 123,
'RootVolumeConfig': {
'VolumeSizeInGb': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Fleets (list) --
Information about the fleets.
(dict) --
Describes a fleet.
Arn (string) --
The Amazon Resource Name (ARN) for the fleet.
Name (string) --
The name of the fleet.
DisplayName (string) --
The fleet name to display.
Description (string) --
The description to display.
ImageName (string) --
The name of the image used to create the fleet.
ImageArn (string) --
The ARN for the public, private, or shared image.
InstanceType (string) --
The instance type to use when launching fleet instances. 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.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics.g5.xlarge
stream.graphics.g5.2xlarge
stream.graphics.g5.4xlarge
stream.graphics.g5.8xlarge
stream.graphics.g5.16xlarge
stream.graphics.g5.12xlarge
stream.graphics.g5.24xlarge
stream.graphics.g6.xlarge
stream.graphics.g6.2xlarge
stream.graphics.g6.4xlarge
stream.graphics.g6.8xlarge
stream.graphics.g6.16xlarge
stream.graphics.g6.12xlarge
stream.graphics.g6.24xlarge
stream.graphics.gr6.4xlarge
stream.graphics.gr6.8xlarge
stream.graphics.g6f.large
stream.graphics.g6f.xlarge
stream.graphics.g6f.2xlarge
stream.graphics.g6f.4xlarge
stream.graphics.gr6f.4xlarge
FleetType (string) --
The fleet type.
ALWAYS_ON
Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.
ON_DEMAND
Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
ComputeCapacityStatus (dict) --
The capacity status for the fleet.
Desired (integer) --
The desired number of streaming instances.
Running (integer) --
The total number of simultaneous streaming instances that are running.
InUse (integer) --
The number of instances in use for streaming.
Available (integer) --
The number of currently available instances that can be used to stream sessions.
DesiredUserSessions (integer) --
The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.
DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity
This only applies to multi-session fleets.
AvailableUserSessions (integer) --
The number of idle session slots currently available for user sessions.
AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions
This only applies to multi-session fleets.
ActiveUserSessions (integer) --
The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.
ActualUserSessions (integer) --
The total number of session slots that are available for streaming or are currently streaming.
ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions
This only applies to multi-session fleets.
MaxUserDurationInSeconds (integer) --
The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
Specify a value between 600 and 360000.
DisconnectTimeoutInSeconds (integer) --
The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
Specify a value between 60 and 36000.
State (string) --
The current state for the fleet.
VpcConfig (dict) --
The VPC configuration for the fleet.
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) --
CreatedTime (datetime) --
The time the fleet was created.
FleetErrors (list) --
The fleet errors.
(dict) --
Describes a fleet error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
EnableDefaultInternetAccess (boolean) --
Indicates whether default internet access is enabled for the fleet.
DomainJoinInfo (dict) --
The name of the directory and organizational unit (OU) to use to join the fleet 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.
IdleDisconnectTimeoutInSeconds (integer) --
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance 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. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
StreamView (string) --
The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
Platform (string) --
The platform of the fleet.
MaxConcurrentSessions (integer) --
The maximum number of concurrent sessions for the fleet.
UsbDeviceFilterStrings (list) --
The USB device filter strings associated with the fleet.
(string) --
SessionScriptS3Location (dict) --
The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
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)
MaxSessionsPerInstance (integer) --
The maximum number of user sessions on an instance. This only applies to multi-session fleets.
RootVolumeConfig (dict) --
The current configuration of the root volume for fleet instances, including the storage size in GB.
VolumeSizeInGb (integer) --
The size of the root volume in GB. Valid range is 200-500 GB. The default is 200 GB, which is included in the hourly instance rate. Additional storage beyond 200 GB incurs extra charges and applies to instances regardless of their running state.
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.
{'ImageBuilders': {'ImageBuilderErrors': {'ErrorCode': {'VALIDATION_ERROR'}},
'RootVolumeConfig': {'VolumeSizeInGb': 'integer'},
'State': {'PENDING_IMAGE_IMPORT'}}}
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'|'ROCKY_LINUX8',
'IamRoleArn': 'string',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION'|'PENDING_SYNCING_APPS'|'SYNCING_APPS'|'PENDING_IMAGE_IMPORT',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
'NetworkAccessConfiguration': {
'EniPrivateIpAddress': 'string',
'EniIpv6Addresses': [
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'AppstreamAgentVersion': 'string',
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
'RootVolumeConfig': {
'VolumeSizeInGb': 123
},
'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.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics.g5.xlarge
stream.graphics.g5.2xlarge
stream.graphics.g5.4xlarge
stream.graphics.g5.8xlarge
stream.graphics.g5.16xlarge
stream.graphics.g5.12xlarge
stream.graphics.g5.24xlarge
stream.graphics.g6.xlarge
stream.graphics.g6.2xlarge
stream.graphics.g6.4xlarge
stream.graphics.g6.8xlarge
stream.graphics.g6.16xlarge
stream.graphics.g6.12xlarge
stream.graphics.g6.24xlarge
stream.graphics.gr6.4xlarge
stream.graphics.gr6.8xlarge
stream.graphics.g6f.large
stream.graphics.g6f.xlarge
stream.graphics.g6f.2xlarge
stream.graphics.g6f.4xlarge
stream.graphics.gr6f.4xlarge
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. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications 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.
EniIpv6Addresses (list) --
The IPv6 addresses assigned to the elastic network interface. This field supports IPv6 connectivity for WorkSpaces Applications instances.
(string) --
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 WorkSpaces Applications 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 WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications 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.
RootVolumeConfig (dict) --
The current configuration of the root volume for the image builder, including the storage size in GB.
VolumeSizeInGb (integer) --
The size of the root volume in GB. Valid range is 200-500 GB. The default is 200 GB, which is included in the hourly instance rate. Additional storage beyond 200 GB incurs extra charges and applies to instances regardless of their running state.
LatestAppstreamAgentVersion (string) --
Indicates whether the image builder is using the latest WorkSpaces Applications 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': {'ImageErrors': {'ErrorCode': {'VALIDATION_ERROR'}},
'ImageType': 'CUSTOM | NATIVE',
'State': {'VALIDATING'},
'StateChangeReason': {'Code': {'IMAGE_IMPORT_FAILURE',
'IMAGE_UPDATE_FAILURE'}}}}
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'|'VALIDATING',
'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
'ImageBuilderSupported': True|False,
'ImageBuilderName': 'string',
'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8'|'ROCKY_LINUX8',
'Description': 'string',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE'|'IMAGE_UPDATE_FAILURE'|'IMAGE_IMPORT_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'|'ROCKY_LINUX8',
],
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'LatestAppstreamAgentVersion': 'TRUE'|'FALSE',
'SupportedInstanceFamilies': [
'string',
],
'DynamicAppProvidersEnabled': 'ENABLED'|'DISABLED',
'ImageSharedWithOthers': 'TRUE'|'FALSE',
'ManagedSoftwareIncluded': True|False,
'ImageType': 'CUSTOM'|'NATIVE'
},
],
'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, copied, or updated by using Managed Image Updates, 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 WorkSpaces Applications 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 WorkSpaces Applications 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 WorkSpaces Applications image or not.
ImageSharedWithOthers (string) --
Indicates whether the image is shared with another account ID.
ManagedSoftwareIncluded (boolean) --
Indicates whether the image includes license-included applications.
ImageType (string) --
The type of the image. Images created through AMI import have type "custom", while WorkSpaces Applications provided images have type "native". Custom images support additional instance types including GeneralPurpose, MemoryOptimized, ComputeOptimized, and Accelerated instance families.
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.
{'AppBlockBuilder': {'AppBlockBuilderErrors': {'ErrorCode': {'VALIDATION_ERROR'}}}}
Starts an app block builder.
An app block builder can only be started when it's associated with an app block.
Starting an app block builder starts a new instance, which is equivalent to an elastic fleet instance with application builder assistance functionality.
See also: AWS API Documentation
Request Syntax
client.start_app_block_builder(
Name='string'
)
string
[REQUIRED]
The name of the app block builder.
dict
Response Syntax
{
'AppBlockBuilder': {
'Arn': 'string',
'Name': 'string',
'DisplayName': 'string',
'Description': 'string',
'Platform': 'WINDOWS_SERVER_2019',
'InstanceType': 'string',
'EnableDefaultInternetAccess': True|False,
'IamRoleArn': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
'CreatedTime': datetime(2015, 1, 1),
'AppBlockBuilderErrors': [
{
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'StateChangeReason': {
'Code': 'INTERNAL_ERROR',
'Message': 'string'
},
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
]
}
}
Response Structure
(dict) --
AppBlockBuilder (dict) --
Describes an app block builder.
Arn (string) --
The ARN of the app block builder.
Name (string) --
The name of the app block builder.
DisplayName (string) --
The display name of the app block builder.
Description (string) --
The description of the app block builder.
Platform (string) --
The platform of the app block builder.
WINDOWS_SERVER_2019 is the only valid value.
InstanceType (string) --
The instance type of the app block builder.
EnableDefaultInternetAccess (boolean) --
Indicates whether default internet access is enabled for the app block builder.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the app block builder.
VpcConfig (dict) --
The VPC configuration for the app block 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) --
State (string) --
The state of the app block builder.
CreatedTime (datetime) --
The creation time of the app block builder.
AppBlockBuilderErrors (list) --
The app block builder errors.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
StateChangeReason (dict) --
The state change reason.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
AccessEndpoints (list) --
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block 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 WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications 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.
{'ImageBuilder': {'ImageBuilderErrors': {'ErrorCode': {'VALIDATION_ERROR'}},
'RootVolumeConfig': {'VolumeSizeInGb': 'integer'},
'State': {'PENDING_IMAGE_IMPORT'}}}
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 WorkSpaces Applications agent to use for this image builder. To use the latest version of the WorkSpaces Applications 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'|'ROCKY_LINUX8',
'IamRoleArn': 'string',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION'|'PENDING_SYNCING_APPS'|'SYNCING_APPS'|'PENDING_IMAGE_IMPORT',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
'NetworkAccessConfiguration': {
'EniPrivateIpAddress': 'string',
'EniIpv6Addresses': [
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'AppstreamAgentVersion': 'string',
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
'RootVolumeConfig': {
'VolumeSizeInGb': 123
},
'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.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics.g5.xlarge
stream.graphics.g5.2xlarge
stream.graphics.g5.4xlarge
stream.graphics.g5.8xlarge
stream.graphics.g5.16xlarge
stream.graphics.g5.12xlarge
stream.graphics.g5.24xlarge
stream.graphics.g6.xlarge
stream.graphics.g6.2xlarge
stream.graphics.g6.4xlarge
stream.graphics.g6.8xlarge
stream.graphics.g6.16xlarge
stream.graphics.g6.12xlarge
stream.graphics.g6.24xlarge
stream.graphics.gr6.4xlarge
stream.graphics.gr6.8xlarge
stream.graphics.g6f.large
stream.graphics.g6f.xlarge
stream.graphics.g6f.2xlarge
stream.graphics.g6f.4xlarge
stream.graphics.gr6f.4xlarge
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. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications 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.
EniIpv6Addresses (list) --
The IPv6 addresses assigned to the elastic network interface. This field supports IPv6 connectivity for WorkSpaces Applications instances.
(string) --
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 WorkSpaces Applications 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 WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications 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.
RootVolumeConfig (dict) --
The current configuration of the root volume for the image builder, including the storage size in GB.
VolumeSizeInGb (integer) --
The size of the root volume in GB. Valid range is 200-500 GB. The default is 200 GB, which is included in the hourly instance rate. Additional storage beyond 200 GB incurs extra charges and applies to instances regardless of their running state.
LatestAppstreamAgentVersion (string) --
Indicates whether the image builder is using the latest WorkSpaces Applications agent version or not.
{'AppBlockBuilder': {'AppBlockBuilderErrors': {'ErrorCode': {'VALIDATION_ERROR'}}}}
Stops an app block builder.
Stopping an app block builder terminates the instance, and the instance state is not persisted.
See also: AWS API Documentation
Request Syntax
client.stop_app_block_builder(
Name='string'
)
string
[REQUIRED]
The name of the app block builder.
dict
Response Syntax
{
'AppBlockBuilder': {
'Arn': 'string',
'Name': 'string',
'DisplayName': 'string',
'Description': 'string',
'Platform': 'WINDOWS_SERVER_2019',
'InstanceType': 'string',
'EnableDefaultInternetAccess': True|False,
'IamRoleArn': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
'CreatedTime': datetime(2015, 1, 1),
'AppBlockBuilderErrors': [
{
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'StateChangeReason': {
'Code': 'INTERNAL_ERROR',
'Message': 'string'
},
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
]
}
}
Response Structure
(dict) --
AppBlockBuilder (dict) --
Describes an app block builder.
Arn (string) --
The ARN of the app block builder.
Name (string) --
The name of the app block builder.
DisplayName (string) --
The display name of the app block builder.
Description (string) --
The description of the app block builder.
Platform (string) --
The platform of the app block builder.
WINDOWS_SERVER_2019 is the only valid value.
InstanceType (string) --
The instance type of the app block builder.
EnableDefaultInternetAccess (boolean) --
Indicates whether default internet access is enabled for the app block builder.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the app block builder.
VpcConfig (dict) --
The VPC configuration for the app block 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) --
State (string) --
The state of the app block builder.
CreatedTime (datetime) --
The creation time of the app block builder.
AppBlockBuilderErrors (list) --
The app block builder errors.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
StateChangeReason (dict) --
The state change reason.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
AccessEndpoints (list) --
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block 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 WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications 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.
{'ImageBuilder': {'ImageBuilderErrors': {'ErrorCode': {'VALIDATION_ERROR'}},
'RootVolumeConfig': {'VolumeSizeInGb': 'integer'},
'State': {'PENDING_IMAGE_IMPORT'}}}
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'|'ROCKY_LINUX8',
'IamRoleArn': 'string',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION'|'PENDING_SYNCING_APPS'|'SYNCING_APPS'|'PENDING_IMAGE_IMPORT',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
'NetworkAccessConfiguration': {
'EniPrivateIpAddress': 'string',
'EniIpv6Addresses': [
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'AppstreamAgentVersion': 'string',
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
'RootVolumeConfig': {
'VolumeSizeInGb': 123
},
'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.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics.g5.xlarge
stream.graphics.g5.2xlarge
stream.graphics.g5.4xlarge
stream.graphics.g5.8xlarge
stream.graphics.g5.16xlarge
stream.graphics.g5.12xlarge
stream.graphics.g5.24xlarge
stream.graphics.g6.xlarge
stream.graphics.g6.2xlarge
stream.graphics.g6.4xlarge
stream.graphics.g6.8xlarge
stream.graphics.g6.16xlarge
stream.graphics.g6.12xlarge
stream.graphics.g6.24xlarge
stream.graphics.gr6.4xlarge
stream.graphics.gr6.8xlarge
stream.graphics.g6f.large
stream.graphics.g6f.xlarge
stream.graphics.g6f.2xlarge
stream.graphics.g6f.4xlarge
stream.graphics.gr6f.4xlarge
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. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications 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.
EniIpv6Addresses (list) --
The IPv6 addresses assigned to the elastic network interface. This field supports IPv6 connectivity for WorkSpaces Applications instances.
(string) --
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 WorkSpaces Applications 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 WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications 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.
RootVolumeConfig (dict) --
The current configuration of the root volume for the image builder, including the storage size in GB.
VolumeSizeInGb (integer) --
The size of the root volume in GB. Valid range is 200-500 GB. The default is 200 GB, which is included in the hourly instance rate. Additional storage beyond 200 GB incurs extra charges and applies to instances regardless of their running state.
LatestAppstreamAgentVersion (string) --
Indicates whether the image builder is using the latest WorkSpaces Applications agent version or not.
{'AppBlockBuilder': {'AppBlockBuilderErrors': {'ErrorCode': {'VALIDATION_ERROR'}}}}
Updates an app block builder.
If the app block builder is in the STARTING or STOPPING state, you can't update it. If the app block builder is in the RUNNING state, you can only update the DisplayName and Description. If the app block builder is in the STOPPED state, you can update any attribute except the Name.
See also: AWS API Documentation
Request Syntax
client.update_app_block_builder(
Name='string',
Description='string',
DisplayName='string',
Platform='WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8'|'ROCKY_LINUX8',
InstanceType='string',
VpcConfig={
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
EnableDefaultInternetAccess=True|False,
IamRoleArn='string',
AccessEndpoints=[
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
AttributesToDelete=[
'IAM_ROLE_ARN'|'ACCESS_ENDPOINTS'|'VPC_CONFIGURATION_SECURITY_GROUP_IDS',
]
)
string
[REQUIRED]
The unique name for the app block builder.
string
The description of the app block builder.
string
The display name of the app block builder.
string
The platform of the app block builder.
WINDOWS_SERVER_2019 is the only valid value.
string
The instance type to use when launching the app block builder. The following instance types are available:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge
dict
The VPC configuration for the app block builder.
App block builders require that you specify at least two subnets in different availability zones.
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) --
boolean
Enables or disables default internet access for the app block builder.
string
The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block 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. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
list
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block 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 WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications 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.
list
The attributes to delete from the app block builder.
(string) --
dict
Response Syntax
{
'AppBlockBuilder': {
'Arn': 'string',
'Name': 'string',
'DisplayName': 'string',
'Description': 'string',
'Platform': 'WINDOWS_SERVER_2019',
'InstanceType': 'string',
'EnableDefaultInternetAccess': True|False,
'IamRoleArn': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
'CreatedTime': datetime(2015, 1, 1),
'AppBlockBuilderErrors': [
{
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'StateChangeReason': {
'Code': 'INTERNAL_ERROR',
'Message': 'string'
},
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
]
}
}
Response Structure
(dict) --
AppBlockBuilder (dict) --
Describes an app block builder.
Arn (string) --
The ARN of the app block builder.
Name (string) --
The name of the app block builder.
DisplayName (string) --
The display name of the app block builder.
Description (string) --
The description of the app block builder.
Platform (string) --
The platform of the app block builder.
WINDOWS_SERVER_2019 is the only valid value.
InstanceType (string) --
The instance type of the app block builder.
EnableDefaultInternetAccess (boolean) --
Indicates whether default internet access is enabled for the app block builder.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the app block builder.
VpcConfig (dict) --
The VPC configuration for the app block 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) --
State (string) --
The state of the app block builder.
CreatedTime (datetime) --
The creation time of the app block builder.
AppBlockBuilderErrors (list) --
The app block builder errors.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
StateChangeReason (dict) --
The state change reason.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
AccessEndpoints (list) --
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block 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 WorkSpaces Applications. When you specify an interface endpoint for a stack, users of the stack can connect to WorkSpaces Applications 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.
{'AttributesToDelete': {'VOLUME_CONFIGURATION'},
'RootVolumeConfig': {'VolumeSizeInGb': 'integer'}}
Response {'Fleet': {'FleetErrors': {'ErrorCode': {'VALIDATION_ERROR'}},
'RootVolumeConfig': {'VolumeSizeInGb': 'integer'}}}
Updates the specified fleet.
If the fleet is in the STOPPED state, you can update any attribute except the fleet name.
If the fleet is in the RUNNING state, you can update the following based on the fleet type:
Always-On and On-Demand fleet types You can update the DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes.
Elastic fleet type You can update the DisplayName, IdleDisconnectTimeoutInSeconds, DisconnectTimeoutInSeconds, MaxConcurrentSessions, SessionScriptS3Location and UsbDeviceFilterStrings attributes.
If the fleet is in the STARTING or STOPPED state, you can't update it.
See also: AWS API Documentation
Request Syntax
client.update_fleet(
ImageName='string',
ImageArn='string',
Name='string',
InstanceType='string',
ComputeCapacity={
'DesiredInstances': 123,
'DesiredSessions': 123
},
VpcConfig={
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
MaxUserDurationInSeconds=123,
DisconnectTimeoutInSeconds=123,
DeleteVpcConfig=True|False,
Description='string',
DisplayName='string',
EnableDefaultInternetAccess=True|False,
DomainJoinInfo={
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
IdleDisconnectTimeoutInSeconds=123,
AttributesToDelete=[
'VPC_CONFIGURATION'|'VPC_CONFIGURATION_SECURITY_GROUP_IDS'|'DOMAIN_JOIN_INFO'|'IAM_ROLE_ARN'|'USB_DEVICE_FILTER_STRINGS'|'SESSION_SCRIPT_S3_LOCATION'|'MAX_SESSIONS_PER_INSTANCE'|'VOLUME_CONFIGURATION',
],
IamRoleArn='string',
StreamView='APP'|'DESKTOP',
Platform='WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8'|'ROCKY_LINUX8',
MaxConcurrentSessions=123,
UsbDeviceFilterStrings=[
'string',
],
SessionScriptS3Location={
'S3Bucket': 'string',
'S3Key': 'string'
},
MaxSessionsPerInstance=123,
RootVolumeConfig={
'VolumeSizeInGb': 123
}
)
string
The name of the image used to create the fleet.
string
The ARN of the public, private, or shared image to use.
string
A unique name for the fleet.
string
The instance type to use when launching fleet instances. The following instance types are available:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge
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.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics.g5.xlarge
stream.graphics.g5.2xlarge
stream.graphics.g5.4xlarge
stream.graphics.g5.8xlarge
stream.graphics.g5.16xlarge
stream.graphics.g5.12xlarge
stream.graphics.g5.24xlarge
stream.graphics.g6.xlarge
stream.graphics.g6.2xlarge
stream.graphics.g6.4xlarge
stream.graphics.g6.8xlarge
stream.graphics.g6.16xlarge
stream.graphics.g6.12xlarge
stream.graphics.g6.24xlarge
stream.graphics.gr6.4xlarge
stream.graphics.gr6.8xlarge
stream.graphics.g6f.large
stream.graphics.g6f.xlarge
stream.graphics.g6f.2xlarge
stream.graphics.g6f.4xlarge
stream.graphics.gr6f.4xlarge
The following instance types are available for Elastic fleets:
stream.standard.small
stream.standard.medium
stream.standard.large
stream.standard.xlarge
stream.standard.2xlarge
dict
The desired capacity for the fleet. This is not allowed for Elastic fleets.
DesiredInstances (integer) --
The desired number of streaming instances.
DesiredSessions (integer) --
The desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.
When you create a fleet, you must set either the DesiredSessions or DesiredInstances attribute, based on the type of fleet you create. You can’t define both attributes or leave both attributes blank.
dict
The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
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) --
integer
The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
Specify a value between 600 and 432000.
integer
The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
Specify a value between 60 and 36000.
boolean
Deletes the VPC association for the specified fleet.
string
The description to display.
string
The fleet name to display.
boolean
Enables or disables default internet access for the fleet.
dict
The name of the directory and organizational unit (OU) to use to join the fleet 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.
integer
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.
list
The fleet attributes to delete.
(string) --
The fleet attribute.
string
The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance 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. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
string
The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
string
The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
integer
The maximum number of concurrent sessions for a fleet.
list
The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
(string) --
dict
The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
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)
integer
The maximum number of user sessions on an instance. This only applies to multi-session fleets.
dict
The updated configuration for the root volume of fleet instances. Note that volume size cannot be decreased below the image volume size.
VolumeSizeInGb (integer) --
The size of the root volume in GB. Valid range is 200-500 GB. The default is 200 GB, which is included in the hourly instance rate. Additional storage beyond 200 GB incurs extra charges and applies to instances regardless of their running state.
dict
Response Syntax
{
'Fleet': {
'Arn': 'string',
'Name': 'string',
'DisplayName': 'string',
'Description': 'string',
'ImageName': 'string',
'ImageArn': 'string',
'InstanceType': 'string',
'FleetType': 'ALWAYS_ON'|'ON_DEMAND'|'ELASTIC',
'ComputeCapacityStatus': {
'Desired': 123,
'Running': 123,
'InUse': 123,
'Available': 123,
'DesiredUserSessions': 123,
'AvailableUserSessions': 123,
'ActiveUserSessions': 123,
'ActualUserSessions': 123
},
'MaxUserDurationInSeconds': 123,
'DisconnectTimeoutInSeconds': 123,
'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'CreatedTime': datetime(2015, 1, 1),
'FleetErrors': [
{
'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'|'VALIDATION_ERROR',
'ErrorMessage': 'string'
},
],
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
'IdleDisconnectTimeoutInSeconds': 123,
'IamRoleArn': 'string',
'StreamView': 'APP'|'DESKTOP',
'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'AMAZON_LINUX2'|'RHEL8'|'ROCKY_LINUX8',
'MaxConcurrentSessions': 123,
'UsbDeviceFilterStrings': [
'string',
],
'SessionScriptS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'MaxSessionsPerInstance': 123,
'RootVolumeConfig': {
'VolumeSizeInGb': 123
}
}
}
Response Structure
(dict) --
Fleet (dict) --
Information about the fleet.
Arn (string) --
The Amazon Resource Name (ARN) for the fleet.
Name (string) --
The name of the fleet.
DisplayName (string) --
The fleet name to display.
Description (string) --
The description to display.
ImageName (string) --
The name of the image used to create the fleet.
ImageArn (string) --
The ARN for the public, private, or shared image.
InstanceType (string) --
The instance type to use when launching fleet instances. 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.g4dn.xlarge
stream.graphics.g4dn.2xlarge
stream.graphics.g4dn.4xlarge
stream.graphics.g4dn.8xlarge
stream.graphics.g4dn.12xlarge
stream.graphics.g4dn.16xlarge
stream.graphics.g5.xlarge
stream.graphics.g5.2xlarge
stream.graphics.g5.4xlarge
stream.graphics.g5.8xlarge
stream.graphics.g5.16xlarge
stream.graphics.g5.12xlarge
stream.graphics.g5.24xlarge
stream.graphics.g6.xlarge
stream.graphics.g6.2xlarge
stream.graphics.g6.4xlarge
stream.graphics.g6.8xlarge
stream.graphics.g6.16xlarge
stream.graphics.g6.12xlarge
stream.graphics.g6.24xlarge
stream.graphics.gr6.4xlarge
stream.graphics.gr6.8xlarge
stream.graphics.g6f.large
stream.graphics.g6f.xlarge
stream.graphics.g6f.2xlarge
stream.graphics.g6f.4xlarge
stream.graphics.gr6f.4xlarge
FleetType (string) --
The fleet type.
ALWAYS_ON
Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.
ON_DEMAND
Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
ComputeCapacityStatus (dict) --
The capacity status for the fleet.
Desired (integer) --
The desired number of streaming instances.
Running (integer) --
The total number of simultaneous streaming instances that are running.
InUse (integer) --
The number of instances in use for streaming.
Available (integer) --
The number of currently available instances that can be used to stream sessions.
DesiredUserSessions (integer) --
The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.
DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity
This only applies to multi-session fleets.
AvailableUserSessions (integer) --
The number of idle session slots currently available for user sessions.
AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions
This only applies to multi-session fleets.
ActiveUserSessions (integer) --
The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.
ActualUserSessions (integer) --
The total number of session slots that are available for streaming or are currently streaming.
ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions
This only applies to multi-session fleets.
MaxUserDurationInSeconds (integer) --
The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
Specify a value between 600 and 360000.
DisconnectTimeoutInSeconds (integer) --
The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
Specify a value between 60 and 36000.
State (string) --
The current state for the fleet.
VpcConfig (dict) --
The VPC configuration for the fleet.
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) --
CreatedTime (datetime) --
The time the fleet was created.
FleetErrors (list) --
The fleet errors.
(dict) --
Describes a fleet error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
EnableDefaultInternetAccess (boolean) --
Indicates whether default internet access is enabled for the fleet.
DomainJoinInfo (dict) --
The name of the directory and organizational unit (OU) to use to join the fleet 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.
IdleDisconnectTimeoutInSeconds (integer) --
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance 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. WorkSpaces Applications 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 WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
StreamView (string) --
The WorkSpaces Applications view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
Platform (string) --
The platform of the fleet.
MaxConcurrentSessions (integer) --
The maximum number of concurrent sessions for the fleet.
UsbDeviceFilterStrings (list) --
The USB device filter strings associated with the fleet.
(string) --
SessionScriptS3Location (dict) --
The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
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)
MaxSessionsPerInstance (integer) --
The maximum number of user sessions on an instance. This only applies to multi-session fleets.
RootVolumeConfig (dict) --
The current configuration of the root volume for fleet instances, including the storage size in GB.
VolumeSizeInGb (integer) --
The size of the root volume in GB. Valid range is 200-500 GB. The default is 200 GB, which is included in the hourly instance rate. Additional storage beyond 200 GB incurs extra charges and applies to instances regardless of their running state.