Table of Contents
AppStream.Client¶A low-level client representing Amazon AppStream
This is the Amazon AppStream 2.0 API Reference . This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.
Note
You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide .
To learn more about AppStream 2.0, see the following resources:
import boto3
client = boto3.client('appstream')
These are the available methods:
associate_application_fleet()associate_application_to_entitlement()associate_fleet()batch_associate_user_stack()batch_disassociate_user_stack()can_paginate()close()copy_image()create_app_block()create_application()create_directory_config()create_entitlement()create_fleet()create_image_builder()create_image_builder_streaming_url()create_stack()create_streaming_url()create_updated_image()create_usage_report_subscription()create_user()delete_app_block()delete_application()delete_directory_config()delete_entitlement()delete_fleet()delete_image()delete_image_builder()delete_image_permissions()delete_stack()delete_usage_report_subscription()delete_user()describe_app_blocks()describe_application_fleet_associations()describe_applications()describe_directory_configs()describe_entitlements()describe_fleets()describe_image_builders()describe_image_permissions()describe_images()describe_sessions()describe_stacks()describe_usage_report_subscriptions()describe_user_stack_associations()describe_users()disable_user()disassociate_application_fleet()disassociate_application_from_entitlement()disassociate_fleet()enable_user()expire_session()get_paginator()get_waiter()list_associated_fleets()list_associated_stacks()list_entitled_applications()list_tags_for_resource()start_fleet()start_image_builder()stop_fleet()stop_image_builder()tag_resource()untag_resource()update_application()update_directory_config()update_entitlement()update_fleet()update_image_permissions()update_stack()associate_application_fleet(**kwargs)¶Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
See also: AWS API Documentation
Request Syntax
response = client.associate_application_fleet(
FleetName='string',
ApplicationArn='string'
)
[REQUIRED]
The name of the fleet.
[REQUIRED]
The ARN of the application.
dict
Response Syntax
{
'ApplicationFleetAssociation': {
'FleetName': 'string',
'ApplicationArn': 'string'
}
}
Response Structure
(dict) --
ApplicationFleetAssociation (dict) --
If fleet name is specified, this returns the list of applications that are associated to it. If application ARN is specified, this returns the list of fleets to which it is associated.
FleetName (string) --
The name of the fleet associated with the application.
ApplicationArn (string) --
The ARN of the application associated with the fleet.
Exceptions
AppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.InvalidParameterCombinationExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionassociate_application_to_entitlement(**kwargs)¶Associates an application to entitle.
See also: AWS API Documentation
Request Syntax
response = client.associate_application_to_entitlement(
StackName='string',
EntitlementName='string',
ApplicationIdentifier='string'
)
[REQUIRED]
The name of the stack.
[REQUIRED]
The name of the entitlement.
[REQUIRED]
The identifier of the application.
dict
Response Syntax
{}
Response Structure
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.EntitlementNotFoundExceptionAppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionassociate_fleet(**kwargs)¶Associates the specified fleet with the specified stack.
See also: AWS API Documentation
Request Syntax
response = client.associate_fleet(
FleetName='string',
StackName='string'
)
[REQUIRED]
The name of the fleet.
[REQUIRED]
The name of the stack.
dict
Response Syntax
{}
Response Structure
Exceptions
AppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.IncompatibleImageExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionbatch_associate_user_stack(**kwargs)¶Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.
See also: AWS API Documentation
Request Syntax
response = client.batch_associate_user_stack(
UserStackAssociations=[
{
'StackName': 'string',
'UserName': 'string',
'AuthenticationType': 'API'|'SAML'|'USERPOOL'|'AWS_AD',
'SendEmailNotification': True|False
},
]
)
[REQUIRED]
The list of UserStackAssociation objects.
Describes a user in the user pool and the associated stack.
The name of the stack that is associated with the user.
The email address of the user who is associated with the stack.
Note
Users' email addresses are case-sensitive.
The authentication type for the user.
Specifies whether a welcome email is sent to a user after the user is created in the user pool.
{
'errors': [
{
'UserStackAssociation': {
'StackName': 'string',
'UserName': 'string',
'AuthenticationType': 'API'|'SAML'|'USERPOOL'|'AWS_AD',
'SendEmailNotification': True|False
},
'ErrorCode': 'STACK_NOT_FOUND'|'USER_NAME_NOT_FOUND'|'DIRECTORY_NOT_FOUND'|'INTERNAL_ERROR',
'ErrorMessage': 'string'
},
]
}
Response Structure
The list of UserStackAssociationError objects.
Describes the error that is returned when a user can’t be associated with or disassociated from a stack.
Information about the user and associated stack.
The name of the stack that is associated with the user.
The email address of the user who is associated with the stack.
Note
Users' email addresses are case-sensitive.
The authentication type for the user.
Specifies whether a welcome email is sent to a user after the user is created in the user pool.
The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.
The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.InvalidParameterCombinationExceptionbatch_disassociate_user_stack(**kwargs)¶Disassociates the specified users from the specified stacks.
See also: AWS API Documentation
Request Syntax
response = client.batch_disassociate_user_stack(
UserStackAssociations=[
{
'StackName': 'string',
'UserName': 'string',
'AuthenticationType': 'API'|'SAML'|'USERPOOL'|'AWS_AD',
'SendEmailNotification': True|False
},
]
)
[REQUIRED]
The list of UserStackAssociation objects.
Describes a user in the user pool and the associated stack.
The name of the stack that is associated with the user.
The email address of the user who is associated with the stack.
Note
Users' email addresses are case-sensitive.
The authentication type for the user.
Specifies whether a welcome email is sent to a user after the user is created in the user pool.
{
'errors': [
{
'UserStackAssociation': {
'StackName': 'string',
'UserName': 'string',
'AuthenticationType': 'API'|'SAML'|'USERPOOL'|'AWS_AD',
'SendEmailNotification': True|False
},
'ErrorCode': 'STACK_NOT_FOUND'|'USER_NAME_NOT_FOUND'|'DIRECTORY_NOT_FOUND'|'INTERNAL_ERROR',
'ErrorMessage': 'string'
},
]
}
Response Structure
The list of UserStackAssociationError objects.
Describes the error that is returned when a user can’t be associated with or disassociated from a stack.
Information about the user and associated stack.
The name of the stack that is associated with the user.
The email address of the user who is associated with the stack.
Note
Users' email addresses are case-sensitive.
The authentication type for the user.
Specifies whether a welcome email is sent to a user after the user is created in the user pool.
The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.
The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.InvalidParameterCombinationExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
copy_image(**kwargs)¶Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.
See also: AWS API Documentation
Request Syntax
response = client.copy_image(
SourceImageName='string',
DestinationImageName='string',
DestinationRegion='string',
DestinationImageDescription='string'
)
[REQUIRED]
The name of the image to copy.
[REQUIRED]
The name that the image will have when it is copied to the destination.
[REQUIRED]
The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.
dict
Response Syntax
{
'DestinationImageName': 'string'
}
Response Structure
(dict) --
DestinationImageName (string) --
The name of the destination image.
Exceptions
AppStream.Client.exceptions.ResourceAlreadyExistsExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.ResourceNotAvailableExceptionAppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.IncompatibleImageExceptioncreate_app_block(**kwargs)¶Creates an app block.
App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block.
This is only supported for Elastic fleets.
See also: AWS API Documentation
Request Syntax
response = client.create_app_block(
Name='string',
Description='string',
DisplayName='string',
SourceS3Location={
'S3Bucket': 'string',
'S3Key': 'string'
},
SetupScriptDetails={
'ScriptS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'ExecutablePath': 'string',
'ExecutableParameters': 'string',
'TimeoutInSeconds': 123
},
Tags={
'string': 'string'
}
)
[REQUIRED]
The name of the app block.
[REQUIRED]
The source S3 location of the app block.
The S3 bucket of the S3 object.
The S3 key of the S3 object.
[REQUIRED]
The setup script details of the app block.
The S3 object location for the script.
The S3 bucket of the S3 object.
The S3 key of the S3 object.
The run path for the script.
The runtime parameters passed to the run path for the script.
The run timeout, in seconds, for the script.
The tags assigned to the app block.
dict
Response Syntax
{
'AppBlock': {
'Name': 'string',
'Arn': 'string',
'Description': 'string',
'DisplayName': 'string',
'SourceS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'SetupScriptDetails': {
'ScriptS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'ExecutablePath': 'string',
'ExecutableParameters': 'string',
'TimeoutInSeconds': 123
},
'CreatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
AppBlock (dict) --
The app block.
Name (string) --
The name of the app block.
Arn (string) --
The ARN of the app block.
Description (string) --
The description of the app block.
DisplayName (string) --
The display name of the app block.
SourceS3Location (dict) --
The source S3 location of the app block.
S3Bucket (string) --
The S3 bucket of the S3 object.
S3Key (string) --
The S3 key of the S3 object.
SetupScriptDetails (dict) --
The setup script details of the app block.
ScriptS3Location (dict) --
The S3 object location for the script.
S3Bucket (string) --
The S3 bucket of the S3 object.
S3Key (string) --
The S3 key of the S3 object.
ExecutablePath (string) --
The run path for the script.
ExecutableParameters (string) --
The runtime parameters passed to the run path for the script.
TimeoutInSeconds (integer) --
The run timeout, in seconds, for the script.
CreatedTime (datetime) --
The created time of the app block.
Exceptions
AppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ResourceAlreadyExistsExceptioncreate_application(**kwargs)¶Creates an application.
Applications are an Amazon AppStream 2.0 resource that stores the details about how to launch applications on Elastic fleet streaming instances. An application consists of the launch details, icon, and display name. Applications are associated with an app block that contains the application binaries and other files. The applications assigned to an Elastic fleet are the applications users can launch.
This is only supported for Elastic fleets.
See also: AWS API Documentation
Request Syntax
response = client.create_application(
Name='string',
DisplayName='string',
Description='string',
IconS3Location={
'S3Bucket': 'string',
'S3Key': 'string'
},
LaunchPath='string',
WorkingDirectory='string',
LaunchParameters='string',
Platforms=[
'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
],
InstanceFamilies=[
'string',
],
AppBlockArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The name of the application. This name is visible to users when display name is not specified.
[REQUIRED]
The location in S3 of the application icon.
The S3 bucket of the S3 object.
The S3 key of the S3 object.
[REQUIRED]
The launch path of the application.
[REQUIRED]
The platforms the application supports. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
[REQUIRED]
The instance families the application supports. Valid values are GENERAL_PURPOSE and GRAPHICS_G4.
[REQUIRED]
The app block ARN to which the application should be associated
The tags assigned to the application.
dict
Response Syntax
{
'Application': {
'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'|'AMAZON_LINUX2',
],
'InstanceFamilies': [
'string',
],
'CreatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Application (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.
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.
Platforms (list) --
The platforms on which the application can run.
InstanceFamilies (list) --
The instance families for the application.
CreatedTime (datetime) --
The time at which the application was created within the app block.
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ResourceAlreadyExistsExceptionAppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.ResourceNotFoundExceptioncreate_directory_config(**kwargs)¶Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
See also: AWS API Documentation
Request Syntax
response = client.create_directory_config(
DirectoryName='string',
OrganizationalUnitDistinguishedNames=[
'string',
],
ServiceAccountCredentials={
'AccountName': 'string',
'AccountPassword': 'string'
},
CertificateBasedAuthProperties={
'Status': 'DISABLED'|'ENABLED'|'ENABLED_NO_DIRECTORY_LOGIN_FALLBACK',
'CertificateAuthorityArn': 'string'
}
)
[REQUIRED]
The fully qualified name of the directory (for example, corp.example.com).
[REQUIRED]
The distinguished names of the organizational units for computer accounts.
The credentials for the service account used by the fleet or image builder to connect to the directory.
The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
The password for the account.
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
The status of the certificate-based authentication properties.
The ARN of the AWS Certificate Manager Private CA resource.
dict
Response Syntax
{
'DirectoryConfig': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedNames': [
'string',
],
'ServiceAccountCredentials': {
'AccountName': 'string',
'AccountPassword': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'CertificateBasedAuthProperties': {
'Status': 'DISABLED'|'ENABLED'|'ENABLED_NO_DIRECTORY_LOGIN_FALLBACK',
'CertificateAuthorityArn': 'string'
}
}
}
Response Structure
(dict) --
DirectoryConfig (dict) --
Information about the directory configuration.
DirectoryName (string) --
The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedNames (list) --
The distinguished names of the organizational units for computer accounts.
ServiceAccountCredentials (dict) --
The credentials for the service account used by the fleet or image builder to connect to the directory.
AccountName (string) --
The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
AccountPassword (string) --
The password for the account.
CreatedTime (datetime) --
The time the directory configuration was created.
CertificateBasedAuthProperties (dict) --
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
Status (string) --
The status of the certificate-based authentication properties.
CertificateAuthorityArn (string) --
The ARN of the AWS Certificate Manager Private CA resource.
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.ResourceAlreadyExistsExceptionAppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.InvalidRoleExceptioncreate_entitlement(**kwargs)¶Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.
See also: AWS API Documentation
Request Syntax
response = client.create_entitlement(
Name='string',
StackName='string',
Description='string',
AppVisibility='ALL'|'ASSOCIATED',
Attributes=[
{
'Name': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the entitlement.
[REQUIRED]
The name of the stack with which the entitlement is associated.
[REQUIRED]
Specifies whether all or selected apps are entitled.
[REQUIRED]
The attributes of the entitlement.
An attribute associated with an entitlement. Application entitlements work by matching a supported SAML 2.0 attribute name to a value when a user identity federates to an Amazon AppStream 2.0 SAML application.
A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user identity federates into an Amazon AppStream 2.0 SAML application.
The following are valid values:
A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon AppStream 2.0 SAML application.
dict
Response Syntax
{
'Entitlement': {
'Name': 'string',
'StackName': 'string',
'Description': 'string',
'AppVisibility': 'ALL'|'ASSOCIATED',
'Attributes': [
{
'Name': 'string',
'Value': 'string'
},
],
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Entitlement (dict) --
The entitlement.
Name (string) --
The name of the entitlement.
StackName (string) --
The name of the stack with which the entitlement is associated.
Description (string) --
The description of the entitlement.
AppVisibility (string) --
Specifies whether all or selected apps are entitled.
Attributes (list) --
The attributes of the entitlement.
(dict) --
An attribute associated with an entitlement. Application entitlements work by matching a supported SAML 2.0 attribute name to a value when a user identity federates to an Amazon AppStream 2.0 SAML application.
Name (string) --
A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user identity federates into an Amazon AppStream 2.0 SAML application.
The following are valid values:
Value (string) --
A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon AppStream 2.0 SAML application.
CreatedTime (datetime) --
The time when the entitlement was created.
LastModifiedTime (datetime) --
The time when the entitlement was last modified.
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.EntitlementAlreadyExistsExceptioncreate_fleet(**kwargs)¶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
response = client.create_fleet(
Name='string',
ImageName='string',
ImageArn='string',
InstanceType='string',
FleetType='ALWAYS_ON'|'ON_DEMAND'|'ELASTIC',
ComputeCapacity={
'DesiredInstances': 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'|'AMAZON_LINUX2',
MaxConcurrentSessions=123,
UsbDeviceFilterStrings=[
'string',
],
SessionScriptS3Location={
'S3Bucket': 'string',
'S3Key': 'string'
}
)
[REQUIRED]
A unique name for the fleet.
[REQUIRED]
The instance type to use when launching fleet instances. The following instance types are available:
The following instance types are available for Elastic fleets:
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.
The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
The desired number of streaming instances.
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.
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.
The identifiers of the security groups for the fleet or image builder.
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.
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 360000.
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.
The fully qualified name of the directory (for example, corp.example.com).
The distinguished name of the organizational unit for computer accounts.
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 AppStream 2.0 Administration Guide .
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 3600. The default value is 0.
Note
If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
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. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
The AppStream 2.0 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 .
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.
The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
The S3 bucket of the S3 object.
The S3 key of the S3 object.
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
},
'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',
'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'|'AMAZON_LINUX2',
'MaxConcurrentSessions': 123,
'UsbDeviceFilterStrings': [
'string',
],
'SessionScriptS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
}
}
}
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:
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.
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 360000.
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.
SecurityGroupIds (list) --
The identifiers of the security groups for the fleet or image builder.
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 3600. The default value is 0.
Note
If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
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. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
StreamView (string) --
The AppStream 2.0 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.
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.
Exceptions
AppStream.Client.exceptions.ResourceAlreadyExistsExceptionAppStream.Client.exceptions.ResourceNotAvailableExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.RequestLimitExceededExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.InvalidRoleExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.InvalidParameterCombinationExceptionAppStream.Client.exceptions.IncompatibleImageExceptionAppStream.Client.exceptions.OperationNotPermittedExceptioncreate_image_builder(**kwargs)¶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
response = 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'
},
]
)
[REQUIRED]
A unique name for the image builder.
[REQUIRED]
The instance type to use when launching the image builder. The following instance types are available:
The VPC configuration for the image builder. You can specify only one subnet.
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.
The identifiers of the security groups for the fleet or image builder.
The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
The fully qualified name of the directory (for example, corp.example.com).
The distinguished name of the organizational unit for computer accounts.
The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
_ . : / = + - @
If you do not specify a value, the value is set to an empty string.
For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide .
The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
The type of interface endpoint.
The identifier (ID) of the VPC in which the interface endpoint is used.
dict
Response Syntax
{
'ImageBuilder': {
'Name': 'string',
'Arn': 'string',
'ImageArn': 'string',
'Description': 'string',
'DisplayName': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'InstanceType': 'string',
'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
'IamRoleArn': 'string',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
'NetworkAccessConfiguration': {
'EniPrivateIpAddress': 'string',
'EniId': 'string'
},
'ImageBuilderErrors': [
{
'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'AppstreamAgentVersion': 'string',
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
]
}
}
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.
SecurityGroupIds (list) --
The identifiers of the security groups for the fleet or image builder.
InstanceType (string) --
The instance type for the image builder. The following instance types are available:
Platform (string) --
The operating system platform of the image builder.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
State (string) --
The state of the image builder.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
CreatedTime (datetime) --
The time stamp when the image builder was created.
EnableDefaultInternetAccess (boolean) --
Enables or disables default internet access for the image builder.
DomainJoinInfo (dict) --
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
DirectoryName (string) --
The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit for computer accounts.
NetworkAccessConfiguration (dict) --
Describes the network details of the fleet or image builder instance.
EniPrivateIpAddress (string) --
The private IP address of the elastic network interface that is attached to instances in your VPC.
EniId (string) --
The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
ImageBuilderErrors (list) --
The image builder errors.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent that is currently being used by the image builder.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
Exceptions
AppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.RequestLimitExceededExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.ResourceAlreadyExistsExceptionAppStream.Client.exceptions.ResourceNotAvailableExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.InvalidRoleExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.InvalidParameterCombinationExceptionAppStream.Client.exceptions.IncompatibleImageExceptionAppStream.Client.exceptions.OperationNotPermittedExceptioncreate_image_builder_streaming_url(**kwargs)¶Creates a URL to start an image builder streaming session.
See also: AWS API Documentation
Request Syntax
response = client.create_image_builder_streaming_url(
Name='string',
Validity=123
)
[REQUIRED]
The name of the image builder.
dict
Response Syntax
{
'StreamingURL': 'string',
'Expires': datetime(2015, 1, 1)
}
Response Structure
(dict) --
StreamingURL (string) --
The URL to start the AppStream 2.0 streaming session.
Expires (datetime) --
The elapsed time, in seconds after the Unix epoch, when this URL expires.
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ResourceNotFoundExceptioncreate_stack(**kwargs)¶Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
See also: AWS API Documentation
Request Syntax
response = client.create_stack(
Name='string',
Description='string',
DisplayName='string',
StorageConnectors=[
{
'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
'ResourceIdentifier': 'string',
'Domains': [
'string',
]
},
],
RedirectURL='string',
FeedbackURL='string',
UserSettings=[
{
'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE'|'DOMAIN_PASSWORD_SIGNIN'|'DOMAIN_SMART_CARD_SIGNIN',
'Permission': 'ENABLED'|'DISABLED'
},
],
ApplicationSettings={
'Enabled': True|False,
'SettingsGroup': 'string'
},
Tags={
'string': 'string'
},
AccessEndpoints=[
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
EmbedHostDomains=[
'string',
],
StreamingExperienceSettings={
'PreferredProtocol': 'TCP'|'UDP'
}
)
[REQUIRED]
The name of the stack.
The storage connectors to enable.
Describes a connector that enables persistent storage for users.
The type of storage connector.
The ARN of the storage connector.
The names of the domains for the account.
The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
The action that is enabled or disabled.
Indicates whether the action is enabled or disabled.
The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
Enables or disables persistent application settings for users during their streaming sessions.
The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.
The tags to associate with the stack. 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 about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide .
The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
The type of interface endpoint.
The identifier (ID) of the VPC in which the interface endpoint is used.
The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
The preferred protocol that you want to use while streaming your application.
dict
Response Syntax
{
'Stack': {
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'DisplayName': 'string',
'CreatedTime': datetime(2015, 1, 1),
'StorageConnectors': [
{
'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
'ResourceIdentifier': 'string',
'Domains': [
'string',
]
},
],
'RedirectURL': 'string',
'FeedbackURL': 'string',
'StackErrors': [
{
'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string'
},
],
'UserSettings': [
{
'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE'|'DOMAIN_PASSWORD_SIGNIN'|'DOMAIN_SMART_CARD_SIGNIN',
'Permission': 'ENABLED'|'DISABLED'
},
],
'ApplicationSettings': {
'Enabled': True|False,
'SettingsGroup': 'string',
'S3BucketName': 'string'
},
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
'EmbedHostDomains': [
'string',
],
'StreamingExperienceSettings': {
'PreferredProtocol': 'TCP'|'UDP'
}
}
}
Response Structure
(dict) --
Stack (dict) --
Information about the stack.
Arn (string) --
The ARN of the stack.
Name (string) --
The name of the stack.
Description (string) --
The description to display.
DisplayName (string) --
The stack name to display.
CreatedTime (datetime) --
The time the stack was created.
StorageConnectors (list) --
The storage connectors to enable.
(dict) --
Describes a connector that enables persistent storage for users.
ConnectorType (string) --
The type of storage connector.
ResourceIdentifier (string) --
The ARN of the storage connector.
Domains (list) --
The names of the domains for the account.
RedirectURL (string) --
The URL that users are redirected to after their streaming session ends.
FeedbackURL (string) --
The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
StackErrors (list) --
The errors for the stack.
(dict) --
Describes a stack error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
UserSettings (list) --
The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
(dict) --
Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
Action (string) --
The action that is enabled or disabled.
Permission (string) --
Indicates whether the action is enabled or disabled.
ApplicationSettings (dict) --
The persistent application settings for users of the stack.
Enabled (boolean) --
Specifies whether persistent application settings are enabled for users during their streaming sessions.
SettingsGroup (string) --
The path prefix for the S3 bucket where users’ persistent application settings are stored.
S3BucketName (string) --
The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
EmbedHostDomains (list) --
The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
StreamingExperienceSettings (dict) --
The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
PreferredProtocol (string) --
The preferred protocol that you want to use while streaming your application.
Exceptions
AppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.ResourceAlreadyExistsExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.InvalidRoleExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.InvalidParameterCombinationExceptioncreate_streaming_url(**kwargs)¶Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.
See also: AWS API Documentation
Request Syntax
response = client.create_streaming_url(
StackName='string',
FleetName='string',
UserId='string',
ApplicationId='string',
Validity=123,
SessionContext='string'
)
[REQUIRED]
The name of the stack.
[REQUIRED]
The name of the fleet.
[REQUIRED]
The identifier of the user.
dict
Response Syntax
{
'StreamingURL': 'string',
'Expires': datetime(2015, 1, 1)
}
Response Structure
(dict) --
StreamingURL (string) --
The URL to start the AppStream 2.0 streaming session.
Expires (datetime) --
The elapsed time, in seconds after the Unix epoch, when this URL expires.
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.ResourceNotAvailableExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.InvalidParameterCombinationExceptioncreate_updated_image(**kwargs)¶Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.
For more information, see the "Update an Image by Using Managed AppStream 2.0 Image Updates" section in Administer Your AppStream 2.0 Images , in the Amazon AppStream 2.0 Administration Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_updated_image(
existingImageName='string',
newImageName='string',
newImageDescription='string',
newImageDisplayName='string',
newImageTags={
'string': 'string'
},
dryRun=True|False
)
[REQUIRED]
The name of the image to update.
[REQUIRED]
The name of the new image. The name must be unique within the AWS account and Region.
The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
_ . : / = + - @
If you do not specify a value, the value is set to an empty string.
For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide .
true , AppStream 2.0 displays whether image updates are available. If this value is set to false , AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.dict
Response Syntax
{
'image': {
'Name': 'string',
'Arn': 'string',
'BaseImageArn': 'string',
'DisplayName': 'string',
'State': 'PENDING'|'AVAILABLE'|'FAILED'|'COPYING'|'DELETING'|'CREATING'|'IMPORTING',
'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
'ImageBuilderSupported': True|False,
'ImageBuilderName': 'string',
'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
'Description': 'string',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE',
'Message': 'string'
},
'Applications': [
{
'Name': 'string',
'DisplayName': 'string',
'IconURL': 'string',
'LaunchPath': 'string',
'LaunchParameters': 'string',
'Enabled': True|False,
'Metadata': {
'string': 'string'
},
'WorkingDirectory': 'string',
'Description': 'string',
'Arn': 'string',
'AppBlockArn': 'string',
'IconS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'Platforms': [
'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
],
'InstanceFamilies': [
'string',
],
'CreatedTime': datetime(2015, 1, 1)
},
],
'CreatedTime': datetime(2015, 1, 1),
'PublicBaseImageReleasedDate': datetime(2015, 1, 1),
'AppstreamAgentVersion': 'string',
'ImagePermissions': {
'allowFleet': True|False,
'allowImageBuilder': True|False
},
'ImageErrors': [
{
'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
]
},
'canUpdateImage': True|False
}
Response Structure
(dict) --
image (dict) --
Describes an image.
Name (string) --
The name of the image.
Arn (string) --
The ARN of the image.
BaseImageArn (string) --
The ARN of the image from which this image was created.
DisplayName (string) --
The image name to display.
State (string) --
The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE . If image creation fails, the state is FAILED .
Visibility (string) --
Indicates whether the image is public or private.
ImageBuilderSupported (boolean) --
Indicates whether an image builder can be launched from this image.
ImageBuilderName (string) --
The name of the image builder that was used to create the private image. If the image is shared, this value is null.
Platform (string) --
The operating system platform of the image.
Description (string) --
The description to display.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
Applications (list) --
The applications associated with the image.
(dict) --
Describes an application in the application catalog.
Name (string) --
The name of the application.
DisplayName (string) --
The application name to display.
IconURL (string) --
The URL for the application icon. This URL might be time-limited.
LaunchPath (string) --
The path to the application executable in the instance.
LaunchParameters (string) --
The arguments that are passed to the application at launch.
Enabled (boolean) --
If there is a problem, the application can be disabled after image creation.
Metadata (dict) --
Additional attributes that describe the application.
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.
Platforms (list) --
The platforms on which the application can run.
InstanceFamilies (list) --
The instance families for the application.
CreatedTime (datetime) --
The time at which the application was created within the app block.
CreatedTime (datetime) --
The time the image was created.
PublicBaseImageReleasedDate (datetime) --
The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
ImagePermissions (dict) --
The permissions to provide to the destination AWS account for the specified image.
allowFleet (boolean) --
Indicates whether the image can be used for a fleet.
allowImageBuilder (boolean) --
Indicates whether the image can be used for an image builder.
ImageErrors (list) --
Describes the errors that are returned when a new image can't be created.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
canUpdateImage (boolean) --
Indicates whether a new image can be created.
Exceptions
AppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ResourceAlreadyExistsExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.IncompatibleImageExceptioncreate_usage_report_subscription()¶Creates a usage report subscription. Usage reports are generated daily.
See also: AWS API Documentation
Request Syntax
response = client.create_usage_report_subscription()
{
'S3BucketName': 'string',
'Schedule': 'DAILY'
}
Response Structure
The Amazon S3 bucket where generated reports are stored.
If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
The schedule for generating usage reports.
Exceptions
AppStream.Client.exceptions.InvalidRoleExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.LimitExceededExceptioncreate_user(**kwargs)¶Creates a new user in the user pool.
See also: AWS API Documentation
Request Syntax
response = client.create_user(
UserName='string',
MessageAction='SUPPRESS'|'RESEND',
FirstName='string',
LastName='string',
AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD'
)
[REQUIRED]
The email address of the user.
Note
Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.
Note
The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
[REQUIRED]
The authentication type for the user. You must specify USERPOOL.
dict
Response Syntax
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ResourceAlreadyExistsExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.InvalidParameterCombinationExceptionAppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.OperationNotPermittedExceptiondelete_app_block(**kwargs)¶Deletes an app block.
See also: AWS API Documentation
Request Syntax
response = client.delete_app_block(
Name='string'
)
[REQUIRED]
The name of the app block.
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.ResourceInUseExceptionAppStream.Client.exceptions.ResourceNotFoundExceptiondelete_application(**kwargs)¶Deletes an application.
See also: AWS API Documentation
Request Syntax
response = client.delete_application(
Name='string'
)
[REQUIRED]
The name of the application.
{}
Response Structure
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ResourceInUseExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.ConcurrentModificationExceptiondelete_directory_config(**kwargs)¶Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.
See also: AWS API Documentation
Request Syntax
response = client.delete_directory_config(
DirectoryName='string'
)
[REQUIRED]
The name of the directory configuration.
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ResourceInUseExceptionAppStream.Client.exceptions.ResourceNotFoundExceptiondelete_entitlement(**kwargs)¶Deletes the specified entitlement.
See also: AWS API Documentation
Request Syntax
response = client.delete_entitlement(
Name='string',
StackName='string'
)
[REQUIRED]
The name of the entitlement.
[REQUIRED]
The name of the stack with which the entitlement is associated.
dict
Response Syntax
{}
Response Structure
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.EntitlementNotFoundExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ConcurrentModificationExceptiondelete_fleet(**kwargs)¶Deletes the specified fleet.
See also: AWS API Documentation
Request Syntax
response = client.delete_fleet(
Name='string'
)
[REQUIRED]
The name of the fleet.
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ResourceInUseExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.ConcurrentModificationExceptiondelete_image(**kwargs)¶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
response = client.delete_image(
Name='string'
)
[REQUIRED]
The name of the image.
{
'Image': {
'Name': 'string',
'Arn': 'string',
'BaseImageArn': 'string',
'DisplayName': 'string',
'State': 'PENDING'|'AVAILABLE'|'FAILED'|'COPYING'|'DELETING'|'CREATING'|'IMPORTING',
'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
'ImageBuilderSupported': True|False,
'ImageBuilderName': 'string',
'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
'Description': 'string',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE',
'Message': 'string'
},
'Applications': [
{
'Name': 'string',
'DisplayName': 'string',
'IconURL': 'string',
'LaunchPath': 'string',
'LaunchParameters': 'string',
'Enabled': True|False,
'Metadata': {
'string': 'string'
},
'WorkingDirectory': 'string',
'Description': 'string',
'Arn': 'string',
'AppBlockArn': 'string',
'IconS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'Platforms': [
'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
],
'InstanceFamilies': [
'string',
],
'CreatedTime': datetime(2015, 1, 1)
},
],
'CreatedTime': datetime(2015, 1, 1),
'PublicBaseImageReleasedDate': datetime(2015, 1, 1),
'AppstreamAgentVersion': 'string',
'ImagePermissions': {
'allowFleet': True|False,
'allowImageBuilder': True|False
},
'ImageErrors': [
{
'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
]
}
}
Response Structure
Information about the image.
The name of the image.
The ARN of the image.
The ARN of the image from which this image was created.
The image name to display.
The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE . If image creation fails, the state is FAILED .
Indicates whether the image is public or private.
Indicates whether an image builder can be launched from this image.
The name of the image builder that was used to create the private image. If the image is shared, this value is null.
The operating system platform of the image.
The description to display.
The reason why the last state change occurred.
The state change reason code.
The state change reason message.
The applications associated with the image.
Describes an application in the application catalog.
The name of the application.
The application name to display.
The URL for the application icon. This URL might be time-limited.
The path to the application executable in the instance.
The arguments that are passed to the application at launch.
If there is a problem, the application can be disabled after image creation.
Additional attributes that describe the application.
The working directory for the application.
The description of the application.
The ARN of the application.
The app block ARN of the application.
The S3 location of the application icon.
The S3 bucket of the S3 object.
The S3 key of the S3 object.
The platforms on which the application can run.
The instance families for the application.
The time at which the application was created within the app block.
The time the image was created.
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.
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
The permissions to provide to the destination AWS account for the specified image.
Indicates whether the image can be used for a fleet.
Indicates whether the image can be used for an image builder.
Describes the errors that are returned when a new image can't be created.
Describes a resource error.
The error code.
The error message.
The time the error occurred.
Exceptions
AppStream.Client.exceptions.ResourceInUseExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ConcurrentModificationExceptiondelete_image_builder(**kwargs)¶Deletes the specified image builder and releases the capacity.
See also: AWS API Documentation
Request Syntax
response = client.delete_image_builder(
Name='string'
)
[REQUIRED]
The name of the image builder.
{
'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'|'AMAZON_LINUX2',
'IamRoleArn': 'string',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
'NetworkAccessConfiguration': {
'EniPrivateIpAddress': 'string',
'EniId': 'string'
},
'ImageBuilderErrors': [
{
'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'AppstreamAgentVersion': 'string',
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
]
}
}
Response Structure
Information about the image builder.
The name of the image builder.
The ARN for the image builder.
The ARN of the image from which this builder was created.
The description to display.
The image builder name to display.
The VPC configuration of the image builder.
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.
The identifiers of the security groups for the fleet or image builder.
The instance type for the image builder. The following instance types are available:
The operating system platform of the image builder.
The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
The state of the image builder.
The reason why the last state change occurred.
The state change reason code.
The state change reason message.
The time stamp when the image builder was created.
Enables or disables default internet access for the image builder.
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
The fully qualified name of the directory (for example, corp.example.com).
The distinguished name of the organizational unit for computer accounts.
Describes the network details of the fleet or image builder instance.
The private IP address of the elastic network interface that is attached to instances in your VPC.
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.
The image builder errors.
Describes a resource error.
The error code.
The error message.
The time the error occurred.
The version of the AppStream 2.0 agent that is currently being used by the image builder.
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
The type of interface endpoint.
The identifier (ID) of the VPC in which the interface endpoint is used.
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ConcurrentModificationExceptiondelete_image_permissions(**kwargs)¶Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.
See also: AWS API Documentation
Request Syntax
response = client.delete_image_permissions(
Name='string',
SharedAccountId='string'
)
[REQUIRED]
The name of the private image.
[REQUIRED]
The 12-digit identifier of the AWS account for which to delete image permissions.
dict
Response Syntax
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ResourceNotAvailableExceptionAppStream.Client.exceptions.ResourceNotFoundExceptiondelete_stack(**kwargs)¶Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.
See also: AWS API Documentation
Request Syntax
response = client.delete_stack(
Name='string'
)
[REQUIRED]
The name of the stack.
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ResourceInUseExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ConcurrentModificationExceptiondelete_usage_report_subscription()¶Disables usage report generation.
See also: AWS API Documentation
Request Syntax
response = client.delete_usage_report_subscription()
{}
Response Structure
Exceptions
AppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.ResourceNotFoundExceptiondelete_user(**kwargs)¶Deletes a user from the user pool.
See also: AWS API Documentation
Request Syntax
response = client.delete_user(
UserName='string',
AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD'
)
[REQUIRED]
The email address of the user.
Note
Users' email addresses are case-sensitive.
[REQUIRED]
The authentication type for the user. You must specify USERPOOL.
dict
Response Syntax
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptiondescribe_app_blocks(**kwargs)¶Retrieves a list that describes one or more app blocks.
See also: AWS API Documentation
Request Syntax
response = client.describe_app_blocks(
Arns=[
'string',
],
NextToken='string',
MaxResults=123
)
The ARNs of the app blocks.
dict
Response Syntax
{
'AppBlocks': [
{
'Name': 'string',
'Arn': 'string',
'Description': 'string',
'DisplayName': 'string',
'SourceS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'SetupScriptDetails': {
'ScriptS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'ExecutablePath': 'string',
'ExecutableParameters': 'string',
'TimeoutInSeconds': 123
},
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AppBlocks (list) --
The app blocks in the list.
(dict) --
Describes an app block.
App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block.
This is only supported for Elastic fleets.
Name (string) --
The name of the app block.
Arn (string) --
The ARN of the app block.
Description (string) --
The description of the app block.
DisplayName (string) --
The display name of the app block.
SourceS3Location (dict) --
The source S3 location of the app block.
S3Bucket (string) --
The S3 bucket of the S3 object.
S3Key (string) --
The S3 key of the S3 object.
SetupScriptDetails (dict) --
The setup script details of the app block.
ScriptS3Location (dict) --
The S3 object location for the script.
S3Bucket (string) --
The S3 bucket of the S3 object.
S3Key (string) --
The S3 key of the S3 object.
ExecutablePath (string) --
The run path for the script.
ExecutableParameters (string) --
The runtime parameters passed to the run path for the script.
TimeoutInSeconds (integer) --
The run timeout, in seconds, for the script.
CreatedTime (datetime) --
The created time of the app block.
NextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ResourceNotFoundExceptiondescribe_application_fleet_associations(**kwargs)¶Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
See also: AWS API Documentation
Request Syntax
response = client.describe_application_fleet_associations(
FleetName='string',
ApplicationArn='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'ApplicationFleetAssociations': [
{
'FleetName': 'string',
'ApplicationArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ApplicationFleetAssociations (list) --
The application fleet associations in the list.
(dict) --
Describes the application fleet association.
FleetName (string) --
The name of the fleet associated with the application.
ApplicationArn (string) --
The ARN of the application associated with the fleet.
NextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
Exceptions
AppStream.Client.exceptions.InvalidParameterCombinationExceptionAppStream.Client.exceptions.OperationNotPermittedExceptiondescribe_applications(**kwargs)¶Retrieves a list that describes one or more applications.
See also: AWS API Documentation
Request Syntax
response = client.describe_applications(
Arns=[
'string',
],
NextToken='string',
MaxResults=123
)
The ARNs for the applications.
dict
Response Syntax
{
'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'|'AMAZON_LINUX2',
],
'InstanceFamilies': [
'string',
],
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Applications (list) --
The applications in the list.
(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.
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.
Platforms (list) --
The platforms on which the application can run.
InstanceFamilies (list) --
The instance families for the application.
CreatedTime (datetime) --
The time at which the application was created within the app block.
NextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ResourceNotFoundExceptiondescribe_directory_configs(**kwargs)¶Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
Although the response syntax in this topic includes the account password, this password is not returned in the actual response.
See also: AWS API Documentation
Request Syntax
response = client.describe_directory_configs(
DirectoryNames=[
'string',
],
MaxResults=123,
NextToken='string'
)
The directory names.
dict
Response Syntax
{
'DirectoryConfigs': [
{
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedNames': [
'string',
],
'ServiceAccountCredentials': {
'AccountName': 'string',
'AccountPassword': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'CertificateBasedAuthProperties': {
'Status': 'DISABLED'|'ENABLED'|'ENABLED_NO_DIRECTORY_LOGIN_FALLBACK',
'CertificateAuthorityArn': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DirectoryConfigs (list) --
Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.
(dict) --
Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
DirectoryName (string) --
The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedNames (list) --
The distinguished names of the organizational units for computer accounts.
ServiceAccountCredentials (dict) --
The credentials for the service account used by the fleet or image builder to connect to the directory.
AccountName (string) --
The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
AccountPassword (string) --
The password for the account.
CreatedTime (datetime) --
The time the directory configuration was created.
CertificateBasedAuthProperties (dict) --
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
Status (string) --
The status of the certificate-based authentication properties.
CertificateAuthorityArn (string) --
The ARN of the AWS Certificate Manager Private CA resource.
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.
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptiondescribe_entitlements(**kwargs)¶Retrieves a list that describes one of more entitlements.
See also: AWS API Documentation
Request Syntax
response = client.describe_entitlements(
Name='string',
StackName='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The name of the stack with which the entitlement is associated.
dict
Response Syntax
{
'Entitlements': [
{
'Name': 'string',
'StackName': 'string',
'Description': 'string',
'AppVisibility': 'ALL'|'ASSOCIATED',
'Attributes': [
{
'Name': 'string',
'Value': 'string'
},
],
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entitlements (list) --
The entitlements.
(dict) --
Specifies an entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.
Name (string) --
The name of the entitlement.
StackName (string) --
The name of the stack with which the entitlement is associated.
Description (string) --
The description of the entitlement.
AppVisibility (string) --
Specifies whether all or selected apps are entitled.
Attributes (list) --
The attributes of the entitlement.
(dict) --
An attribute associated with an entitlement. Application entitlements work by matching a supported SAML 2.0 attribute name to a value when a user identity federates to an Amazon AppStream 2.0 SAML application.
Name (string) --
A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user identity federates into an Amazon AppStream 2.0 SAML application.
The following are valid values:
Value (string) --
A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon AppStream 2.0 SAML application.
CreatedTime (datetime) --
The time when the entitlement was created.
LastModifiedTime (datetime) --
The time when the entitlement was last modified.
NextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.EntitlementNotFoundExceptiondescribe_fleets(**kwargs)¶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
response = client.describe_fleets(
Names=[
'string',
],
NextToken='string'
)
The names of the fleets to describe.
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
},
'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',
'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'|'AMAZON_LINUX2',
'MaxConcurrentSessions': 123,
'UsbDeviceFilterStrings': [
'string',
],
'SessionScriptS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
}
},
],
'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:
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.
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 360000.
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.
SecurityGroupIds (list) --
The identifiers of the security groups for the fleet or image builder.
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 3600. The default value is 0.
Note
If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
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. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
StreamView (string) --
The AppStream 2.0 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.
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.
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.
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptiondescribe_image_builders(**kwargs)¶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
response = client.describe_image_builders(
Names=[
'string',
],
MaxResults=123,
NextToken='string'
)
The names of the image builders to describe.
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'|'AMAZON_LINUX2',
'IamRoleArn': 'string',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
'NetworkAccessConfiguration': {
'EniPrivateIpAddress': 'string',
'EniId': 'string'
},
'ImageBuilderErrors': [
{
'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'AppstreamAgentVersion': 'string',
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
]
},
],
'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.
SecurityGroupIds (list) --
The identifiers of the security groups for the fleet or image builder.
InstanceType (string) --
The instance type for the image builder. The following instance types are available:
Platform (string) --
The operating system platform of the image builder.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
State (string) --
The state of the image builder.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
CreatedTime (datetime) --
The time stamp when the image builder was created.
EnableDefaultInternetAccess (boolean) --
Enables or disables default internet access for the image builder.
DomainJoinInfo (dict) --
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
DirectoryName (string) --
The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit for computer accounts.
NetworkAccessConfiguration (dict) --
Describes the network details of the fleet or image builder instance.
EniPrivateIpAddress (string) --
The private IP address of the elastic network interface that is attached to instances in your VPC.
EniId (string) --
The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
ImageBuilderErrors (list) --
The image builder errors.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent that is currently being used by the image builder.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
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.
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptiondescribe_image_permissions(**kwargs)¶Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
See also: AWS API Documentation
Request Syntax
response = client.describe_image_permissions(
Name='string',
MaxResults=123,
SharedAwsAccountIds=[
'string',
],
NextToken='string'
)
[REQUIRED]
The name of the private image for which to describe permissions. The image must be one that you own.
The 12-digit identifier of one or more AWS accounts with which the image is shared.
dict
Response Syntax
{
'Name': 'string',
'SharedImagePermissionsList': [
{
'sharedAccountId': 'string',
'imagePermissions': {
'allowFleet': True|False,
'allowImageBuilder': True|False
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Name (string) --
The name of the private image.
SharedImagePermissionsList (list) --
The permissions for a private image that you own.
(dict) --
Describes the permissions that are available to the specified AWS account for a shared image.
sharedAccountId (string) --
The 12-digit identifier of the AWS account with which the image is shared.
imagePermissions (dict) --
Describes the permissions for a shared 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.
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.
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptiondescribe_images(**kwargs)¶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
response = client.describe_images(
Names=[
'string',
],
Arns=[
'string',
],
Type='PUBLIC'|'PRIVATE'|'SHARED',
NextToken='string',
MaxResults=123
)
The names of the public or private images to describe.
The ARNs of the public, private, and shared images to describe.
dict
Response Syntax
{
'Images': [
{
'Name': 'string',
'Arn': 'string',
'BaseImageArn': 'string',
'DisplayName': 'string',
'State': 'PENDING'|'AVAILABLE'|'FAILED'|'COPYING'|'DELETING'|'CREATING'|'IMPORTING',
'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
'ImageBuilderSupported': True|False,
'ImageBuilderName': 'string',
'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
'Description': 'string',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE',
'Message': 'string'
},
'Applications': [
{
'Name': 'string',
'DisplayName': 'string',
'IconURL': 'string',
'LaunchPath': 'string',
'LaunchParameters': 'string',
'Enabled': True|False,
'Metadata': {
'string': 'string'
},
'WorkingDirectory': 'string',
'Description': 'string',
'Arn': 'string',
'AppBlockArn': 'string',
'IconS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'Platforms': [
'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
],
'InstanceFamilies': [
'string',
],
'CreatedTime': datetime(2015, 1, 1)
},
],
'CreatedTime': datetime(2015, 1, 1),
'PublicBaseImageReleasedDate': datetime(2015, 1, 1),
'AppstreamAgentVersion': 'string',
'ImagePermissions': {
'allowFleet': True|False,
'allowImageBuilder': True|False
},
'ImageErrors': [
{
'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Images (list) --
Information about the images.
(dict) --
Describes an image.
Name (string) --
The name of the image.
Arn (string) --
The ARN of the image.
BaseImageArn (string) --
The ARN of the image from which this image was created.
DisplayName (string) --
The image name to display.
State (string) --
The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE . If image creation fails, the state is FAILED .
Visibility (string) --
Indicates whether the image is public or private.
ImageBuilderSupported (boolean) --
Indicates whether an image builder can be launched from this image.
ImageBuilderName (string) --
The name of the image builder that was used to create the private image. If the image is shared, this value is null.
Platform (string) --
The operating system platform of the image.
Description (string) --
The description to display.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
Applications (list) --
The applications associated with the image.
(dict) --
Describes an application in the application catalog.
Name (string) --
The name of the application.
DisplayName (string) --
The application name to display.
IconURL (string) --
The URL for the application icon. This URL might be time-limited.
LaunchPath (string) --
The path to the application executable in the instance.
LaunchParameters (string) --
The arguments that are passed to the application at launch.
Enabled (boolean) --
If there is a problem, the application can be disabled after image creation.
Metadata (dict) --
Additional attributes that describe the application.
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.
Platforms (list) --
The platforms on which the application can run.
InstanceFamilies (list) --
The instance families for the application.
CreatedTime (datetime) --
The time at which the application was created within the app block.
CreatedTime (datetime) --
The time the image was created.
PublicBaseImageReleasedDate (datetime) --
The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
ImagePermissions (dict) --
The permissions to provide to the destination AWS account for the specified image.
allowFleet (boolean) --
Indicates whether the image can be used for a fleet.
allowImageBuilder (boolean) --
Indicates whether the image can be used for an image builder.
ImageErrors (list) --
Describes the errors that are returned when a new image can't be created.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
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.
Exceptions
AppStream.Client.exceptions.InvalidParameterCombinationExceptionAppStream.Client.exceptions.ResourceNotFoundExceptiondescribe_sessions(**kwargs)¶Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.
See also: AWS API Documentation
Request Syntax
response = client.describe_sessions(
StackName='string',
FleetName='string',
UserId='string',
NextToken='string',
Limit=123,
AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD'
)
[REQUIRED]
The name of the stack. This value is case-sensitive.
[REQUIRED]
The name of the fleet. This value is case-sensitive.
API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.dict
Response Syntax
{
'Sessions': [
{
'Id': 'string',
'UserId': 'string',
'StackName': 'string',
'FleetName': 'string',
'State': 'ACTIVE'|'PENDING'|'EXPIRED',
'ConnectionState': 'CONNECTED'|'NOT_CONNECTED',
'StartTime': datetime(2015, 1, 1),
'MaxExpirationTime': datetime(2015, 1, 1),
'AuthenticationType': 'API'|'SAML'|'USERPOOL'|'AWS_AD',
'NetworkAccessConfiguration': {
'EniPrivateIpAddress': 'string',
'EniId': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Sessions (list) --
Information about the streaming sessions.
(dict) --
Describes a streaming session.
Id (string) --
The identifier of the streaming session.
UserId (string) --
The identifier of the user for whom the session was created.
StackName (string) --
The name of the stack for the streaming session.
FleetName (string) --
The name of the fleet for the streaming session.
State (string) --
The current state of the streaming session.
ConnectionState (string) --
Specifies whether a user is connected to the streaming session.
StartTime (datetime) --
The time when a streaming instance is dedicated for the user.
MaxExpirationTime (datetime) --
The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime , when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.
AuthenticationType (string) --
The authentication method. The user is authenticated using a streaming URL (API ) or SAML 2.0 federation (SAML ).
NetworkAccessConfiguration (dict) --
The network details for the streaming session.
EniPrivateIpAddress (string) --
The private IP address of the elastic network interface that is attached to instances in your VPC.
EniId (string) --
The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
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.
Exceptions
AppStream.Client.exceptions.InvalidParameterCombinationExceptiondescribe_stacks(**kwargs)¶Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
See also: AWS API Documentation
Request Syntax
response = client.describe_stacks(
Names=[
'string',
],
NextToken='string'
)
The names of the stacks to describe.
dict
Response Syntax
{
'Stacks': [
{
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'DisplayName': 'string',
'CreatedTime': datetime(2015, 1, 1),
'StorageConnectors': [
{
'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
'ResourceIdentifier': 'string',
'Domains': [
'string',
]
},
],
'RedirectURL': 'string',
'FeedbackURL': 'string',
'StackErrors': [
{
'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string'
},
],
'UserSettings': [
{
'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE'|'DOMAIN_PASSWORD_SIGNIN'|'DOMAIN_SMART_CARD_SIGNIN',
'Permission': 'ENABLED'|'DISABLED'
},
],
'ApplicationSettings': {
'Enabled': True|False,
'SettingsGroup': 'string',
'S3BucketName': 'string'
},
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
'EmbedHostDomains': [
'string',
],
'StreamingExperienceSettings': {
'PreferredProtocol': 'TCP'|'UDP'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Stacks (list) --
Information about the stacks.
(dict) --
Describes a stack.
Arn (string) --
The ARN of the stack.
Name (string) --
The name of the stack.
Description (string) --
The description to display.
DisplayName (string) --
The stack name to display.
CreatedTime (datetime) --
The time the stack was created.
StorageConnectors (list) --
The storage connectors to enable.
(dict) --
Describes a connector that enables persistent storage for users.
ConnectorType (string) --
The type of storage connector.
ResourceIdentifier (string) --
The ARN of the storage connector.
Domains (list) --
The names of the domains for the account.
RedirectURL (string) --
The URL that users are redirected to after their streaming session ends.
FeedbackURL (string) --
The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
StackErrors (list) --
The errors for the stack.
(dict) --
Describes a stack error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
UserSettings (list) --
The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
(dict) --
Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
Action (string) --
The action that is enabled or disabled.
Permission (string) --
Indicates whether the action is enabled or disabled.
ApplicationSettings (dict) --
The persistent application settings for users of the stack.
Enabled (boolean) --
Specifies whether persistent application settings are enabled for users during their streaming sessions.
SettingsGroup (string) --
The path prefix for the S3 bucket where users’ persistent application settings are stored.
S3BucketName (string) --
The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
EmbedHostDomains (list) --
The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
StreamingExperienceSettings (dict) --
The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
PreferredProtocol (string) --
The preferred protocol that you want to use while streaming your application.
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.
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptiondescribe_usage_report_subscriptions(**kwargs)¶Retrieves a list that describes one or more usage report subscriptions.
See also: AWS API Documentation
Request Syntax
response = client.describe_usage_report_subscriptions(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'UsageReportSubscriptions': [
{
'S3BucketName': 'string',
'Schedule': 'DAILY',
'LastGeneratedReportDate': datetime(2015, 1, 1),
'SubscriptionErrors': [
{
'ErrorCode': 'RESOURCE_NOT_FOUND'|'ACCESS_DENIED'|'INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
UsageReportSubscriptions (list) --
Information about the usage report subscription.
(dict) --
Describes information about the usage report subscription.
S3BucketName (string) --
The Amazon S3 bucket where generated reports are stored.
If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
Schedule (string) --
The schedule for generating usage reports.
LastGeneratedReportDate (datetime) --
The time when the last usage report was generated.
SubscriptionErrors (list) --
The errors that were returned if usage reports couldn't be generated.
(dict) --
Describes the error that is returned when a usage report can't be generated.
ErrorCode (string) --
The error code for the error that is returned when a usage report can't be generated.
ErrorMessage (string) --
The error message for the error that is returned when a usage report can't be generated.
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.
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptiondescribe_user_stack_associations(**kwargs)¶Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:
See also: AWS API Documentation
Request Syntax
response = client.describe_user_stack_associations(
StackName='string',
UserName='string',
AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD',
MaxResults=123,
NextToken='string'
)
The email address of the user who is associated with the stack.
Note
Users' email addresses are case-sensitive.
dict
Response Syntax
{
'UserStackAssociations': [
{
'StackName': 'string',
'UserName': 'string',
'AuthenticationType': 'API'|'SAML'|'USERPOOL'|'AWS_AD',
'SendEmailNotification': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
UserStackAssociations (list) --
The UserStackAssociation objects.
(dict) --
Describes a user in the user pool and the associated stack.
StackName (string) --
The name of the stack that is associated with the user.
UserName (string) --
The email address of the user who is associated with the stack.
Note
Users' email addresses are case-sensitive.
AuthenticationType (string) --
The authentication type for the user.
SendEmailNotification (boolean) --
Specifies whether a welcome email is sent to a user after the user is created in the user pool.
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.
Exceptions
AppStream.Client.exceptions.InvalidParameterCombinationExceptionAppStream.Client.exceptions.OperationNotPermittedExceptiondescribe_users(**kwargs)¶Retrieves a list that describes one or more specified users in the user pool.
See also: AWS API Documentation
Request Syntax
response = client.describe_users(
AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The authentication type for the users in the user pool to describe. You must specify USERPOOL.
dict
Response Syntax
{
'Users': [
{
'Arn': 'string',
'UserName': 'string',
'Enabled': True|False,
'Status': 'string',
'FirstName': 'string',
'LastName': 'string',
'CreatedTime': datetime(2015, 1, 1),
'AuthenticationType': 'API'|'SAML'|'USERPOOL'|'AWS_AD'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Users (list) --
Information about users in the user pool.
(dict) --
Describes a user in the user pool.
Arn (string) --
The ARN of the user.
UserName (string) --
The email address of the user.
Note
Users' email addresses are case-sensitive.
Enabled (boolean) --
Specifies whether the user in the user pool is enabled.
Status (string) --
The status of the user in the user pool. The status can be one of the following:
FirstName (string) --
The first name, or given name, of the user.
LastName (string) --
The last name, or surname, of the user.
CreatedTime (datetime) --
The date and time the user was created in the user pool.
AuthenticationType (string) --
The authentication type for the user.
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.
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.InvalidParameterCombinationExceptionAppStream.Client.exceptions.OperationNotPermittedExceptiondisable_user(**kwargs)¶Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.
See also: AWS API Documentation
Request Syntax
response = client.disable_user(
UserName='string',
AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD'
)
[REQUIRED]
The email address of the user.
Note
Users' email addresses are case-sensitive.
[REQUIRED]
The authentication type for the user. You must specify USERPOOL.
dict
Response Syntax
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptiondisassociate_application_fleet(**kwargs)¶Disassociates the specified application from the fleet.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_application_fleet(
FleetName='string',
ApplicationArn='string'
)
[REQUIRED]
The name of the fleet.
[REQUIRED]
The ARN of the application.
dict
Response Syntax
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.InvalidParameterCombinationExceptionAppStream.Client.exceptions.OperationNotPermittedExceptiondisassociate_application_from_entitlement(**kwargs)¶Deletes the specified application from the specified entitlement.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_application_from_entitlement(
StackName='string',
EntitlementName='string',
ApplicationIdentifier='string'
)
[REQUIRED]
The name of the stack with which the entitlement is associated.
[REQUIRED]
The name of the entitlement.
[REQUIRED]
The identifier of the application to remove from the entitlement.
dict
Response Syntax
{}
Response Structure
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.EntitlementNotFoundExceptionAppStream.Client.exceptions.OperationNotPermittedExceptiondisassociate_fleet(**kwargs)¶Disassociates the specified fleet from the specified stack.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_fleet(
FleetName='string',
StackName='string'
)
[REQUIRED]
The name of the fleet.
[REQUIRED]
The name of the stack.
dict
Response Syntax
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ResourceInUseExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionenable_user(**kwargs)¶Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.
See also: AWS API Documentation
Request Syntax
response = client.enable_user(
UserName='string',
AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD'
)
[REQUIRED]
The email address of the user.
Note
Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
[REQUIRED]
The authentication type for the user. You must specify USERPOOL.
dict
Response Syntax
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionexpire_session(**kwargs)¶Immediately stops the specified streaming session.
See also: AWS API Documentation
Request Syntax
response = client.expire_session(
SessionId='string'
)
[REQUIRED]
The identifier of the streaming session.
{}
Response Structure
get_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_associated_fleets(**kwargs)¶Retrieves the name of the fleet that is associated with the specified stack.
See also: AWS API Documentation
Request Syntax
response = client.list_associated_fleets(
StackName='string',
NextToken='string'
)
[REQUIRED]
The name of the stack.
dict
Response Syntax
{
'Names': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Names (list) --
The name of the fleet.
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.
list_associated_stacks(**kwargs)¶Retrieves the name of the stack with which the specified fleet is associated.
See also: AWS API Documentation
Request Syntax
response = client.list_associated_stacks(
FleetName='string',
NextToken='string'
)
[REQUIRED]
The name of the fleet.
dict
Response Syntax
{
'Names': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Names (list) --
The name of the stack.
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.
list_entitled_applications(**kwargs)¶Retrieves a list of entitled applications.
See also: AWS API Documentation
Request Syntax
response = client.list_entitled_applications(
StackName='string',
EntitlementName='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The name of the stack with which the entitlement is associated.
[REQUIRED]
The name of the entitlement.
dict
Response Syntax
{
'EntitledApplications': [
{
'ApplicationIdentifier': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EntitledApplications (list) --
The entitled applications.
(dict) --
The application associated to an entitlement. Access is controlled based on user attributes.
ApplicationIdentifier (string) --
The identifier of the application.
NextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.EntitlementNotFoundExceptionRetrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.
For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
{
'Tags': {
'string': 'string'
}
}
Response Structure
The information about the tags.
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptionstart_fleet(**kwargs)¶Starts the specified fleet.
See also: AWS API Documentation
Request Syntax
response = client.start_fleet(
Name='string'
)
[REQUIRED]
The name of the fleet.
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.RequestLimitExceededExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.ResourceNotAvailableExceptionAppStream.Client.exceptions.InvalidRoleExceptionstart_image_builder(**kwargs)¶Starts the specified image builder.
See also: AWS API Documentation
Request Syntax
response = client.start_image_builder(
Name='string',
AppstreamAgentVersion='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'|'AMAZON_LINUX2',
'IamRoleArn': 'string',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
'NetworkAccessConfiguration': {
'EniPrivateIpAddress': 'string',
'EniId': 'string'
},
'ImageBuilderErrors': [
{
'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'AppstreamAgentVersion': 'string',
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
]
}
}
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.
SecurityGroupIds (list) --
The identifiers of the security groups for the fleet or image builder.
InstanceType (string) --
The instance type for the image builder. The following instance types are available:
Platform (string) --
The operating system platform of the image builder.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
State (string) --
The state of the image builder.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
CreatedTime (datetime) --
The time stamp when the image builder was created.
EnableDefaultInternetAccess (boolean) --
Enables or disables default internet access for the image builder.
DomainJoinInfo (dict) --
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
DirectoryName (string) --
The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit for computer accounts.
NetworkAccessConfiguration (dict) --
Describes the network details of the fleet or image builder instance.
EniPrivateIpAddress (string) --
The private IP address of the elastic network interface that is attached to instances in your VPC.
EniId (string) --
The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
ImageBuilderErrors (list) --
The image builder errors.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent that is currently being used by the image builder.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
Exceptions
AppStream.Client.exceptions.ResourceNotAvailableExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.IncompatibleImageExceptionstop_fleet(**kwargs)¶Stops the specified fleet.
See also: AWS API Documentation
Request Syntax
response = client.stop_fleet(
Name='string'
)
[REQUIRED]
The name of the fleet.
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionstop_image_builder(**kwargs)¶Stops the specified image builder.
See also: AWS API Documentation
Request Syntax
response = client.stop_image_builder(
Name='string'
)
[REQUIRED]
The name of the image builder.
{
'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'|'AMAZON_LINUX2',
'IamRoleArn': 'string',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
'NetworkAccessConfiguration': {
'EniPrivateIpAddress': 'string',
'EniId': 'string'
},
'ImageBuilderErrors': [
{
'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'AppstreamAgentVersion': 'string',
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
]
}
}
Response Structure
Information about the image builder.
The name of the image builder.
The ARN for the image builder.
The ARN of the image from which this builder was created.
The description to display.
The image builder name to display.
The VPC configuration of the image builder.
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.
The identifiers of the security groups for the fleet or image builder.
The instance type for the image builder. The following instance types are available:
The operating system platform of the image builder.
The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
The state of the image builder.
The reason why the last state change occurred.
The state change reason code.
The state change reason message.
The time stamp when the image builder was created.
Enables or disables default internet access for the image builder.
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
The fully qualified name of the directory (for example, corp.example.com).
The distinguished name of the organizational unit for computer accounts.
Describes the network details of the fleet or image builder instance.
The private IP address of the elastic network interface that is attached to instances in your VPC.
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.
The image builder errors.
Describes a resource error.
The error code.
The error message.
The time the error occurred.
The version of the AppStream 2.0 agent that is currently being used by the image builder.
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
The type of interface endpoint.
The identifier (ID) of the VPC in which the interface endpoint is used.
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ConcurrentModificationExceptiontag_resource(**kwargs)¶Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.
Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.
To list the current tags for your resources, use ListTagsForResource . To disassociate tags from your resources, use UntagResource .
For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide .
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tags to associate. 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:
_ . : / = + - @
dict
Response Syntax
{}
Response Structure
Exceptions
AppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionuntag_resource(**kwargs)¶Disassociates one or more specified tags from the specified AppStream 2.0 resource.
To list the current tags for your resources, use ListTagsForResource .
For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide .
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tag keys for the tags to disassociate.
dict
Response Syntax
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptionupdate_application(**kwargs)¶Updates the specified application.
See also: AWS API Documentation
Request Syntax
response = client.update_application(
Name='string',
DisplayName='string',
Description='string',
IconS3Location={
'S3Bucket': 'string',
'S3Key': 'string'
},
LaunchPath='string',
WorkingDirectory='string',
LaunchParameters='string',
AppBlockArn='string',
AttributesToDelete=[
'LAUNCH_PARAMETERS'|'WORKING_DIRECTORY',
]
)
[REQUIRED]
The name of the application. This name is visible to users when display name is not specified.
The icon S3 location of the application.
The S3 bucket of the S3 object.
The S3 key of the S3 object.
The attributes to delete for an application.
dict
Response Syntax
{
'Application': {
'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'|'AMAZON_LINUX2',
],
'InstanceFamilies': [
'string',
],
'CreatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Application (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.
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.
Platforms (list) --
The platforms on which the application can run.
InstanceFamilies (list) --
The instance families for the application.
CreatedTime (datetime) --
The time at which the application was created within the app block.
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionupdate_directory_config(**kwargs)¶Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
See also: AWS API Documentation
Request Syntax
response = client.update_directory_config(
DirectoryName='string',
OrganizationalUnitDistinguishedNames=[
'string',
],
ServiceAccountCredentials={
'AccountName': 'string',
'AccountPassword': 'string'
},
CertificateBasedAuthProperties={
'Status': 'DISABLED'|'ENABLED'|'ENABLED_NO_DIRECTORY_LOGIN_FALLBACK',
'CertificateAuthorityArn': 'string'
}
)
[REQUIRED]
The name of the Directory Config object.
The distinguished names of the organizational units for computer accounts.
The credentials for the service account used by the fleet or image builder to connect to the directory.
The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
The password for the account.
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
The status of the certificate-based authentication properties.
The ARN of the AWS Certificate Manager Private CA resource.
dict
Response Syntax
{
'DirectoryConfig': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedNames': [
'string',
],
'ServiceAccountCredentials': {
'AccountName': 'string',
'AccountPassword': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'CertificateBasedAuthProperties': {
'Status': 'DISABLED'|'ENABLED'|'ENABLED_NO_DIRECTORY_LOGIN_FALLBACK',
'CertificateAuthorityArn': 'string'
}
}
}
Response Structure
(dict) --
DirectoryConfig (dict) --
Information about the Directory Config object.
DirectoryName (string) --
The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedNames (list) --
The distinguished names of the organizational units for computer accounts.
ServiceAccountCredentials (dict) --
The credentials for the service account used by the fleet or image builder to connect to the directory.
AccountName (string) --
The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
AccountPassword (string) --
The password for the account.
CreatedTime (datetime) --
The time the directory configuration was created.
CertificateBasedAuthProperties (dict) --
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
Status (string) --
The status of the certificate-based authentication properties.
CertificateAuthorityArn (string) --
The ARN of the AWS Certificate Manager Private CA resource.
Exceptions
AppStream.Client.exceptions.ResourceInUseExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.InvalidRoleExceptionupdate_entitlement(**kwargs)¶Updates the specified entitlement.
See also: AWS API Documentation
Request Syntax
response = client.update_entitlement(
Name='string',
StackName='string',
Description='string',
AppVisibility='ALL'|'ASSOCIATED',
Attributes=[
{
'Name': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the entitlement.
[REQUIRED]
The name of the stack with which the entitlement is associated.
The attributes of the entitlement.
An attribute associated with an entitlement. Application entitlements work by matching a supported SAML 2.0 attribute name to a value when a user identity federates to an Amazon AppStream 2.0 SAML application.
A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user identity federates into an Amazon AppStream 2.0 SAML application.
The following are valid values:
A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon AppStream 2.0 SAML application.
dict
Response Syntax
{
'Entitlement': {
'Name': 'string',
'StackName': 'string',
'Description': 'string',
'AppVisibility': 'ALL'|'ASSOCIATED',
'Attributes': [
{
'Name': 'string',
'Value': 'string'
},
],
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Entitlement (dict) --
The entitlement.
Name (string) --
The name of the entitlement.
StackName (string) --
The name of the stack with which the entitlement is associated.
Description (string) --
The description of the entitlement.
AppVisibility (string) --
Specifies whether all or selected apps are entitled.
Attributes (list) --
The attributes of the entitlement.
(dict) --
An attribute associated with an entitlement. Application entitlements work by matching a supported SAML 2.0 attribute name to a value when a user identity federates to an Amazon AppStream 2.0 SAML application.
Name (string) --
A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user identity federates into an Amazon AppStream 2.0 SAML application.
The following are valid values:
Value (string) --
A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon AppStream 2.0 SAML application.
CreatedTime (datetime) --
The time when the entitlement was created.
LastModifiedTime (datetime) --
The time when the entitlement was last modified.
Exceptions
AppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.EntitlementNotFoundExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionupdate_fleet(**kwargs)¶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:
DisplayName , ComputeCapacity , ImageARN , ImageName , IdleDisconnectTimeoutInSeconds , and DisconnectTimeoutInSeconds attributes.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
response = client.update_fleet(
ImageName='string',
ImageArn='string',
Name='string',
InstanceType='string',
ComputeCapacity={
'DesiredInstances': 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',
],
IamRoleArn='string',
StreamView='APP'|'DESKTOP',
Platform='WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
MaxConcurrentSessions=123,
UsbDeviceFilterStrings=[
'string',
],
SessionScriptS3Location={
'S3Bucket': 'string',
'S3Key': 'string'
}
)
The instance type to use when launching fleet instances. The following instance types are available:
The following instance types are available for Elastic fleets:
The desired capacity for the fleet. This is not allowed for Elastic fleets.
The desired number of streaming instances.
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.
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.
The identifiers of the security groups for the fleet or image builder.
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.
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 360000.
The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
The fully qualified name of the directory (for example, corp.example.com).
The distinguished name of the organizational unit for computer accounts.
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 3600. The default value is 0.
Note
If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
The fleet attributes to delete.
The fleet attribute.
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. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
The AppStream 2.0 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 .
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.
The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
The S3 bucket of the S3 object.
The S3 key of the S3 object.
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
},
'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',
'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'|'AMAZON_LINUX2',
'MaxConcurrentSessions': 123,
'UsbDeviceFilterStrings': [
'string',
],
'SessionScriptS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
}
}
}
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:
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.
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 360000.
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.
SecurityGroupIds (list) --
The identifiers of the security groups for the fleet or image builder.
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 3600. The default value is 0.
Note
If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
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. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
StreamView (string) --
The AppStream 2.0 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.
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.
Exceptions
AppStream.Client.exceptions.ResourceInUseExceptionAppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.RequestLimitExceededExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.InvalidRoleExceptionAppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.ResourceNotAvailableExceptionAppStream.Client.exceptions.InvalidParameterCombinationExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionAppStream.Client.exceptions.IncompatibleImageExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionupdate_image_permissions(**kwargs)¶Adds or updates permissions for the specified private image.
See also: AWS API Documentation
Request Syntax
response = client.update_image_permissions(
Name='string',
SharedAccountId='string',
ImagePermissions={
'allowFleet': True|False,
'allowImageBuilder': True|False
}
)
[REQUIRED]
The name of the private image.
[REQUIRED]
The 12-digit identifier of the AWS account for which you want add or update image permissions.
[REQUIRED]
The permissions for the image.
Indicates whether the image can be used for a fleet.
Indicates whether the image can be used for an image builder.
dict
Response Syntax
{}
Response Structure
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.ResourceNotAvailableExceptionAppStream.Client.exceptions.LimitExceededExceptionupdate_stack(**kwargs)¶Updates the specified fields for the specified stack.
See also: AWS API Documentation
Request Syntax
response = client.update_stack(
DisplayName='string',
Description='string',
Name='string',
StorageConnectors=[
{
'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
'ResourceIdentifier': 'string',
'Domains': [
'string',
]
},
],
DeleteStorageConnectors=True|False,
RedirectURL='string',
FeedbackURL='string',
AttributesToDelete=[
'STORAGE_CONNECTORS'|'STORAGE_CONNECTOR_HOMEFOLDERS'|'STORAGE_CONNECTOR_GOOGLE_DRIVE'|'STORAGE_CONNECTOR_ONE_DRIVE'|'REDIRECT_URL'|'FEEDBACK_URL'|'THEME_NAME'|'USER_SETTINGS'|'EMBED_HOST_DOMAINS'|'IAM_ROLE_ARN'|'ACCESS_ENDPOINTS'|'STREAMING_EXPERIENCE_SETTINGS',
],
UserSettings=[
{
'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE'|'DOMAIN_PASSWORD_SIGNIN'|'DOMAIN_SMART_CARD_SIGNIN',
'Permission': 'ENABLED'|'DISABLED'
},
],
ApplicationSettings={
'Enabled': True|False,
'SettingsGroup': 'string'
},
AccessEndpoints=[
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
EmbedHostDomains=[
'string',
],
StreamingExperienceSettings={
'PreferredProtocol': 'TCP'|'UDP'
}
)
[REQUIRED]
The name of the stack.
The storage connectors to enable.
Describes a connector that enables persistent storage for users.
The type of storage connector.
The ARN of the storage connector.
The names of the domains for the account.
The stack attributes to delete.
The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
The action that is enabled or disabled.
Indicates whether the action is enabled or disabled.
The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
Enables or disables persistent application settings for users during their streaming sessions.
The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.
The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
The type of interface endpoint.
The identifier (ID) of the VPC in which the interface endpoint is used.
The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
The preferred protocol that you want to use while streaming your application.
dict
Response Syntax
{
'Stack': {
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'DisplayName': 'string',
'CreatedTime': datetime(2015, 1, 1),
'StorageConnectors': [
{
'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
'ResourceIdentifier': 'string',
'Domains': [
'string',
]
},
],
'RedirectURL': 'string',
'FeedbackURL': 'string',
'StackErrors': [
{
'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string'
},
],
'UserSettings': [
{
'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE'|'DOMAIN_PASSWORD_SIGNIN'|'DOMAIN_SMART_CARD_SIGNIN',
'Permission': 'ENABLED'|'DISABLED'
},
],
'ApplicationSettings': {
'Enabled': True|False,
'SettingsGroup': 'string',
'S3BucketName': 'string'
},
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
'EmbedHostDomains': [
'string',
],
'StreamingExperienceSettings': {
'PreferredProtocol': 'TCP'|'UDP'
}
}
}
Response Structure
(dict) --
Stack (dict) --
Information about the stack.
Arn (string) --
The ARN of the stack.
Name (string) --
The name of the stack.
Description (string) --
The description to display.
DisplayName (string) --
The stack name to display.
CreatedTime (datetime) --
The time the stack was created.
StorageConnectors (list) --
The storage connectors to enable.
(dict) --
Describes a connector that enables persistent storage for users.
ConnectorType (string) --
The type of storage connector.
ResourceIdentifier (string) --
The ARN of the storage connector.
Domains (list) --
The names of the domains for the account.
RedirectURL (string) --
The URL that users are redirected to after their streaming session ends.
FeedbackURL (string) --
The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
StackErrors (list) --
The errors for the stack.
(dict) --
Describes a stack error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
UserSettings (list) --
The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
(dict) --
Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
Action (string) --
The action that is enabled or disabled.
Permission (string) --
Indicates whether the action is enabled or disabled.
ApplicationSettings (dict) --
The persistent application settings for users of the stack.
Enabled (boolean) --
Specifies whether persistent application settings are enabled for users during their streaming sessions.
SettingsGroup (string) --
The path prefix for the S3 bucket where users’ persistent application settings are stored.
S3BucketName (string) --
The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
EmbedHostDomains (list) --
The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
StreamingExperienceSettings (dict) --
The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
PreferredProtocol (string) --
The preferred protocol that you want to use while streaming your application.
Exceptions
AppStream.Client.exceptions.ResourceNotFoundExceptionAppStream.Client.exceptions.ResourceInUseExceptionAppStream.Client.exceptions.InvalidRoleExceptionAppStream.Client.exceptions.InvalidParameterCombinationExceptionAppStream.Client.exceptions.LimitExceededExceptionAppStream.Client.exceptions.InvalidAccountStatusExceptionAppStream.Client.exceptions.IncompatibleImageExceptionAppStream.Client.exceptions.OperationNotPermittedExceptionAppStream.Client.exceptions.ConcurrentModificationExceptionThe available paginators are:
AppStream.Paginator.DescribeDirectoryConfigsAppStream.Paginator.DescribeFleetsAppStream.Paginator.DescribeImageBuildersAppStream.Paginator.DescribeImagesAppStream.Paginator.DescribeSessionsAppStream.Paginator.DescribeStacksAppStream.Paginator.DescribeUserStackAssociationsAppStream.Paginator.DescribeUsersAppStream.Paginator.ListAssociatedFleetsAppStream.Paginator.ListAssociatedStacksAppStream.Paginator.DescribeDirectoryConfigs¶paginator = client.get_paginator('describe_directory_configs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppStream.Client.describe_directory_configs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DirectoryNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The directory names.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DirectoryConfigs': [
{
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedNames': [
'string',
],
'ServiceAccountCredentials': {
'AccountName': 'string',
'AccountPassword': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'CertificateBasedAuthProperties': {
'Status': 'DISABLED'|'ENABLED'|'ENABLED_NO_DIRECTORY_LOGIN_FALLBACK',
'CertificateAuthorityArn': 'string'
}
},
],
}
Response Structure
(dict) --
DirectoryConfigs (list) --
Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.
(dict) --
Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
DirectoryName (string) --
The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedNames (list) --
The distinguished names of the organizational units for computer accounts.
ServiceAccountCredentials (dict) --
The credentials for the service account used by the fleet or image builder to connect to the directory.
AccountName (string) --
The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
AccountPassword (string) --
The password for the account.
CreatedTime (datetime) --
The time the directory configuration was created.
CertificateBasedAuthProperties (dict) --
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
Status (string) --
The status of the certificate-based authentication properties.
CertificateAuthorityArn (string) --
The ARN of the AWS Certificate Manager Private CA resource.
AppStream.Paginator.DescribeFleets¶paginator = client.get_paginator('describe_fleets')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppStream.Client.describe_fleets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Names=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
The names of the fleets to describe.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
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
},
'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',
'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'|'AMAZON_LINUX2',
'MaxConcurrentSessions': 123,
'UsbDeviceFilterStrings': [
'string',
],
'SessionScriptS3Location': {
'S3Bucket': 'string',
'S3Key': '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:
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.
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 360000.
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.
SecurityGroupIds (list) --
The identifiers of the security groups for the fleet or image builder.
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 3600. The default value is 0.
Note
If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
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. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
StreamView (string) --
The AppStream 2.0 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.
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.
AppStream.Paginator.DescribeImageBuilders¶paginator = client.get_paginator('describe_image_builders')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppStream.Client.describe_image_builders().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Names=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The names of the image builders to describe.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
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'|'AMAZON_LINUX2',
'IamRoleArn': 'string',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED'|'UPDATING'|'PENDING_QUALIFICATION',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
'NetworkAccessConfiguration': {
'EniPrivateIpAddress': 'string',
'EniId': 'string'
},
'ImageBuilderErrors': [
{
'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
],
'AppstreamAgentVersion': 'string',
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
]
},
],
}
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.
SecurityGroupIds (list) --
The identifiers of the security groups for the fleet or image builder.
InstanceType (string) --
The instance type for the image builder. The following instance types are available:
Platform (string) --
The operating system platform of the image builder.
IamRoleArn (string) --
The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
State (string) --
The state of the image builder.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
CreatedTime (datetime) --
The time stamp when the image builder was created.
EnableDefaultInternetAccess (boolean) --
Enables or disables default internet access for the image builder.
DomainJoinInfo (dict) --
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
DirectoryName (string) --
The fully qualified name of the directory (for example, corp.example.com).
OrganizationalUnitDistinguishedName (string) --
The distinguished name of the organizational unit for computer accounts.
NetworkAccessConfiguration (dict) --
Describes the network details of the fleet or image builder instance.
EniPrivateIpAddress (string) --
The private IP address of the elastic network interface that is attached to instances in your VPC.
EniId (string) --
The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
ImageBuilderErrors (list) --
The image builder errors.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent that is currently being used by the image builder.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
AppStream.Paginator.DescribeImages¶paginator = client.get_paginator('describe_images')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppStream.Client.describe_images().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Names=[
'string',
],
Arns=[
'string',
],
Type='PUBLIC'|'PRIVATE'|'SHARED',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The names of the public or private images to describe.
The ARNs of the public, private, and shared images to describe.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Images': [
{
'Name': 'string',
'Arn': 'string',
'BaseImageArn': 'string',
'DisplayName': 'string',
'State': 'PENDING'|'AVAILABLE'|'FAILED'|'COPYING'|'DELETING'|'CREATING'|'IMPORTING',
'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
'ImageBuilderSupported': True|False,
'ImageBuilderName': 'string',
'Platform': 'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
'Description': 'string',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE',
'Message': 'string'
},
'Applications': [
{
'Name': 'string',
'DisplayName': 'string',
'IconURL': 'string',
'LaunchPath': 'string',
'LaunchParameters': 'string',
'Enabled': True|False,
'Metadata': {
'string': 'string'
},
'WorkingDirectory': 'string',
'Description': 'string',
'Arn': 'string',
'AppBlockArn': 'string',
'IconS3Location': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'Platforms': [
'WINDOWS'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'AMAZON_LINUX2',
],
'InstanceFamilies': [
'string',
],
'CreatedTime': datetime(2015, 1, 1)
},
],
'CreatedTime': datetime(2015, 1, 1),
'PublicBaseImageReleasedDate': datetime(2015, 1, 1),
'AppstreamAgentVersion': 'string',
'ImagePermissions': {
'allowFleet': True|False,
'allowImageBuilder': True|False
},
'ImageErrors': [
{
'ErrorCode': 'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'IAM_SERVICE_ROLE_IS_MISSING'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'FLEET_STOPPED'|'FLEET_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string',
'ErrorTimestamp': datetime(2015, 1, 1)
},
]
},
],
}
Response Structure
(dict) --
Images (list) --
Information about the images.
(dict) --
Describes an image.
Name (string) --
The name of the image.
Arn (string) --
The ARN of the image.
BaseImageArn (string) --
The ARN of the image from which this image was created.
DisplayName (string) --
The image name to display.
State (string) --
The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE . If image creation fails, the state is FAILED .
Visibility (string) --
Indicates whether the image is public or private.
ImageBuilderSupported (boolean) --
Indicates whether an image builder can be launched from this image.
ImageBuilderName (string) --
The name of the image builder that was used to create the private image. If the image is shared, this value is null.
Platform (string) --
The operating system platform of the image.
Description (string) --
The description to display.
StateChangeReason (dict) --
The reason why the last state change occurred.
Code (string) --
The state change reason code.
Message (string) --
The state change reason message.
Applications (list) --
The applications associated with the image.
(dict) --
Describes an application in the application catalog.
Name (string) --
The name of the application.
DisplayName (string) --
The application name to display.
IconURL (string) --
The URL for the application icon. This URL might be time-limited.
LaunchPath (string) --
The path to the application executable in the instance.
LaunchParameters (string) --
The arguments that are passed to the application at launch.
Enabled (boolean) --
If there is a problem, the application can be disabled after image creation.
Metadata (dict) --
Additional attributes that describe the application.
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.
Platforms (list) --
The platforms on which the application can run.
InstanceFamilies (list) --
The instance families for the application.
CreatedTime (datetime) --
The time at which the application was created within the app block.
CreatedTime (datetime) --
The time the image was created.
PublicBaseImageReleasedDate (datetime) --
The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
AppstreamAgentVersion (string) --
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
ImagePermissions (dict) --
The permissions to provide to the destination AWS account for the specified image.
allowFleet (boolean) --
Indicates whether the image can be used for a fleet.
allowImageBuilder (boolean) --
Indicates whether the image can be used for an image builder.
ImageErrors (list) --
Describes the errors that are returned when a new image can't be created.
(dict) --
Describes a resource error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
ErrorTimestamp (datetime) --
The time the error occurred.
AppStream.Paginator.DescribeSessions¶paginator = client.get_paginator('describe_sessions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppStream.Client.describe_sessions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
StackName='string',
FleetName='string',
UserId='string',
AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the stack. This value is case-sensitive.
[REQUIRED]
The name of the fleet. This value is case-sensitive.
API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Sessions': [
{
'Id': 'string',
'UserId': 'string',
'StackName': 'string',
'FleetName': 'string',
'State': 'ACTIVE'|'PENDING'|'EXPIRED',
'ConnectionState': 'CONNECTED'|'NOT_CONNECTED',
'StartTime': datetime(2015, 1, 1),
'MaxExpirationTime': datetime(2015, 1, 1),
'AuthenticationType': 'API'|'SAML'|'USERPOOL'|'AWS_AD',
'NetworkAccessConfiguration': {
'EniPrivateIpAddress': 'string',
'EniId': 'string'
}
},
],
}
Response Structure
(dict) --
Sessions (list) --
Information about the streaming sessions.
(dict) --
Describes a streaming session.
Id (string) --
The identifier of the streaming session.
UserId (string) --
The identifier of the user for whom the session was created.
StackName (string) --
The name of the stack for the streaming session.
FleetName (string) --
The name of the fleet for the streaming session.
State (string) --
The current state of the streaming session.
ConnectionState (string) --
Specifies whether a user is connected to the streaming session.
StartTime (datetime) --
The time when a streaming instance is dedicated for the user.
MaxExpirationTime (datetime) --
The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime , when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.
AuthenticationType (string) --
The authentication method. The user is authenticated using a streaming URL (API ) or SAML 2.0 federation (SAML ).
NetworkAccessConfiguration (dict) --
The network details for the streaming session.
EniPrivateIpAddress (string) --
The private IP address of the elastic network interface that is attached to instances in your VPC.
EniId (string) --
The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
AppStream.Paginator.DescribeStacks¶paginator = client.get_paginator('describe_stacks')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppStream.Client.describe_stacks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Names=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
The names of the stacks to describe.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Stacks': [
{
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'DisplayName': 'string',
'CreatedTime': datetime(2015, 1, 1),
'StorageConnectors': [
{
'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
'ResourceIdentifier': 'string',
'Domains': [
'string',
]
},
],
'RedirectURL': 'string',
'FeedbackURL': 'string',
'StackErrors': [
{
'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
'ErrorMessage': 'string'
},
],
'UserSettings': [
{
'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE'|'DOMAIN_PASSWORD_SIGNIN'|'DOMAIN_SMART_CARD_SIGNIN',
'Permission': 'ENABLED'|'DISABLED'
},
],
'ApplicationSettings': {
'Enabled': True|False,
'SettingsGroup': 'string',
'S3BucketName': 'string'
},
'AccessEndpoints': [
{
'EndpointType': 'STREAMING',
'VpceId': 'string'
},
],
'EmbedHostDomains': [
'string',
],
'StreamingExperienceSettings': {
'PreferredProtocol': 'TCP'|'UDP'
}
},
],
}
Response Structure
(dict) --
Stacks (list) --
Information about the stacks.
(dict) --
Describes a stack.
Arn (string) --
The ARN of the stack.
Name (string) --
The name of the stack.
Description (string) --
The description to display.
DisplayName (string) --
The stack name to display.
CreatedTime (datetime) --
The time the stack was created.
StorageConnectors (list) --
The storage connectors to enable.
(dict) --
Describes a connector that enables persistent storage for users.
ConnectorType (string) --
The type of storage connector.
ResourceIdentifier (string) --
The ARN of the storage connector.
Domains (list) --
The names of the domains for the account.
RedirectURL (string) --
The URL that users are redirected to after their streaming session ends.
FeedbackURL (string) --
The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
StackErrors (list) --
The errors for the stack.
(dict) --
Describes a stack error.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
UserSettings (list) --
The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
(dict) --
Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
Action (string) --
The action that is enabled or disabled.
Permission (string) --
Indicates whether the action is enabled or disabled.
ApplicationSettings (dict) --
The persistent application settings for users of the stack.
Enabled (boolean) --
Specifies whether persistent application settings are enabled for users during their streaming sessions.
SettingsGroup (string) --
The path prefix for the S3 bucket where users’ persistent application settings are stored.
S3BucketName (string) --
The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.
AccessEndpoints (list) --
The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
(dict) --
Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
EndpointType (string) --
The type of interface endpoint.
VpceId (string) --
The identifier (ID) of the VPC in which the interface endpoint is used.
EmbedHostDomains (list) --
The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
StreamingExperienceSettings (dict) --
The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
PreferredProtocol (string) --
The preferred protocol that you want to use while streaming your application.
AppStream.Paginator.DescribeUserStackAssociations¶paginator = client.get_paginator('describe_user_stack_associations')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppStream.Client.describe_user_stack_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
StackName='string',
UserName='string',
AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The email address of the user who is associated with the stack.
Note
Users' email addresses are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'UserStackAssociations': [
{
'StackName': 'string',
'UserName': 'string',
'AuthenticationType': 'API'|'SAML'|'USERPOOL'|'AWS_AD',
'SendEmailNotification': True|False
},
],
}
Response Structure
(dict) --
UserStackAssociations (list) --
The UserStackAssociation objects.
(dict) --
Describes a user in the user pool and the associated stack.
StackName (string) --
The name of the stack that is associated with the user.
UserName (string) --
The email address of the user who is associated with the stack.
Note
Users' email addresses are case-sensitive.
AuthenticationType (string) --
The authentication type for the user.
SendEmailNotification (boolean) --
Specifies whether a welcome email is sent to a user after the user is created in the user pool.
AppStream.Paginator.DescribeUsers¶paginator = client.get_paginator('describe_users')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppStream.Client.describe_users().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The authentication type for the users in the user pool to describe. You must specify USERPOOL.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Users': [
{
'Arn': 'string',
'UserName': 'string',
'Enabled': True|False,
'Status': 'string',
'FirstName': 'string',
'LastName': 'string',
'CreatedTime': datetime(2015, 1, 1),
'AuthenticationType': 'API'|'SAML'|'USERPOOL'|'AWS_AD'
},
],
}
Response Structure
(dict) --
Users (list) --
Information about users in the user pool.
(dict) --
Describes a user in the user pool.
Arn (string) --
The ARN of the user.
UserName (string) --
The email address of the user.
Note
Users' email addresses are case-sensitive.
Enabled (boolean) --
Specifies whether the user in the user pool is enabled.
Status (string) --
The status of the user in the user pool. The status can be one of the following:
FirstName (string) --
The first name, or given name, of the user.
LastName (string) --
The last name, or surname, of the user.
CreatedTime (datetime) --
The date and time the user was created in the user pool.
AuthenticationType (string) --
The authentication type for the user.
AppStream.Paginator.ListAssociatedFleets¶paginator = client.get_paginator('list_associated_fleets')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppStream.Client.list_associated_fleets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
StackName='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the stack.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Names': [
'string',
],
}
Response Structure
(dict) --
Names (list) --
The name of the fleet.
AppStream.Paginator.ListAssociatedStacks¶paginator = client.get_paginator('list_associated_stacks')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppStream.Client.list_associated_stacks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FleetName='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the fleet.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Names': [
'string',
],
}
Response Structure
(dict) --
Names (list) --
The name of the stack.
The available waiters are:
AppStream.Waiter.FleetStarted¶waiter = client.get_waiter('fleet_started')
wait(**kwargs)¶Polls AppStream.Client.describe_fleets() every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Names=[
'string',
],
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The names of the fleets to describe.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 40
None
AppStream.Waiter.FleetStopped¶waiter = client.get_waiter('fleet_stopped')
wait(**kwargs)¶Polls AppStream.Client.describe_fleets() every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Names=[
'string',
],
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The names of the fleets to describe.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 40
None