Client

appstream

R Documentation

Amazon AppStream¶

Description¶

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:

Usage¶

appstream(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

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.

Service syntax¶

svc <- appstream(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

associate_app_block_builder_app_block: Associates the specified app block builder with the specified app block
associate_application_fleet: Associates the specified application with the specified fleet
associate_application_to_entitlement: Associates an application to entitle
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_app_block: Creates an app block
create_app_block_builder: Creates an app block builder; Creates a URL to start a create app block builder streaming session
create_application: Creates an application
create_directory_config: Creates a Directory Config object in AppStream 2
create_entitlement: Creates a new entitlement
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_updated_image: Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2
create_usage_report_subscription: Creates a usage report subscription
create_user: Creates a new user in the user pool
delete_app_block: Deletes an app block
delete_app_block_builder: Deletes an app block builder
delete_application: Deletes an application
delete_directory_config: Deletes the specified Directory Config object from AppStream 2
delete_entitlement: Deletes the specified entitlement
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; Retrieves a list that describes one or more app block builder associations
describe_app_block_builders: Retrieves a list that describes one or more app block builders
describe_app_blocks: Retrieves a list that describes one or more app blocks; Retrieves a list that describes one or more application fleet associations
describe_applications: Retrieves a list that describes one or more applications
describe_directory_configs: Retrieves a list that describes one or more specified Directory Config objects for AppStream 2
describe_entitlements: Retrieves a list that describes one of more entitlements
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; Disassociates a specified app block builder from a specified app block
disassociate_application_fleet: Disassociates the specified application from the fleet; Deletes the specified application from the specified entitlement
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_entitled_applications: Retrieves a list of entitled applications
list_tags_for_resource: Retrieves a list of all tags for the specified AppStream 2
start_app_block_builder: Starts an app block builder
start_fleet: Starts the specified fleet
start_image_builder: Starts the specified image builder
stop_app_block_builder: Stops an app block 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_app_block_builder: Updates an app block builder
update_application: Updates the specified application
update_directory_config: Updates the specified Directory Config object in AppStream 2
update_entitlement: Updates the specified entitlement
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

Examples¶

## Not run: 
svc <- appstream()
svc$associate_app_block_builder_app_block(
  Foo = 123
)

## End(Not run)