worklink {paws}R Documentation

Amazon WorkLink

Description

Amazon WorkLink is a cloud-based service that provides secure access to internal websites and web apps from iOS and Android phones. In a single step, your users, such as employees, can access internal websites as efficiently as they access any other public website. They enter a URL in their web browser, or choose a link to an internal website in an email. Amazon WorkLink authenticates the user's access and securely renders authorized internal web content in a secure rendering service in the AWS cloud. Amazon WorkLink doesn't download or store any internal web content on mobile devices.

Usage

worklink(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 <- worklink(
  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_domain Specifies a domain to be associated to Amazon WorkLink
associate_website_authorization_provider Associates a website authorization provider with a specified fleet
associate_website_certificate_authority Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network
create_fleet Creates a fleet
delete_fleet Deletes a fleet
describe_audit_stream_configuration Describes the configuration for delivering audit streams to the customer account
describe_company_network_configuration Describes the networking configuration to access the internal websites associated with the specified fleet
describe_device Provides information about a user's device
describe_device_policy_configuration Describes the device policy configuration for the specified fleet
describe_domain Provides information about the domain
describe_fleet_metadata Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details
describe_identity_provider_configuration Describes the identity provider configuration of the specified fleet
describe_website_certificate_authority Provides information about the certificate authority
disassociate_domain Disassociates a domain from Amazon WorkLink
disassociate_website_authorization_provider Disassociates a website authorization provider from a specified fleet
disassociate_website_certificate_authority Removes a certificate authority (CA)
list_devices Retrieves a list of devices registered with the specified fleet
list_domains Retrieves a list of domains associated to a specified fleet
list_fleets Retrieves a list of fleets for the current account and Region
list_tags_for_resource Retrieves a list of tags for the specified resource
list_website_authorization_providers Retrieves a list of website authorization providers associated with a specified fleet
list_website_certificate_authorities Retrieves a list of certificate authorities added for the current account and Region
restore_domain_access Moves a domain to ACTIVE status if it was in the INACTIVE status
revoke_domain_access Moves a domain to INACTIVE status if it was in the ACTIVE status
sign_out_user Signs the user out from all of their devices
tag_resource Adds or overwrites one or more tags for the specified resource, such as a fleet
untag_resource Removes one or more tags from the specified resource
update_audit_stream_configuration Updates the audit stream configuration for the fleet
update_company_network_configuration Updates the company network configuration for the fleet
update_device_policy_configuration Updates the device policy configuration for the fleet
update_domain_metadata Updates domain metadata, such as DisplayName
update_fleet_metadata Updates fleet metadata, such as DisplayName
update_identity_provider_configuration Updates the identity provider configuration for the fleet

Examples

## Not run: 
svc <- worklink()
svc$associate_domain(
  Foo = 123
)

## End(Not run)
[Package paws version 0.6.0 Index]