workspaces: Amazon WorkSpaces

Description Usage Arguments Value Service syntax Operations Examples

View source: R/paws.R

Description

Amazon WorkSpaces Service

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

Usage

1
workspaces(config = list())

Arguments

config

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

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
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_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
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_connection_alias Creates the specified connection alias for use with cross-Region redirection
create_ip_group Creates an IP access control group
create_tags Creates the specified tags for the specified WorkSpaces resource
create_workspaces Creates one or more WorkSpaces
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_image Deletes the specified image from your account
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_client_properties Retrieves a list that describes one or more specified Amazon WorkSpaces clients
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 AWS account for the specified connection alias
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_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 AWS 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
import_workspace_image Imports the specified Windows 10 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
modify_client_properties Modifies the properties of the specified Amazon WorkSpaces clients
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_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_image_permission Shares or unshares an image with one account in the same AWS Region by specifying whether that account has permission to copy the image

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- workspaces()
svc$associate_connection_alias(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 5, 2021, 5:19 p.m.

Related to workspaces in paws...