Learn R Programming

paws (version 0.1.12)

workspaces: Amazon WorkSpaces

Description

Amazon WorkSpaces Service

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and Amazon Linux desktops for your users.

Usage

workspaces(config = list())

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.

Arguments

config

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

Service syntax

svc <- workspaces(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

associate_connection_aliasAssociates the specified connection alias with the specified directory to enable cross-Region redirection
associate_ip_groupsAssociates the specified IP access control group with the specified directory
authorize_ip_rulesAdds one or more rules to the specified IP access control group
copy_workspace_imageCopies the specified image from the specified Region to the current Region
create_connection_aliasCreates the specified connection alias for use with cross-Region redirection
create_ip_groupCreates an IP access control group
create_tagsCreates the specified tags for the specified WorkSpaces resource
create_workspacesCreates one or more WorkSpaces
delete_connection_aliasDeletes the specified connection alias
delete_ip_groupDeletes the specified IP access control group
delete_tagsDeletes the specified tags from the specified WorkSpaces resource
delete_workspace_imageDeletes the specified image from your account
deregister_workspace_directoryDeregisters the specified directory
describe_accountRetrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account
describe_account_modificationsRetrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account
describe_client_propertiesRetrieves a list that describes one or more specified Amazon WorkSpaces clients
describe_connection_aliasesRetrieves a list that describes the connection aliases used for cross-Region redirection
describe_connection_alias_permissionsDescribes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias
describe_ip_groupsDescribes one or more of your IP access control groups
describe_tagsDescribes the specified tags for the specified WorkSpaces resource
describe_workspace_bundlesRetrieves a list that describes the available WorkSpace bundles
describe_workspace_directoriesDescribes the available directories that are registered with Amazon WorkSpaces
describe_workspace_image_permissionsDescribes the permissions that the owner of an image has granted to other AWS accounts for an image
describe_workspace_imagesRetrieves a list that describes one or more specified images, if the image identifiers are provided
describe_workspacesDescribes the specified WorkSpaces
describe_workspaces_connection_statusDescribes the connection status of the specified WorkSpaces
describe_workspace_snapshotsDescribes the snapshots for the specified WorkSpace
disassociate_connection_aliasDisassociates a connection alias from a directory
disassociate_ip_groupsDisassociates the specified IP access control group from the specified directory
import_workspace_imageImports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces
list_available_management_cidr_rangesRetrieves 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_workspaceMigrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume
modify_accountModifies the configuration of Bring Your Own License (BYOL) for the specified account
modify_client_propertiesModifies the properties of the specified Amazon WorkSpaces clients
modify_selfservice_permissionsModifies the self-service WorkSpace management capabilities for your users
modify_workspace_access_propertiesSpecifies which devices and operating systems users can use to access their WorkSpaces
modify_workspace_creation_propertiesModify the default properties used to create WorkSpaces
modify_workspace_propertiesModifies the specified WorkSpace properties
modify_workspace_stateSets the state of the specified WorkSpace
reboot_workspacesReboots the specified WorkSpaces
rebuild_workspacesRebuilds the specified WorkSpace
register_workspace_directoryRegisters the specified directory
restore_workspaceRestores the specified WorkSpace to its last known healthy state
revoke_ip_rulesRemoves one or more rules from the specified IP access control group
start_workspacesStarts the specified WorkSpaces
stop_workspacesStops the specified WorkSpaces
terminate_workspacesTerminates the specified WorkSpaces
update_connection_alias_permissionShares 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_groupReplaces the current rules of the specified IP access control group with the specified rules
update_workspace_image_permissionShares or unshares an image with one account in the same AWS Region by specifying whether that account has permission to copy the image

Examples

Run this code
if (FALSE) {
svc <- workspaces()
svc$associate_connection_alias(
  Foo = 123
)
}

Run the code above in your browser using DataLab