Class: AWS.WorkLink

var params = {
  AuthorizationProviderType: SAML, /* required */
  FleetArn: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE'
};
worklink.associateWebsiteAuthorizationProvider(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.

  • AuthorizationProviderType — (String)

    The authorization provider type.

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

    The domain name of the authorization provider. This applies only to SAML-based authorization providers.

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:

    • AuthorizationProviderId — (String)

      A unique identifier for the authorization provider.

Returns:

• (AWS.Request) —

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

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.

var params = {
  FleetName: 'STRING_VALUE', /* required */
  DisplayName: 'STRING_VALUE',
  OptimizeForEndUserLocation: true || false,
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
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.

  • Tags — (map<String>)

    The tags to add to the resource. A tag is a key-value pair.

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 Amazon Resource Name (ARN) of the fleet.

Returns:

• (AWS.Request) —

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

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.

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.

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.

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.

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.

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:

    • DomainName — (String)

      The name of the domain.

    • 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"
    • AcmCertificateArn — (String)

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

Returns:

• (AWS.Request) —

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

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 Amazon Resource Name (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"
    • Tags — (map<String>)

      The tags attached to the resource. A tag is a key-value pair.

Returns:

• (AWS.Request) —

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

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.

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.

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.

var params = {
  AuthorizationProviderId: 'STRING_VALUE', /* required */
  FleetArn: 'STRING_VALUE' /* required */
};
worklink.disassociateWebsiteAuthorizationProvider(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.

  • AuthorizationProviderId — (String)

    A unique identifier for the authorization provider.

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.

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.

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.

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.

      • DomainName — required — (String)

        The name of the domain.

      • DisplayName — (String)

        The name to display.

      • CreatedTime — required — (Date)

        The time that the domain was created.

      • DomainStatus — required — (String)

        The status of the domain.

        Possible values include:
        • "PENDING_VALIDATION"
        • "ASSOCIATING"
        • "ACTIVE"
        • "INACTIVE"
        • "DISASSOCIATING"
        • "DISASSOCIATED"
        • "FAILED_TO_ASSOCIATE"
        • "FAILED_TO_DISASSOCIATE"
    • 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.

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 Amazon Resource Name (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 of the fleet 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"
      • Tags — (map<String>)

        The tags attached to the resource. A tag is a key-value pair.

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

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
worklink.listTagsForResource(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: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (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:

    • Tags — (map<String>)

      The tags attached to the resource. A tag is a key-value pair.

Returns:

• (AWS.Request) —

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

var params = {
  FleetArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
worklink.listWebsiteAuthorizationProviders(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 to use 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:

    • WebsiteAuthorizationProviders — (Array<map>)

      The website authorization providers.

      • AuthorizationProviderId — (String)

        A unique identifier for the authorization provider.

      • AuthorizationProviderType — required — (String)

        The authorization provider type.

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

        The domain name of the authorization provider. This applies only to SAML-based authorization providers.

      • CreatedTime — (Date)

        The time of creation.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

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.

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.

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.

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.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
worklink.tagResource(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: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the fleet.

  • Tags — (map<String>)

    The tags to add to the resource. A tag is a key-value pair.

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.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
worklink.untagResource(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: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the fleet.

  • TagKeys — (Array<String>)

    The list of tag keys to remove from the resource.

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.

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.

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.

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.

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.

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.

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.