Client

workspaces

R Documentation

Amazon WorkSpaces¶

Description¶

Amazon WorkSpaces Service

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.

This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services General Reference.

You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference.

Usage¶

workspaces(
  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 <- workspaces(
  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_connection_alias: Associates the specified connection alias with the specified directory to enable cross-Region redirection
associate_ip_groups: Associates the specified IP access control group with the specified directory
associate_workspace_application: Associates the specified application to the specified WorkSpace
authorize_ip_rules: Adds one or more rules to the specified IP access control group
copy_workspace_image: Copies the specified image from the specified Region to the current Region
create_connect_client_add_in: Creates a client-add-in for Amazon Connect within a directory
create_connection_alias: Creates the specified connection alias for use with cross-Region redirection
create_ip_group: Creates an IP access control group
create_standby_workspaces: Creates a standby WorkSpace in a secondary Region
create_tags: Creates the specified tags for the specified WorkSpaces resource
create_updated_workspace_image: Creates a new updated WorkSpace image based on the specified source image
create_workspace_bundle: Creates the specified WorkSpace bundle
create_workspace_image: Creates a new WorkSpace image from an existing WorkSpace
create_workspaces: Creates one or more WorkSpaces
delete_client_branding: Deletes customized client branding
delete_connect_client_add_in: Deletes a client-add-in for Amazon Connect that is configured within a directory
delete_connection_alias: Deletes the specified connection alias
delete_ip_group: Deletes the specified IP access control group
delete_tags: Deletes the specified tags from the specified WorkSpaces resource
delete_workspace_bundle: Deletes the specified WorkSpace bundle
delete_workspace_image: Deletes the specified image from your account
deploy_workspace_applications: Deploys associated applications to the specified WorkSpace
deregister_workspace_directory: Deregisters the specified directory
describe_account: Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account
describe_account_modifications: Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account
describe_application_associations: Describes the associations between the application and the specified associated resources
describe_applications: Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners
describe_bundle_associations: Describes the associations between the applications and the specified bundle
describe_client_branding: Describes the specified client branding
describe_client_properties: Retrieves a list that describes one or more specified Amazon WorkSpaces clients
describe_connect_client_add_ins: Retrieves a list of Amazon Connect client add-ins that have been created
describe_connection_aliases: Retrieves a list that describes the connection aliases used for cross-Region redirection
describe_connection_alias_permissions: Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias
describe_image_associations: Describes the associations between the applications and the specified image
describe_ip_groups: Describes one or more of your IP access control groups
describe_tags: Describes the specified tags for the specified WorkSpaces resource
describe_workspace_associations: Describes the associations betweens applications and the specified WorkSpace
describe_workspace_bundles: Retrieves a list that describes the available WorkSpace bundles
describe_workspace_directories: Describes the available directories that are registered with Amazon WorkSpaces
describe_workspace_image_permissions: Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image
describe_workspace_images: Retrieves a list that describes one or more specified images, if the image identifiers are provided
describe_workspaces: Describes the specified WorkSpaces
describe_workspaces_connection_status: Describes the connection status of the specified WorkSpaces
describe_workspace_snapshots: Describes the snapshots for the specified WorkSpace
disassociate_connection_alias: Disassociates a connection alias from a directory
disassociate_ip_groups: Disassociates the specified IP access control group from the specified directory
disassociate_workspace_application: Disassociates the specified application from a WorkSpace
import_client_branding: Imports client branding
import_workspace_image: Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces
list_available_management_cidr_ranges: Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL)
migrate_workspace: Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume
modify_account: Modifies the configuration of Bring Your Own License (BYOL) for the specified account; Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces
modify_client_properties: Modifies the properties of the specified Amazon WorkSpaces clients
modify_saml_properties: Modifies multiple properties related to SAML 2
modify_selfservice_permissions: Modifies the self-service WorkSpace management capabilities for your users
modify_workspace_access_properties: Specifies which devices and operating systems users can use to access their WorkSpaces
modify_workspace_creation_properties: Modify the default properties used to create WorkSpaces
modify_workspace_properties: Modifies the specified WorkSpace properties
modify_workspace_state: Sets the state of the specified WorkSpace
reboot_workspaces: Reboots the specified WorkSpaces
rebuild_workspaces: Rebuilds the specified WorkSpace
register_workspace_directory: Registers the specified directory
restore_workspace: Restores the specified WorkSpace to its last known healthy state
revoke_ip_rules: Removes one or more rules from the specified IP access control group
start_workspaces: Starts the specified WorkSpaces
stop_workspaces: Stops the specified WorkSpaces
terminate_workspaces: Terminates the specified WorkSpaces
update_connect_client_add_in: Updates a Amazon Connect client add-in
update_connection_alias_permission: Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory
update_rules_of_ip_group: Replaces the current rules of the specified IP access control group with the specified rules
update_workspace_bundle: Updates a WorkSpace bundle with a new image
update_workspace_image_permission: Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image

Examples¶

## Not run: 
svc <- workspaces()
svc$associate_connection_alias(
  Foo = 123
)

## End(Not run)