Amazon AppStream 2.0
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:
appstream(config = list())A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
svc <- appstream(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string"
),
endpoint = "string",
region = "string"
)
)
| associate_fleet | Associates the specified fleet with the specified stack |
| batch_associate_user_stack | Associates the specified users with the specified stacks |
| batch_disassociate_user_stack | Disassociates the specified users from the specified stacks |
| copy_image | Copies the image within the same region or to a new region within the same AWS account |
| create_directory_config | Creates a Directory Config object in AppStream 2 |
| create_fleet | Creates a fleet |
| create_image_builder | Creates an image builder |
| create_image_builder_streaming_url | Creates a URL to start an image builder streaming session |
| create_stack | Creates a stack to start streaming applications to users |
| create_streaming_url | Creates a temporary URL to start an AppStream 2 |
| create_usage_report_subscription | Creates a usage report subscription |
| create_user | Creates a new user in the user pool |
| delete_directory_config | Deletes the specified Directory Config object from AppStream 2 |
| delete_fleet | Deletes the specified fleet |
| delete_image | Deletes the specified image |
| delete_image_builder | Deletes the specified image builder and releases the capacity |
| delete_image_permissions | Deletes permissions for the specified private image |
| delete_stack | Deletes the specified stack |
| delete_usage_report_subscription | Disables usage report generation |
| delete_user | Deletes a user from the user pool |
| describe_directory_configs | Retrieves a list that describes one or more specified Directory Config objects for AppStream 2 |
| describe_fleets | Retrieves a list that describes one or more specified fleets, if the fleet names are provided |
| describe_image_builders | Retrieves a list that describes one or more specified image builders, if the image builder names are provided |
| describe_image_permissions | Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own |
| describe_images | Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided |
| describe_sessions | Retrieves a list that describes the streaming sessions for a specified stack and fleet |
| describe_stacks | Retrieves a list that describes one or more specified stacks, if the stack names are provided |
| describe_usage_report_subscriptions | Retrieves a list that describes one or more usage report subscriptions |
| describe_users | Retrieves a list that describes one or more specified users in the user pool |
| describe_user_stack_associations | Retrieves a list that describes the UserStackAssociation objects |
| disable_user | Disables the specified user in the user pool |
| disassociate_fleet | Disassociates the specified fleet from the specified stack |
| enable_user | Enables a user in the user pool |
| expire_session | Immediately stops the specified streaming session |
| list_associated_fleets | Retrieves the name of the fleet that is associated with the specified stack |
| list_associated_stacks | Retrieves the name of the stack with which the specified fleet is associated |
| list_tags_for_resource | Retrieves a list of all tags for the specified AppStream 2 |
| start_fleet | Starts the specified fleet |
| start_image_builder | Starts the specified image builder |
| stop_fleet | Stops the specified fleet |
| stop_image_builder | Stops the specified image builder |
| tag_resource | Adds or overwrites one or more tags for the specified AppStream 2 |
| untag_resource | Disassociates one or more specified tags from the specified AppStream 2 |
| update_directory_config | Updates the specified Directory Config object in AppStream 2 |
| update_fleet | Updates the specified fleet |
| update_image_permissions | Adds or updates permissions for the specified private image |
| update_stack | Updates the specified fields for the specified stack |
if (FALSE) {
svc <- appstream()
svc$associate_fleet(
Foo = 123
)
}
Run the code above in your browser using DataLab