Expand description
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.
You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.
To learn more about AppStream 2.0, see the following resources:
If you’re using the service, you’re probably looking for AppStreamClient and AppStream.
Structs§
- Access
Endpoint Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
- AppStream
Client - A client for the Amazon AppStream API.
- Application
Describes an application in the application catalog.
- Application
Settings The persistent application settings for users of a stack.
- Application
Settings Response Describes the persistent application settings for users of a stack.
- Associate
Fleet Request - Associate
Fleet Result - Batch
Associate User Stack Request - Batch
Associate User Stack Result - Batch
Disassociate User Stack Request - Batch
Disassociate User Stack Result - Compute
Capacity Describes the capacity for a fleet.
- Compute
Capacity Status Describes the capacity status for a fleet.
- Copy
Image Request - Copy
Image Response - Create
Directory Config Request - Create
Directory Config Result - Create
Fleet Request - Create
Fleet Result - Create
Image Builder Request - Create
Image Builder Result - Create
Image Builder StreamingURL Request - Create
Image Builder StreamingURL Result - Create
Stack Request - Create
Stack Result - Create
StreamingURL Request - Create
StreamingURL Result - Create
Usage Report Subscription Request - Create
Usage Report Subscription Result - Create
User Request - Create
User Result - Delete
Directory Config Request - Delete
Directory Config Result - Delete
Fleet Request - Delete
Fleet Result - Delete
Image Builder Request - Delete
Image Builder Result - Delete
Image Permissions Request - Delete
Image Permissions Result - Delete
Image Request - Delete
Image Result - Delete
Stack Request - Delete
Stack Result - Delete
Usage Report Subscription Request - Delete
Usage Report Subscription Result - Delete
User Request - Delete
User Result - Describe
Directory Configs Request - Describe
Directory Configs Result - Describe
Fleets Request - Describe
Fleets Result - Describe
Image Builders Request - Describe
Image Builders Result - Describe
Image Permissions Request - Describe
Image Permissions Result - Describe
Images Request - Describe
Images Result - Describe
Sessions Request - Describe
Sessions Result - Describe
Stacks Request - Describe
Stacks Result - Describe
Usage Report Subscriptions Request - Describe
Usage Report Subscriptions Result - Describe
User Stack Associations Request - Describe
User Stack Associations Result - Describe
Users Request - Describe
Users Result - Directory
Config Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
- Disable
User Request - Disable
User Result - Disassociate
Fleet Request - Disassociate
Fleet Result - Domain
Join Info Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
- Enable
User Request - Enable
User Result - Expire
Session Request - Expire
Session Result - Fleet
Describes a fleet.
- Fleet
Error Describes a fleet error.
- Image
Describes an image.
- Image
Builder Describes a virtual machine that is used to create an image.
- Image
Builder State Change Reason Describes the reason why the last image builder state change occurred.
- Image
Permissions Describes the permissions for an image.
- Image
State Change Reason Describes the reason why the last image state change occurred.
- Last
Report Generation Execution Error Describes the error that is returned when a usage report can't be generated.
- List
Associated Fleets Request - List
Associated Fleets Result - List
Associated Stacks Request - List
Associated Stacks Result - List
Tags ForResource Request - List
Tags ForResource Response - Network
Access Configuration Describes the network details of the fleet or image builder instance.
- Resource
Error Describes a resource error.
- Service
Account Credentials Describes the credentials for the service account used by the fleet or image builder to connect to the directory.
- Session
Describes a streaming session.
- Shared
Image Permissions Describes the permissions that are available to the specified AWS account for a shared image.
- Stack
Describes a stack.
- Stack
Error Describes a stack error.
- Start
Fleet Request - Start
Fleet Result - Start
Image Builder Request - Start
Image Builder Result - Stop
Fleet Request - Stop
Fleet Result - Stop
Image Builder Request - Stop
Image Builder Result - Storage
Connector Describes a connector that enables persistent storage for users.
- TagResource
Request - TagResource
Response - Untag
Resource Request - Untag
Resource Response - Update
Directory Config Request - Update
Directory Config Result - Update
Fleet Request - Update
Fleet Result - Update
Image Permissions Request - Update
Image Permissions Result - Update
Stack Request - Update
Stack Result - Usage
Report Subscription Describes information about the usage report subscription.
- User
Describes a user in the user pool.
- User
Setting Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
- User
Stack Association Describes a user in the user pool and the associated stack.
- User
Stack Association Error Describes the error that is returned when a user can’t be associated with or disassociated from a stack.
- VpcConfig
Describes VPC configuration information for fleets and image builders.
Enums§
- Associate
Fleet Error - Errors returned by AssociateFleet
- Batch
Associate User Stack Error - Errors returned by BatchAssociateUserStack
- Batch
Disassociate User Stack Error - Errors returned by BatchDisassociateUserStack
- Copy
Image Error - Errors returned by CopyImage
- Create
Directory Config Error - Errors returned by CreateDirectoryConfig
- Create
Fleet Error - Errors returned by CreateFleet
- Create
Image Builder Error - Errors returned by CreateImageBuilder
- Create
Image Builder StreamingURL Error - Errors returned by CreateImageBuilderStreamingURL
- Create
Stack Error - Errors returned by CreateStack
- Create
StreamingURL Error - Errors returned by CreateStreamingURL
- Create
Usage Report Subscription Error - Errors returned by CreateUsageReportSubscription
- Create
User Error - Errors returned by CreateUser
- Delete
Directory Config Error - Errors returned by DeleteDirectoryConfig
- Delete
Fleet Error - Errors returned by DeleteFleet
- Delete
Image Builder Error - Errors returned by DeleteImageBuilder
- Delete
Image Error - Errors returned by DeleteImage
- Delete
Image Permissions Error - Errors returned by DeleteImagePermissions
- Delete
Stack Error - Errors returned by DeleteStack
- Delete
Usage Report Subscription Error - Errors returned by DeleteUsageReportSubscription
- Delete
User Error - Errors returned by DeleteUser
- Describe
Directory Configs Error - Errors returned by DescribeDirectoryConfigs
- Describe
Fleets Error - Errors returned by DescribeFleets
- Describe
Image Builders Error - Errors returned by DescribeImageBuilders
- Describe
Image Permissions Error - Errors returned by DescribeImagePermissions
- Describe
Images Error - Errors returned by DescribeImages
- Describe
Sessions Error - Errors returned by DescribeSessions
- Describe
Stacks Error - Errors returned by DescribeStacks
- Describe
Usage Report Subscriptions Error - Errors returned by DescribeUsageReportSubscriptions
- Describe
User Stack Associations Error - Errors returned by DescribeUserStackAssociations
- Describe
Users Error - Errors returned by DescribeUsers
- Disable
User Error - Errors returned by DisableUser
- Disassociate
Fleet Error - Errors returned by DisassociateFleet
- Enable
User Error - Errors returned by EnableUser
- Expire
Session Error - Errors returned by ExpireSession
- List
Associated Fleets Error - Errors returned by ListAssociatedFleets
- List
Associated Stacks Error - Errors returned by ListAssociatedStacks
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- Start
Fleet Error - Errors returned by StartFleet
- Start
Image Builder Error - Errors returned by StartImageBuilder
- Stop
Fleet Error - Errors returned by StopFleet
- Stop
Image Builder Error - Errors returned by StopImageBuilder
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Directory Config Error - Errors returned by UpdateDirectoryConfig
- Update
Fleet Error - Errors returned by UpdateFleet
- Update
Image Permissions Error - Errors returned by UpdateImagePermissions
- Update
Stack Error - Errors returned by UpdateStack
Traits§
- AppStream
- Trait representing the capabilities of the Amazon AppStream API. Amazon AppStream clients implement this trait.