AWS.WorkLink — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service 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.

var worklink = new AWS.WorkLink();
worklink.associateDomain(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the WorkLink object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var worklink = new AWS.WorkLink({apiVersion: '2018-09-25'});

You can also set the API version globally in AWS.config.apiVersions using the worklink service identifier:

AWS.config.apiVersions = {
  worklink: '2018-09-25',
  // other service API versions
};

var worklink = new AWS.WorkLink();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.WorkLink(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

associateDomain(params = {}, callback) ⇒ AWS.Request

Specifies a domain to be associated to Amazon WorkLink.

Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.

associateWebsiteCertificateAuthority(params = {}, callback) ⇒ AWS.Request

Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.

createFleet(params = {}, callback) ⇒ AWS.Request

Creates a fleet. A fleet consists of resources and the configuration that delivers associated websites to authorized users who download and set up the Amazon WorkLink app.

deleteFleet(params = {}, callback) ⇒ AWS.Request

Deletes a fleet. Prevents users from accessing previously associated websites.

describeAuditStreamConfiguration(params = {}, callback) ⇒ AWS.Request

Describes the configuration for delivering audit streams to the customer account.

describeCompanyNetworkConfiguration(params = {}, callback) ⇒ AWS.Request

Describes the networking configuration to access the internal websites associated with the specified fleet.

describeDevice(params = {}, callback) ⇒ AWS.Request

Provides information about a user's device.

describeDevicePolicyConfiguration(params = {}, callback) ⇒ AWS.Request

Describes the device policy configuration for the specified fleet.

describeDomain(params = {}, callback) ⇒ AWS.Request

Provides information about the domain.

describeFleetMetadata(params = {}, callback) ⇒ AWS.Request

Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.

describeIdentityProviderConfiguration(params = {}, callback) ⇒ AWS.Request

Describes the identity provider configuration of the specified fleet.

describeWebsiteCertificateAuthority(params = {}, callback) ⇒ AWS.Request

Provides information about the certificate authority.

disassociateDomain(params = {}, callback) ⇒ AWS.Request

Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.

disassociateWebsiteAuthorizationProvider(params = {}, callback) ⇒ AWS.Request

Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.

disassociateWebsiteCertificateAuthority(params = {}, callback) ⇒ AWS.Request

Removes a certificate authority (CA).

listDevices(params = {}, callback) ⇒ AWS.Request

Retrieves a list of devices registered with the specified fleet.

listDomains(params = {}, callback) ⇒ AWS.Request

Retrieves a list of domains associated to a specified fleet.

listFleets(params = {}, callback) ⇒ AWS.Request

Retrieves a list of fleets for the current account and Region.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Retrieves a list of tags for the specified resource.

listWebsiteAuthorizationProviders(params = {}, callback) ⇒ AWS.Request

Retrieves a list of website authorization providers associated with a specified fleet.

listWebsiteCertificateAuthorities(params = {}, callback) ⇒ AWS.Request

Retrieves a list of certificate authorities added for the current account and Region.

restoreDomainAccess(params = {}, callback) ⇒ AWS.Request

Moves a domain to ACTIVE status if it was in the INACTIVE status.

revokeDomainAccess(params = {}, callback) ⇒ AWS.Request

Moves a domain to INACTIVE status if it was in the ACTIVE status.

signOutUser(params = {}, callback) ⇒ AWS.Request

Signs the user out from all of their devices. The user can sign in again if they have valid credentials.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds or overwrites one or more tags for the specified resource, such as a fleet. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from the specified resource.

updateAuditStreamConfiguration(params = {}, callback) ⇒ AWS.Request

Updates the audit stream configuration for the fleet.

updateCompanyNetworkConfiguration(params = {}, callback) ⇒ AWS.Request

Updates the company network configuration for the fleet.

updateDevicePolicyConfiguration(params = {}, callback) ⇒ AWS.Request

Updates the device policy configuration for the fleet.

updateDomainMetadata(params = {}, callback) ⇒ AWS.Request

Updates domain metadata, such as DisplayName.

updateFleetMetadata(params = {}, callback) ⇒ AWS.Request

Updates fleet metadata, such as DisplayName.

updateIdentityProviderConfiguration(params = {}, callback) ⇒ AWS.Request

Updates the identity provider configuration for the fleet.