workspacesweb function

Amazon WorkSpaces Web

Amazon WorkSpaces Web

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.

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.

Returns

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_settingsAssociates a browser settings resource with a web portal
associate_data_protection_settingsAssociates a data protection settings resource with a web portal
associate_ip_access_settingsAssociates an IP access settings resource with a web portal
associate_network_settingsAssociates a network settings resource with a web portal
associate_trust_storeAssociates a trust store with a web portal
associate_user_access_logging_settingsAssociates a user access logging settings resource with a web portal
associate_user_settingsAssociates a user settings resource with a web portal
create_browser_settingsCreates a browser settings resource that can be associated with a web portal
create_data_protection_settingsCreates a data protection settings resource that can be associated with a web portal
create_identity_providerCreates an identity provider resource that is then associated with a web portal
create_ip_access_settingsCreates an IP access settings resource that can be associated with a web portal
create_network_settingsCreates a network settings resource that can be associated with a web portal
create_portalCreates a web portal
create_trust_storeCreates a trust store that can be associated with a web portal
create_user_access_logging_settingsCreates a user access logging settings resource that can be associated with a web portal
create_user_settingsCreates a user settings resource that can be associated with a web portal
delete_browser_settingsDeletes browser settings
delete_data_protection_settingsDeletes data protection settings
delete_identity_providerDeletes the identity provider
delete_ip_access_settingsDeletes IP access settings
delete_network_settingsDeletes network settings
delete_portalDeletes a web portal
delete_trust_storeDeletes the trust store
delete_user_access_logging_settingsDeletes user access logging settings
delete_user_settingsDeletes user settings
disassociate_browser_settingsDisassociates browser settings from a web portal
disassociate_data_protection_settingsDisassociates data protection settings from a web portal
disassociate_ip_access_settingsDisassociates IP access settings from a web portal
disassociate_network_settingsDisassociates network settings from a web portal
disassociate_trust_storeDisassociates a trust store from a web portal
disassociate_user_access_logging_settingsDisassociates user access logging settings from a web portal
disassociate_user_settingsDisassociates user settings from a web portal
expire_sessionExpires an active secure browser session
get_browser_settingsGets browser settings
get_data_protection_settingsGets the data protection settings
get_identity_providerGets the identity provider
get_ip_access_settingsGets the IP access settings
get_network_settingsGets the network settings
get_portalGets the web portal
get_portal_service_provider_metadataGets the service provider metadata
get_sessionGets information for a secure browser session
get_trust_storeGets the trust store
get_trust_store_certificateGets the trust store certificate
get_user_access_logging_settingsGets user access logging settings
get_user_settingsGets user settings
list_browser_settingsRetrieves a list of browser settings
list_data_protection_settingsRetrieves a list of data protection settings
list_identity_providersRetrieves a list of identity providers for a specific web portal
list_ip_access_settingsRetrieves a list of IP access settings
list_network_settingsRetrieves a list of network settings
list_portalsRetrieves a list or web portals
list_sessionsLists information for multiple secure browser sessions from a specific portal
list_tags_for_resourceRetrieves a list of tags for a resource
list_trust_store_certificatesRetrieves a list of trust store certificates
list_trust_storesRetrieves a list of trust stores
list_user_access_logging_settingsRetrieves a list of user access logging settings
list_user_settingsRetrieves a list of user settings
tag_resourceAdds or overwrites one or more tags for the specified resource
untag_resourceRemoves one or more tags from the specified resource
update_browser_settingsUpdates browser settings
update_data_protection_settingsUpdates data protection settings
update_identity_providerUpdates the identity provider
update_ip_access_settingsUpdates IP access settings
update_network_settingsUpdates network settings
update_portalUpdates a web portal
update_trust_storeUpdates the trust store
update_user_access_logging_settingsUpdates the user access logging settings
update_user_settingsUpdates the user settings

Examples

## Not run: svc <- workspacesweb() svc$associate_browser_settings( Foo = 123 ) ## End(Not run)
  • Maintainer: Dyfan Jones
  • License: Apache License (>= 2.0)
  • Last published: 2025-03-17