AppStream class

This is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand. To learn more about AppStream 2.0, see the following resources:

Constructors

AppStream({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

associateFleet({required String fleetName, required String stackName}) → Future<void>

Associates the specified fleet with the specified stack.

batchAssociateUserStack({required List<UserStackAssociation> userStackAssociations}) → Future<BatchAssociateUserStackResult>

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.

batchDisassociateUserStack({required List<UserStackAssociation> userStackAssociations}) → Future<BatchDisassociateUserStackResult>

Disassociates the specified users from the specified stacks.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

copyImage({required String destinationImageName, required String destinationRegion, required String sourceImageName, String? destinationImageDescription}) → Future<CopyImageResponse>

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.

createDirectoryConfig({required String directoryName, required List<String> organizationalUnitDistinguishedNames, ServiceAccountCredentials? serviceAccountCredentials}) → Future<CreateDirectoryConfigResult>

Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

createFleet({required ComputeCapacity computeCapacity, required String instanceType, required String name, String? description, int? disconnectTimeoutInSeconds, String? displayName, DomainJoinInfo? domainJoinInfo, bool? enableDefaultInternetAccess, FleetType? fleetType, String? iamRoleArn, int? idleDisconnectTimeoutInSeconds, String? imageArn, String? imageName, int? maxUserDurationInSeconds, StreamView? streamView, Map<String, String>? tags, VpcConfig? vpcConfig}) → Future<CreateFleetResult>

Creates a fleet. A fleet consists of streaming instances that run a specified image.

createImageBuilder({required String instanceType, required String name, List<AccessEndpoint>? accessEndpoints, String? appstreamAgentVersion, String? description, String? displayName, DomainJoinInfo? domainJoinInfo, bool? enableDefaultInternetAccess, String? iamRoleArn, String? imageArn, String? imageName, Map<String, String>? tags, VpcConfig? vpcConfig}) → Future<CreateImageBuilderResult>

Creates an image builder. An image builder is a virtual machine that is used to create an image.

createImageBuilderStreamingURL({required String name, int? validity}) → Future<CreateImageBuilderStreamingURLResult>

Creates a URL to start an image builder streaming session.

createStack({required String name, List<AccessEndpoint>? accessEndpoints, ApplicationSettings? applicationSettings, String? description, String? displayName, List<String>? embedHostDomains, String? feedbackURL, String? redirectURL, List<StorageConnector>? storageConnectors, Map<String, String>? tags, List<UserSetting>? userSettings}) → Future<CreateStackResult>

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

createStreamingURL({required String fleetName, required String stackName, required String userId, String? applicationId, String? sessionContext, int? validity}) → Future<CreateStreamingURLResult>

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.

createUsageReportSubscription() → Future<CreateUsageReportSubscriptionResult>

Creates a usage report subscription. Usage reports are generated daily.

createUser({required AuthenticationType authenticationType, required String userName, String? firstName, String? lastName, MessageAction? messageAction}) → Future<void>

Creates a new user in the user pool.

deleteDirectoryConfig({required String directoryName}) → Future<void>

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.

deleteFleet({required String name}) → Future<void>

Deletes the specified fleet.

deleteImage({required String name}) → Future<DeleteImageResult>

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.

deleteImageBuilder({required String name}) → Future<DeleteImageBuilderResult>

Deletes the specified image builder and releases the capacity.

deleteImagePermissions({required String name, required String sharedAccountId}) → Future<void>

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.

deleteStack({required String name}) → Future<void>

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.

deleteUsageReportSubscription() → Future<void>

Disables usage report generation.

deleteUser({required AuthenticationType authenticationType, required String userName}) → Future<void>

Deletes a user from the user pool.

describeDirectoryConfigs({List<String>? directoryNames, int? maxResults, String? nextToken}) → Future<DescribeDirectoryConfigsResult>

Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

describeFleets({List<String>? names, String? nextToken}) → Future<DescribeFleetsResult>

Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.

describeImageBuilders({int? maxResults, List<String>? names, String? nextToken}) → Future<DescribeImageBuildersResult>

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.

describeImagePermissions({required String name, int? maxResults, String? nextToken, List<String>? sharedAwsAccountIds}) → Future<DescribeImagePermissionsResult>

Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.

describeImages({List<String>? arns, int? maxResults, List<String>? names, String? nextToken, VisibilityType? type}) → Future<DescribeImagesResult>

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.

describeSessions({required String fleetName, required String stackName, AuthenticationType? authenticationType, int? limit, String? nextToken, String? userId}) → Future<DescribeSessionsResult>

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.

describeStacks({List<String>? names, String? nextToken}) → Future<DescribeStacksResult>

Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

describeUsageReportSubscriptions({int? maxResults, String? nextToken}) → Future<DescribeUsageReportSubscriptionsResult>

Retrieves a list that describes one or more usage report subscriptions.

describeUsers({required AuthenticationType authenticationType, int? maxResults, String? nextToken}) → Future<DescribeUsersResult>

Retrieves a list that describes one or more specified users in the user pool.

describeUserStackAssociations({AuthenticationType? authenticationType, int? maxResults, String? nextToken, String? stackName, String? userName}) → Future<DescribeUserStackAssociationsResult>

Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:

disableUser({required AuthenticationType authenticationType, required String userName}) → Future<void>

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.

disassociateFleet({required String fleetName, required String stackName}) → Future<void>

Disassociates the specified fleet from the specified stack.

enableUser({required AuthenticationType authenticationType, required String userName}) → Future<void>

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.

expireSession({required String sessionId}) → Future<void>

Immediately stops the specified streaming session.

listAssociatedFleets({required String stackName, String? nextToken}) → Future<ListAssociatedFleetsResult>

Retrieves the name of the fleet that is associated with the specified stack.

listAssociatedStacks({required String fleetName, String? nextToken}) → Future<ListAssociatedStacksResult>

Retrieves the name of the stack with which the specified fleet is associated.

listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>

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.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

startFleet({required String name}) → Future<void>

Starts the specified fleet.

startImageBuilder({required String name, String? appstreamAgentVersion}) → Future<StartImageBuilderResult>

Starts the specified image builder.

stopFleet({required String name}) → Future<void>

Stops the specified fleet.

stopImageBuilder({required String name}) → Future<StopImageBuilderResult>

Stops the specified image builder.

tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>

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.

toString() → String

A string representation of this object.

inherited

untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>

Disassociates one or more specified tags from the specified AppStream 2.0 resource.

updateDirectoryConfig({required String directoryName, List<String>? organizationalUnitDistinguishedNames, ServiceAccountCredentials? serviceAccountCredentials}) → Future<UpdateDirectoryConfigResult>

Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

updateFleet({List<FleetAttribute>? attributesToDelete, ComputeCapacity? computeCapacity, bool? deleteVpcConfig, String? description, int? disconnectTimeoutInSeconds, String? displayName, DomainJoinInfo? domainJoinInfo, bool? enableDefaultInternetAccess, String? iamRoleArn, int? idleDisconnectTimeoutInSeconds, String? imageArn, String? imageName, String? instanceType, int? maxUserDurationInSeconds, String? name, StreamView? streamView, VpcConfig? vpcConfig}) → Future<UpdateFleetResult>

Updates the specified fleet.

updateImagePermissions({required ImagePermissions imagePermissions, required String name, required String sharedAccountId}) → Future<void>

Adds or updates permissions for the specified private image.

updateStack({required String name, List<AccessEndpoint>? accessEndpoints, ApplicationSettings? applicationSettings, List<StackAttribute>? attributesToDelete, bool? deleteStorageConnectors, String? description, String? displayName, List<String>? embedHostDomains, String? feedbackURL, String? redirectURL, List<StorageConnector>? storageConnectors, List<UserSetting>? userSettings}) → Future<UpdateStackResult>

Updates the specified fields for the specified stack.

Operators

operator ==(Object other) → bool

The equality operator.

inherited