Class: AWS.WorkLink

Inherits:
AWS.Service show all
Identifier:
worklink
API Version:
2018-09-25
Defined in:
(unknown)

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

Sending a Request Using WorkLink

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();

Version:

  • 2018-09-25

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a WorkLink object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.WorkLink.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.WorkLink.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.WorkLink.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    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.

Service Reference:

Examples:

Calling the associateDomain operation

var params = {
  AcmCertificateArn: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE', /* required */
  FleetArn: 'STRING_VALUE', /* required */
  DisplayName: 'STRING_VALUE'
};
worklink.associateDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The Amazon Resource Name (ARN) of the fleet.

    • DomainName — (String)

      The fully qualified domain name (FQDN).

    • AcmCertificateArn — (String)

      The ARN of an issued ACM certificate that is valid for the domain being associated.

    • DisplayName — (String)

      The name to display.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the associateWebsiteCertificateAuthority operation

var params = {
  Certificate: 'STRING_VALUE', /* required */
  FleetArn: 'STRING_VALUE', /* required */
  DisplayName: 'STRING_VALUE'
};
worklink.associateWebsiteCertificateAuthority(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • Certificate — (String)

      The root certificate of the CA.

    • DisplayName — (String)

      The certificate name to display.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • WebsiteCaId — (String)

        A unique identifier for the CA.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the createFleet operation

var params = {
  FleetName: 'STRING_VALUE', /* required */
  DisplayName: 'STRING_VALUE',
  OptimizeForEndUserLocation: true || false
};
worklink.createFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetName — (String)

      A unique name for the fleet.

    • DisplayName — (String)

      The fleet name to display.

    • OptimizeForEndUserLocation — (Boolean)

      The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetArn — (String)

        The ARN of the fleet.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the deleteFleet operation

var params = {
  FleetArn: 'STRING_VALUE' /* required */
};
worklink.deleteFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Examples:

Calling the describeAuditStreamConfiguration operation

var params = {
  FleetArn: 'STRING_VALUE' /* required */
};
worklink.describeAuditStreamConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AuditStreamArn — (String)

        The ARN of the Amazon Kinesis data stream that will receive the audit events.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Examples:

Calling the describeCompanyNetworkConfiguration operation

var params = {
  FleetArn: 'STRING_VALUE' /* required */
};
worklink.describeCompanyNetworkConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VpcId — (String)

        The VPC with connectivity to associated websites.

      • SubnetIds — (Array<String>)

        The subnets used for X-ENI connections from Amazon WorkLink rendering containers.

      • SecurityGroupIds — (Array<String>)

        The security groups associated with access to the provided subnets.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Provides information about a user's device.

Service Reference:

Examples:

Calling the describeDevice operation

var params = {
  DeviceId: 'STRING_VALUE', /* required */
  FleetArn: 'STRING_VALUE' /* required */
};
worklink.describeDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • DeviceId — (String)

      A unique identifier for a registered user's device.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (String)

        The current state of the device.

        Possible values include:
        • "ACTIVE"
        • "SIGNED_OUT"
      • Model — (String)

        The model of the device.

      • Manufacturer — (String)

        The manufacturer of the device.

      • OperatingSystem — (String)

        The operating system of the device.

      • OperatingSystemVersion — (String)

        The operating system version of the device.

      • PatchLevel — (String)

        The operating system patch level of the device.

      • FirstAccessedTime — (Date)

        The date that the device first signed in to Amazon WorkLink.

      • LastAccessedTime — (Date)

        The date that the device last accessed Amazon WorkLink.

      • Username — (String)

        The user name associated with the device.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Describes the device policy configuration for the specified fleet.

Examples:

Calling the describeDevicePolicyConfiguration operation

var params = {
  FleetArn: 'STRING_VALUE' /* required */
};
worklink.describeDevicePolicyConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeviceCaCertificate — (String)

        The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Provides information about the domain.

Service Reference:

Examples:

Calling the describeDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  FleetArn: 'STRING_VALUE' /* required */
};
worklink.describeDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • DomainName — (String)

      The name of the domain.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DisplayName — (String)

        The name to display.

      • CreatedTime — (Date)

        The time that the domain was added.

      • DomainStatus — (String)

        The current state for the domain.

        Possible values include:
        • "PENDING_VALIDATION"
        • "ASSOCIATING"
        • "ACTIVE"
        • "INACTIVE"
        • "DISASSOCIATING"
        • "DISASSOCIATED"
        • "FAILED_TO_ASSOCIATE"
        • "FAILED_TO_DISASSOCIATE"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the describeFleetMetadata operation

var params = {
  FleetArn: 'STRING_VALUE' /* required */
};
worklink.describeFleetMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CreatedTime — (Date)

        The time that the fleet was created.

      • LastUpdatedTime — (Date)

        The time that the fleet was last updated.

      • FleetName — (String)

        The name of the fleet.

      • DisplayName — (String)

        The name to display.

      • OptimizeForEndUserLocation — (Boolean)

        The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.

      • CompanyCode — (String)

        The identifier used by users to sign in to the Amazon WorkLink app.

      • FleetStatus — (String)

        The current state of the fleet.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "DELETED"
        • "FAILED_TO_CREATE"
        • "FAILED_TO_DELETE"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Describes the identity provider configuration of the specified fleet.

Examples:

Calling the describeIdentityProviderConfiguration operation

var params = {
  FleetArn: 'STRING_VALUE' /* required */
};
worklink.describeIdentityProviderConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IdentityProviderType — (String)

        The type of identity provider.

        Possible values include:
        • "SAML"
      • ServiceProviderSamlMetadata — (String)

        The SAML metadata document uploaded to the user’s identity provider.

      • IdentityProviderSamlMetadata — (String)

        The SAML metadata document provided by the user’s identity provider.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Provides information about the certificate authority.

Examples:

Calling the describeWebsiteCertificateAuthority operation

var params = {
  FleetArn: 'STRING_VALUE', /* required */
  WebsiteCaId: 'STRING_VALUE' /* required */
};
worklink.describeWebsiteCertificateAuthority(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • WebsiteCaId — (String)

      A unique identifier for the certificate authority.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Certificate — (String)

        The root certificate of the certificate authority.

      • CreatedTime — (Date)

        The time that the certificate authority was added.

      • DisplayName — (String)

        The certificate name to display.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the disassociateDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  FleetArn: 'STRING_VALUE' /* required */
};
worklink.disassociateDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • DomainName — (String)

      The name of the domain.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Removes a certificate authority (CA).

Examples:

Calling the disassociateWebsiteCertificateAuthority operation

var params = {
  FleetArn: 'STRING_VALUE', /* required */
  WebsiteCaId: 'STRING_VALUE' /* required */
};
worklink.disassociateWebsiteCertificateAuthority(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • WebsiteCaId — (String)

      A unique identifier for the CA.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieves a list of devices registered with the specified fleet.

Service Reference:

Examples:

Calling the listDevices operation

var params = {
  FleetArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
worklink.listDevices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • NextToken — (String)

      The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    • MaxResults — (Integer)

      The maximum number of results to be included in the next page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Devices — (Array<map>)

        Information about the devices.

        • DeviceId — (String)

          The ID of the device.

        • DeviceStatus — (String)

          The status of the device.

          Possible values include:
          • "ACTIVE"
          • "SIGNED_OUT"
      • NextToken — (String)

        The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieves a list of domains associated to a specified fleet.

Service Reference:

Examples:

Calling the listDomains operation

var params = {
  FleetArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
worklink.listDomains(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • NextToken — (String)

      The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    • MaxResults — (Integer)

      The maximum number of results to be included in the next page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Domains — (Array<map>)

        Information about the domains.

        • DomainNamerequired — (String)

          The name of the domain.

        • CreatedTimerequired — (Date)

          The time that the domain was created.

        • DomainStatusrequired — (String)

          The status of the domain.

          Possible values include:
          • "PENDING_VALIDATION"
          • "ASSOCIATING"
          • "ACTIVE"
          • "INACTIVE"
          • "DISASSOCIATING"
          • "DISASSOCIATED"
          • "FAILED_TO_ASSOCIATE"
          • "FAILED_TO_DISASSOCIATE"
        • DisplayName — (String)

          The name to display.

      • NextToken — (String)

        The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the listFleets operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
worklink.listFleets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    • MaxResults — (Integer)

      The maximum number of results to be included in the next page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetSummaryList — (Array<map>)

        The summary list of the fleets.

        • FleetArn — (String)

          The ARN of the fleet.

        • CreatedTime — (Date)

          The time when the fleet was created.

        • LastUpdatedTime — (Date)

          The time when the fleet was last updated.

        • FleetName — (String)

          The name of the fleet.

        • DisplayName — (String)

          The name to display.

        • CompanyCode — (String)

          The identifier used by users to sign into the Amazon WorkLink app.

        • FleetStatus — (String)

          The status of the fleet.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "DELETING"
          • "DELETED"
          • "FAILED_TO_CREATE"
          • "FAILED_TO_DELETE"
      • NextToken — (String)

        The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Examples:

Calling the listWebsiteCertificateAuthorities operation

var params = {
  FleetArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
worklink.listWebsiteCertificateAuthorities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • MaxResults — (Integer)

      The maximum number of results to be included in the next page.

    • NextToken — (String)

      The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • WebsiteCertificateAuthorities — (Array<map>)

        Information about the certificates.

        • WebsiteCaId — (String)

          A unique identifier for the CA.

        • CreatedTime — (Date)

          The time when the CA was added.

        • DisplayName — (String)

          The name to display.

      • NextToken — (String)

        The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the restoreDomainAccess operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  FleetArn: 'STRING_VALUE' /* required */
};
worklink.restoreDomainAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • DomainName — (String)

      The name of the domain.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the revokeDomainAccess operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  FleetArn: 'STRING_VALUE' /* required */
};
worklink.revokeDomainAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • DomainName — (String)

      The name of the domain.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the signOutUser operation

var params = {
  FleetArn: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
worklink.signOutUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • Username — (String)

      The name of the user.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates the audit stream configuration for the fleet.

Service Reference:

Examples:

Calling the updateAuditStreamConfiguration operation

var params = {
  FleetArn: 'STRING_VALUE', /* required */
  AuditStreamArn: 'STRING_VALUE'
};
worklink.updateAuditStreamConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • AuditStreamArn — (String)

      The ARN of the Amazon Kinesis data stream that receives the audit events.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates the company network configuration for the fleet.

Examples:

Calling the updateCompanyNetworkConfiguration operation

var params = {
  FleetArn: 'STRING_VALUE', /* required */
  SecurityGroupIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VpcId: 'STRING_VALUE' /* required */
};
worklink.updateCompanyNetworkConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • VpcId — (String)

      The VPC with connectivity to associated websites.

    • SubnetIds — (Array<String>)

      The subnets used for X-ENI connections from Amazon WorkLink rendering containers.

    • SecurityGroupIds — (Array<String>)

      The security groups associated with access to the provided subnets.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates the device policy configuration for the fleet.

Service Reference:

Examples:

Calling the updateDevicePolicyConfiguration operation

var params = {
  FleetArn: 'STRING_VALUE', /* required */
  DeviceCaCertificate: 'STRING_VALUE'
};
worklink.updateDevicePolicyConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • DeviceCaCertificate — (String)

      The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates domain metadata, such as DisplayName.

Service Reference:

Examples:

Calling the updateDomainMetadata operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  FleetArn: 'STRING_VALUE', /* required */
  DisplayName: 'STRING_VALUE'
};
worklink.updateDomainMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • DomainName — (String)

      The name of the domain.

    • DisplayName — (String)

      The name to display.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates fleet metadata, such as DisplayName.

Service Reference:

Examples:

Calling the updateFleetMetadata operation

var params = {
  FleetArn: 'STRING_VALUE', /* required */
  DisplayName: 'STRING_VALUE',
  OptimizeForEndUserLocation: true || false
};
worklink.updateFleetMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • DisplayName — (String)

      The fleet name to display. The existing DisplayName is unset if null is passed.

    • OptimizeForEndUserLocation — (Boolean)

      The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates the identity provider configuration for the fleet.

Examples:

Calling the updateIdentityProviderConfiguration operation

var params = {
  FleetArn: 'STRING_VALUE', /* required */
  IdentityProviderType: SAML, /* required */
  IdentityProviderSamlMetadata: 'STRING_VALUE'
};
worklink.updateIdentityProviderConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetArn — (String)

      The ARN of the fleet.

    • IdentityProviderType — (String)

      The type of identity provider.

      Possible values include:
      • "SAML"
    • IdentityProviderSamlMetadata — (String)

      The SAML metadata document provided by the customer’s identity provider. The existing IdentityProviderSamlMetadata is unset if null is passed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.