Skip to content

Client

workspacesweb R Documentation

Amazon WorkSpaces Web

Description

Amazon WorkSpaces Secure Browser is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Secure Browser makes it easy for customers to safely provide their employees with access to internal websites and SaaS web applications without the administrative burden of appliances or specialized client software. WorkSpaces Secure Browser provides simple policy tools tailored for user interactions, while offloading common tasks like capacity management, scaling, and maintaining browser images.

Usage

workspacesweb(
  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 <- workspacesweb(
  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_browser_settings
Associates a browser settings resource with a web portal
associate_ip_access_settings
Associates an IP access settings resource with a web portal
associate_network_settings
Associates a network settings resource with a web portal
associate_trust_store
Associates a trust store with a web portal
associate_user_access_logging_settings
Associates a user access logging settings resource with a web portal
associate_user_settings
Associates a user settings resource with a web portal
create_browser_settings
Creates a browser settings resource that can be associated with a web portal
create_identity_provider
Creates an identity provider resource that is then associated with a web portal
create_ip_access_settings
Creates an IP access settings resource that can be associated with a web portal
create_network_settings
Creates a network settings resource that can be associated with a web portal
create_portal
Creates a web portal
create_trust_store
Creates a trust store that can be associated with a web portal
create_user_access_logging_settings
Creates a user access logging settings resource that can be associated with a web portal
create_user_settings
Creates a user settings resource that can be associated with a web portal
delete_browser_settings
Deletes browser settings
delete_identity_provider
Deletes the identity provider
delete_ip_access_settings
Deletes IP access settings
delete_network_settings
Deletes network settings
delete_portal
Deletes a web portal
delete_trust_store
Deletes the trust store
delete_user_access_logging_settings
Deletes user access logging settings
delete_user_settings
Deletes user settings
disassociate_browser_settings
Disassociates browser settings from a web portal
disassociate_ip_access_settings
Disassociates IP access settings from a web portal
disassociate_network_settings
Disassociates network settings from a web portal
disassociate_trust_store
Disassociates a trust store from a web portal
disassociate_user_access_logging_settings
Disassociates user access logging settings from a web portal
disassociate_user_settings
Disassociates user settings from a web portal
get_browser_settings
Gets browser settings
get_identity_provider
Gets the identity provider
get_ip_access_settings
Gets the IP access settings
get_network_settings
Gets the network settings
get_portal
Gets the web portal
get_portal_service_provider_metadata
Gets the service provider metadata
get_trust_store
Gets the trust store
get_trust_store_certificate
Gets the trust store certificate
get_user_access_logging_settings
Gets user access logging settings
get_user_settings
Gets user settings
list_browser_settings
Retrieves a list of browser settings
list_identity_providers
Retrieves a list of identity providers for a specific web portal
list_ip_access_settings
Retrieves a list of IP access settings
list_network_settings
Retrieves a list of network settings
list_portals
Retrieves a list or web portals
list_tags_for_resource
Retrieves a list of tags for a resource
list_trust_store_certificates
Retrieves a list of trust store certificates
list_trust_stores
Retrieves a list of trust stores
list_user_access_logging_settings
Retrieves a list of user access logging settings
list_user_settings
Retrieves a list of user settings
tag_resource
Adds or overwrites one or more tags for the specified resource
untag_resource
Removes one or more tags from the specified resource
update_browser_settings
Updates browser settings
update_identity_provider
Updates the identity provider
update_ip_access_settings
Updates IP access settings
update_network_settings
Updates network settings
update_portal
Updates a web portal
update_trust_store
Updates the trust store
update_user_access_logging_settings
Updates the user access logging settings
update_user_settings
Updates the user settings

Examples

## Not run: 
svc <- workspacesweb()
svc$associate_browser_settings(
  Foo = 123
)

## End(Not run)