Table of Contents
A low-level client representing Amazon AppStream:
import boto3
client = boto3.client('appstream')
These are the available methods:
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
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',
'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.
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',
'SendEmailNotification': True|False
},
'ErrorCode': 'STACK_NOT_FOUND'|'USER_NAME_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.
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.
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',
'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.
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',
'SendEmailNotification': True|False
},
'ErrorCode': 'STACK_NOT_FOUND'|'USER_NAME_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.
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.
Check if an operation can be paginated.
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.
Creates a Directory Config object in 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.create_directory_config(
DirectoryName='string',
OrganizationalUnitDistinguishedNames=[
'string',
],
ServiceAccountCredentials={
'AccountName': 'string',
'AccountPassword': '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.
[REQUIRED]
The credentials for the service account used by the streaming instance 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.
dict
Response Syntax
{
'DirectoryConfig': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedNames': [
'string',
],
'ServiceAccountCredentials': {
'AccountName': 'string',
'AccountPassword': 'string'
},
'CreatedTime': datetime(2015, 1, 1)
}
}
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 streaming instance 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.
Creates a fleet. A fleet consists of streaming instances that run a specified image.
See also: AWS API Documentation
Request Syntax
response = client.create_fleet(
Name='string',
ImageName='string',
ImageArn='string',
InstanceType='string',
FleetType='ALWAYS_ON'|'ON_DEMAND',
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'
}
)
[REQUIRED]
A unique name for the fleet.
[REQUIRED]
The instance type to use when launching fleet instances. The following instance types are available:
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.
[REQUIRED]
The desired capacity for the fleet.
The desired number of streaming instances.
The VPC configuration for the fleet.
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 two subnets. Image builder instances use one subnet.
The identifiers of the security groups for the fleet or image builder.
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 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.
For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide .
dict
Response Syntax
{
'Fleet': {
'Arn': 'string',
'Name': 'string',
'DisplayName': 'string',
'Description': 'string',
'ImageName': 'string',
'ImageArn': 'string',
'InstanceType': 'string',
'FleetType': 'ALWAYS_ON'|'ON_DEMAND',
'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'|'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'|'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'
}
}
}
Response Structure
(dict) --
Fleet (dict) --
Information about the fleet.
Arn (string) --
The 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.
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 time that a streaming session can run, in seconds. Specify a value between 600 and 360000.
DisconnectTimeoutInSeconds (integer) --
The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 360000. By default, this value is 900 seconds (15 minutes).
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 two 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.
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',
]
},
EnableDefaultInternetAccess=True|False,
DomainJoinInfo={
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': 'string'
},
AppstreamAgentVersion='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
A unique name for the image builder.
[REQUIRED]
The instance type to use when launching the image builder.
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 two subnets. Image builder instances use one subnet.
The identifiers of the security groups for the fleet or 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.
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=.
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 Developer Guide .
dict
Response Syntax
{
'ImageBuilder': {
'Name': 'string',
'Arn': 'string',
'ImageArn': 'string',
'Description': 'string',
'DisplayName': 'string',
'VpcConfig': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'InstanceType': 'string',
'Platform': 'WINDOWS',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': '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'|'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'|'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'
}
}
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 two 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.
Platform (string) --
The operating system platform of the image builder.
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.
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.
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.
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',
'Permission': 'ENABLED'|'DISABLED'
},
],
ApplicationSettings={
'Enabled': True|False,
'SettingsGroup': 'string'
},
Tags={
'string': 'string'
}
)
[REQUIRED]
The name of the stack.
The storage connectors to enable.
Describes a connector to enable 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.
For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide .
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',
'Permission': 'ENABLED'|'DISABLED'
},
],
'ApplicationSettings': {
'Enabled': True|False,
'SettingsGroup': 'string',
'S3BucketName': 'string'
}
}
}
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 to enable 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.
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.
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'
)
[REQUIRED]
The email address of the user.
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
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
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
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',
'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
'ImageBuilderSupported': True|False,
'Platform': 'WINDOWS',
'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'
}
},
],
'CreatedTime': datetime(2015, 1, 1),
'PublicBaseImageReleasedDate': datetime(2015, 1, 1),
'AppstreamAgentVersion': 'string',
'ImagePermissions': {
'allowFleet': True|False,
'allowImageBuilder': True|False
}
}
}
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 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 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.
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',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': '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'|'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'|'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'
}
}
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 two 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 operating system platform of the image builder.
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.
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.
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
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
Deletes a user from the user pool.
See also: AWS API Documentation
Request Syntax
response = client.delete_user(
UserName='string',
AuthenticationType='API'|'SAML'|'USERPOOL'
)
[REQUIRED]
The email address of the user.
[REQUIRED]
The authentication type for the user. You must specify USERPOOL.
dict
Response Syntax
{}
Response Structure
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 information required to join streaming instances to an Active Directory domain.
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)
},
],
'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 for the directory used to join a streaming instance to a Microsoft Active Directory domain.
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 streaming instance 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.
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.
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',
'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'|'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'|'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'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Fleets (list) --
Information about the fleets.
(dict) --
Describes the parameters for a fleet.
Arn (string) --
The 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.
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 time that a streaming session can run, in seconds. Specify a value between 600 and 360000.
DisconnectTimeoutInSeconds (integer) --
The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 360000. By default, this value is 900 seconds (15 minutes).
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 two 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.
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.
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',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': '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'|'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'|'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'
},
],
'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 two 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.
Platform (string) --
The operating system platform of the image builder.
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.
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.
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.
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.
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',
'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
'ImageBuilderSupported': True|False,
'Platform': 'WINDOWS',
'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'
}
},
],
'CreatedTime': datetime(2015, 1, 1),
'PublicBaseImageReleasedDate': datetime(2015, 1, 1),
'AppstreamAgentVersion': 'string',
'ImagePermissions': {
'allowFleet': True|False,
'allowImageBuilder': True|False
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Images (list) --
Information about the images.
(dict) --
Describes an image.
Name (string) --
The name of the image.
Arn (string) --
The ARN of the image.
BaseImageArn (string) --
The ARN of the image from which this image was created.
DisplayName (string) --
The image name to display.
State (string) --
The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE . If image creation fails, the state is FAILED .
Visibility (string) --
Indicates whether the image is public or private.
ImageBuilderSupported (boolean) --
Indicates whether an image builder can be launched from this image.
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.
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.
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.
Retrieves a list that describes the active streaming sessions for a specified stack and fleet. If a value for 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'
)
[REQUIRED]
The name of the stack. This value is case-sensitive.
[REQUIRED]
The name of the fleet. This value is case-sensitive.
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',
'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 ), SAML 2.0 federation (SAML ), or the AppStream 2.0 user pool (USERPOOL ). The default is to authenticate users using a streaming URL.
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.
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',
'Permission': 'ENABLED'|'DISABLED'
},
],
'ApplicationSettings': {
'Enabled': True|False,
'SettingsGroup': 'string',
'S3BucketName': 'string'
}
},
],
'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 to enable 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.
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.
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',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'UserStackAssociations': [
{
'StackName': 'string',
'UserName': 'string',
'AuthenticationType': 'API'|'SAML'|'USERPOOL',
'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.
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.
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',
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'
},
],
'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.
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.
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'
)
[REQUIRED]
The email address of the user.
[REQUIRED]
The authentication type for the user. You must specify USERPOOL.
dict
Response Syntax
{}
Response Structure
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
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'
)
[REQUIRED]
The email address of the user.
[REQUIRED]
The authentication type for the user. You must specify USERPOOL.
dict
Response Syntax
{}
Response Structure
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
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
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.
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.
Retrieves 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 Developer 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.
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
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',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': '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'|'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'|'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'
}
}
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 two 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.
Platform (string) --
The operating system platform of the image builder.
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.
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.
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
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',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': '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'|'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'|'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'
}
}
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 two 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 operating system platform of the image builder.
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.
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.
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 Developer 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.
dict
Response Syntax
{}
Response Structure
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 Developer 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
Updates the specified Directory Config object in 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.update_directory_config(
DirectoryName='string',
OrganizationalUnitDistinguishedNames=[
'string',
],
ServiceAccountCredentials={
'AccountName': 'string',
'AccountPassword': '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 streaming instance 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.
dict
Response Syntax
{
'DirectoryConfig': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedNames': [
'string',
],
'ServiceAccountCredentials': {
'AccountName': 'string',
'AccountPassword': 'string'
},
'CreatedTime': datetime(2015, 1, 1)
}
}
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 streaming instance 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.
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 DisplayName and ComputeCapacity attributes. If the fleet is in the STARTING or STOPPING 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'
},
AttributesToDelete=[
'VPC_CONFIGURATION'|'VPC_CONFIGURATION_SECURITY_GROUP_IDS'|'DOMAIN_JOIN_INFO',
]
)
The instance type to use when launching fleet instances. The following instance types are available:
The desired capacity for the fleet.
The desired number of streaming instances.
The VPC configuration for the fleet.
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 two subnets. Image builder instances use one subnet.
The identifiers of the security groups for the fleet or image builder.
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 fleet attributes to delete.
The fleet attribute.
dict
Response Syntax
{
'Fleet': {
'Arn': 'string',
'Name': 'string',
'DisplayName': 'string',
'Description': 'string',
'ImageName': 'string',
'ImageArn': 'string',
'InstanceType': 'string',
'FleetType': 'ALWAYS_ON'|'ON_DEMAND',
'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'|'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'|'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'
}
}
}
Response Structure
(dict) --
Fleet (dict) --
Information about the fleet.
Arn (string) --
The 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.
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 time that a streaming session can run, in seconds. Specify a value between 600 and 360000.
DisconnectTimeoutInSeconds (integer) --
The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 360000. By default, this value is 900 seconds (15 minutes).
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 two 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.
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
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',
],
UserSettings=[
{
'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE',
'Permission': 'ENABLED'|'DISABLED'
},
],
ApplicationSettings={
'Enabled': True|False,
'SettingsGroup': 'string'
}
)
[REQUIRED]
The name of the stack.
The storage connectors to enable.
Describes a connector to enable 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.
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',
'Permission': 'ENABLED'|'DISABLED'
},
],
'ApplicationSettings': {
'Enabled': True|False,
'SettingsGroup': 'string',
'S3BucketName': 'string'
}
}
}
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 to enable 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.
The available paginators are:
paginator = client.get_paginator('describe_directory_configs')
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)
},
],
}
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 for the directory used to join a streaming instance to a Microsoft Active Directory domain.
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 streaming instance 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.
paginator = client.get_paginator('describe_fleets')
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,
'PageSize': 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.
The size of each page.
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',
'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'|'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'|'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'
}
},
],
}
Response Structure
(dict) --
Fleets (list) --
Information about the fleets.
(dict) --
Describes the parameters for a fleet.
Arn (string) --
The 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.
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 time that a streaming session can run, in seconds. Specify a value between 600 and 360000.
DisconnectTimeoutInSeconds (integer) --
The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 360000. By default, this value is 900 seconds (15 minutes).
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 two 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.
paginator = client.get_paginator('describe_image_builders')
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',
'State': 'PENDING'|'UPDATING_AGENT'|'RUNNING'|'STOPPING'|'STOPPED'|'REBOOTING'|'SNAPSHOTTING'|'DELETING'|'FAILED',
'StateChangeReason': {
'Code': 'INTERNAL_ERROR'|'IMAGE_UNAVAILABLE',
'Message': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'EnableDefaultInternetAccess': True|False,
'DomainJoinInfo': {
'DirectoryName': 'string',
'OrganizationalUnitDistinguishedName': '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'|'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'|'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'
},
],
}
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 two 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.
Platform (string) --
The operating system platform of the image builder.
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.
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.
paginator = client.get_paginator('describe_images')
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',
'Visibility': 'PUBLIC'|'PRIVATE'|'SHARED',
'ImageBuilderSupported': True|False,
'Platform': 'WINDOWS',
'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'
}
},
],
'CreatedTime': datetime(2015, 1, 1),
'PublicBaseImageReleasedDate': datetime(2015, 1, 1),
'AppstreamAgentVersion': 'string',
'ImagePermissions': {
'allowFleet': True|False,
'allowImageBuilder': True|False
}
},
],
}
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.
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.
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.
paginator = client.get_paginator('describe_sessions')
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',
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.
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',
'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 ), SAML 2.0 federation (SAML ), or the AppStream 2.0 user pool (USERPOOL ). The default is to authenticate users using a streaming URL.
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.
paginator = client.get_paginator('describe_stacks')
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,
'PageSize': 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.
The size of each page.
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',
'Permission': 'ENABLED'|'DISABLED'
},
],
'ApplicationSettings': {
'Enabled': True|False,
'SettingsGroup': 'string',
'S3BucketName': '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 to enable 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.
paginator = client.get_paginator('describe_user_stack_associations')
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',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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',
'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.
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.
paginator = client.get_paginator('describe_users')
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',
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'
},
],
}
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.
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.
paginator = client.get_paginator('list_associated_fleets')
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,
'PageSize': 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.
The size of each page.
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.
paginator = client.get_paginator('list_associated_stacks')
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,
'PageSize': 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.
The size of each page.
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:
waiter = client.get_waiter('fleet_started')
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
waiter = client.get_waiter('fleet_stopped')
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