You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.WorkSpacesWeb

Inherits:
AWS.Service show all
Identifier:
workspacesweb
API Version:
2020-07-08
Defined in:
(unknown)

Overview

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

Service Description

WorkSpaces Web is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Web makes it easy for customers to safely provide their employees with access to internal websites and SaaS web applications without the administrative burden of appliances or specialized client software. WorkSpaces Web provides simple policy tools tailored for user interactions, while offloading common tasks like capacity management, scaling, and maintaining browser images.

Sending a Request Using WorkSpacesWeb

var workspacesweb = new AWS.WorkSpacesWeb();
workspacesweb.associateBrowserSettings(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 WorkSpacesWeb object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var workspacesweb = new AWS.WorkSpacesWeb({apiVersion: '2020-07-08'});

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

AWS.config.apiVersions = {
  workspacesweb: '2020-07-08',
  // other service API versions
};

var workspacesweb = new AWS.WorkSpacesWeb();

Version:

  • 2020-07-08

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.WorkSpacesWeb(options = {}) ⇒ Object

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

Examples:

Constructing a WorkSpacesWeb object

var workspacesweb = new AWS.WorkSpacesWeb({apiVersion: '2020-07-08'});

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|AWS.Endpoint)

    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' or an Endpoint object.

  • 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.WorkSpacesWeb.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.WorkSpacesWeb.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.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets 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 error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • 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|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

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

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

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

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

Associates a browser settings resource with a web portal.

Service Reference:

Examples:

Calling the associateBrowserSettings operation

var params = {
  browserSettingsArn: 'STRING_VALUE', /* required */
  portalArn: 'STRING_VALUE' /* required */
};
workspacesweb.associateBrowserSettings(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: {})
    • browserSettingsArn — (String)

      The ARN of the browser settings.

    • portalArn — (String)

      The ARN of the web portal.

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:

      • browserSettingsArn — (String)

        The ARN of the browser settings.

      • portalArn — (String)

        The ARN of the web portal.

Returns:

  • (AWS.Request)

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

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

Associates a network settings resource with a web portal.

Service Reference:

Examples:

Calling the associateNetworkSettings operation

var params = {
  networkSettingsArn: 'STRING_VALUE', /* required */
  portalArn: 'STRING_VALUE' /* required */
};
workspacesweb.associateNetworkSettings(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: {})
    • networkSettingsArn — (String)

      The ARN of the network settings.

    • portalArn — (String)

      The ARN of the web portal.

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:

      • networkSettingsArn — (String)

        The ARN of the network settings.

      • portalArn — (String)

        The ARN of the web portal.

Returns:

  • (AWS.Request)

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

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

Associates a trust store with a web portal.

Service Reference:

Examples:

Calling the associateTrustStore operation

var params = {
  portalArn: 'STRING_VALUE', /* required */
  trustStoreArn: 'STRING_VALUE' /* required */
};
workspacesweb.associateTrustStore(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: {})
    • portalArn — (String)

      The ARN of the web portal.

    • trustStoreArn — (String)

      The ARN of the trust store.

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:

      • portalArn — (String)

        The ARN of the web portal.

      • trustStoreArn — (String)

        The ARN of the trust store.

Returns:

  • (AWS.Request)

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

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

Associates a user settings resource with a web portal.

Service Reference:

Examples:

Calling the associateUserSettings operation

var params = {
  portalArn: 'STRING_VALUE', /* required */
  userSettingsArn: 'STRING_VALUE' /* required */
};
workspacesweb.associateUserSettings(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: {})
    • portalArn — (String)

      The ARN of the web portal.

    • userSettingsArn — (String)

      The ARN of the user settings.

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:

      • portalArn — (String)

        The ARN of the web portal.

      • userSettingsArn — (String)

        The ARN of the user settings.

Returns:

  • (AWS.Request)

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

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

Creates a browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal.

Service Reference:

Examples:

Calling the createBrowserSettings operation

var params = {
  browserPolicy: 'STRING_VALUE', /* required */
  additionalEncryptionContext: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  clientToken: 'STRING_VALUE',
  customerManagedKey: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
workspacesweb.createBrowserSettings(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: {})
    • additionalEncryptionContext — (map<String>)

      Additional encryption context of the browser settings.

    • browserPolicy — (String)

      A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the AWS SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • customerManagedKey — (String)

      The custom managed key of the browser settings.

    • tags — (Array<map>)

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

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag

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:

      • browserSettingsArn — (String)

        The ARN of the browser settings.

Returns:

  • (AWS.Request)

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

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

Creates an identity provider resource that is then associated with a web portal.

Service Reference:

Examples:

Calling the createIdentityProvider operation

var params = {
  identityProviderDetails: { /* required */
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  identityProviderName: 'STRING_VALUE', /* required */
  identityProviderType: SAML | Facebook | Google | LoginWithAmazon | SignInWithApple | OIDC, /* required */
  portalArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
workspacesweb.createIdentityProvider(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: {})
    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the AWS SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • identityProviderDetails — (map<String>)

      The identity provider details. The following list describes the provider detail keys for each identity provider type.

      • For Google and Login with Amazon:

        • client_id

        • client_secret

        • authorize_scopes

      • For Facebook:

        • client_id

        • client_secret

        • authorize_scopes

        • api_version

      • For Sign in with Apple:

        • client_id

        • team_id

        • key_id

        • private_key

        • authorize_scopes

      • For OIDC providers:

        • client_id

        • client_secret

        • attributes_request_method

        • oidc_issuer

        • authorize_scopes

        • authorize_url if not available from discovery URL specified by oidc_issuer key

        • token_url if not available from discovery URL specified by oidc_issuer key

        • attributes_url if not available from discovery URL specified by oidc_issuer key

        • jwks_uri if not available from discovery URL specified by oidc_issuer key

      • For SAML providers:

        • MetadataFile OR MetadataURL

        • IDPSignout (boolean) optional

    • identityProviderName — (String)

      The identity provider name.

    • identityProviderType — (String)

      The identity provider type.

      Possible values include:
      • "SAML"
      • "Facebook"
      • "Google"
      • "LoginWithAmazon"
      • "SignInWithApple"
      • "OIDC"
    • portalArn — (String)

      The ARN of the web portal.

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:

      • identityProviderArn — (String)

        The ARN of the identity provider.

Returns:

  • (AWS.Request)

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

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

Creates a network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC.

Service Reference:

Examples:

Calling the createNetworkSettings operation

var params = {
  securityGroupIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  subnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  vpcId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
workspacesweb.createNetworkSettings(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: {})
    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the AWS SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • securityGroupIds — (Array<String>)

      One or more security groups used to control access from streaming instances to your VPC.

    • subnetIds — (Array<String>)

      The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

    • tags — (Array<map>)

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

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag

    • vpcId — (String)

      The VPC that streaming instances will connect to.

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:

      • networkSettingsArn — (String)

        The ARN of the network settings.

Returns:

  • (AWS.Request)

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

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

Creates a web portal.

Service Reference:

Examples:

Calling the createPortal operation

var params = {
  additionalEncryptionContext: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  clientToken: 'STRING_VALUE',
  customerManagedKey: 'STRING_VALUE',
  displayName: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
workspacesweb.createPortal(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: {})
    • additionalEncryptionContext — (map<String>)

      The additional encryption context of the portal.

    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the AWS SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • customerManagedKey — (String)

      The customer managed key of the web portal.

    • displayName — (String)

      The name of the web portal. This is not visible to users who log into the web portal.

    • tags — (Array<map>)

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

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag

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:

      • portalArn — (String)

        The ARN of the web portal.

      • portalEndpoint — (String)

        The endpoint URL of the web portal that users access in order to start streaming sessions.

Returns:

  • (AWS.Request)

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

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

Creates a trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store.

Service Reference:

Examples:

Calling the createTrustStore operation

var params = {
  certificateList: [ /* required */
    Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    /* more items */
  ],
  clientToken: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
workspacesweb.createTrustStore(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: {})
    • certificateList — (Array<Buffer, Typed Array, Blob, String>)

      A list of CA certificates to be added to the trust store.

    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the AWS SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • tags — (Array<map>)

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

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag

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:

      • trustStoreArn — (String)

        The ARN of the trust store.

Returns:

  • (AWS.Request)

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

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

Creates a user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

Service Reference:

Examples:

Calling the createUserSettings operation

var params = {
  copyAllowed: Disabled | Enabled, /* required */
  downloadAllowed: Disabled | Enabled, /* required */
  pasteAllowed: Disabled | Enabled, /* required */
  printAllowed: Disabled | Enabled, /* required */
  uploadAllowed: Disabled | Enabled, /* required */
  clientToken: 'STRING_VALUE',
  disconnectTimeoutInMinutes: 'NUMBER_VALUE',
  idleDisconnectTimeoutInMinutes: 'NUMBER_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
workspacesweb.createUserSettings(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: {})
    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the AWS SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • copyAllowed — (String)

      Specifies whether the user can copy text from the streaming session to the local device.

      Possible values include:
      • "Disabled"
      • "Enabled"
    • disconnectTimeoutInMinutes — (Integer)

      The amount of time that a streaming session remains active after users disconnect.

    • downloadAllowed — (String)

      Specifies whether the user can download files from the streaming session to the local device.

      Possible values include:
      • "Disabled"
      • "Enabled"
    • idleDisconnectTimeoutInMinutes — (Integer)

      The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

    • pasteAllowed — (String)

      Specifies whether the user can paste text from the local device to the streaming session.

      Possible values include:
      • "Disabled"
      • "Enabled"
    • printAllowed — (String)

      Specifies whether the user can print to the local device.

      Possible values include:
      • "Disabled"
      • "Enabled"
    • tags — (Array<map>)

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

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag

    • uploadAllowed — (String)

      Specifies whether the user can upload files from the local device to the streaming session.

      Possible values include:
      • "Disabled"
      • "Enabled"

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:

      • userSettingsArn — (String)

        The ARN of the user settings.

Returns:

  • (AWS.Request)

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

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

Deletes browser settings.

Service Reference:

Examples:

Calling the deleteBrowserSettings operation

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

      The ARN of the browser settings.

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.

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

Deletes the identity provider.

Service Reference:

Examples:

Calling the deleteIdentityProvider operation

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

      The ARN of the identity 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.

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

Deletes network settings.

Service Reference:

Examples:

Calling the deleteNetworkSettings operation

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

      The ARN of the network settings.

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.

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

Deletes a web portal.

Service Reference:

Examples:

Calling the deletePortal operation

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

      The ARN of the web portal.

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.

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

Deletes the trust store.

Service Reference:

Examples:

Calling the deleteTrustStore operation

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

      The ARN of the trust store.

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.

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

Deletes user settings.

Service Reference:

Examples:

Calling the deleteUserSettings operation

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

      The ARN of the user settings.

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.

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

Disassociates browser settings from a web portal.

Service Reference:

Examples:

Calling the disassociateBrowserSettings operation

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

      The ARN of the web portal.

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.

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

Disassociates network settings from a web portal.

Service Reference:

Examples:

Calling the disassociateNetworkSettings operation

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

      The ARN of the web portal.

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.

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

Disassociates a trust store from a web portal.

Service Reference:

Examples:

Calling the disassociateTrustStore operation

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

      The ARN of the web portal.

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.

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

Disassociates user settings from a web portal.

Service Reference:

Examples:

Calling the disassociateUserSettings operation

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

      The ARN of the web portal.

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.

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

Gets browser settings.

Service Reference:

Examples:

Calling the getBrowserSettings operation

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

      The ARN of the browser settings.

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:

      • browserSettings — (map)

        The browser settings.

        • associatedPortalArns — (Array<String>)

          A list of web portal ARNs that this browser settings is associated with.

        • browserPolicy — (String)

          A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

        • browserSettingsArnrequired — (String)

          The ARN of the browser settings.

Returns:

  • (AWS.Request)

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

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

Gets the identity provider.

Service Reference:

Examples:

Calling the getIdentityProvider operation

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

      The ARN of the identity 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. The data object has the following properties:

      • identityProvider — (map)

        The identity provider.

        • identityProviderArnrequired — (String)

          The ARN of the identity provider.

        • identityProviderDetails — (map<String>)

          The identity provider details. The following list describes the provider detail keys for each identity provider type.

          • For Google and Login with Amazon:

            • client_id

            • client_secret

            • authorize_scopes

          • For Facebook:

            • client_id

            • client_secret

            • authorize_scopes

            • api_version

          • For Sign in with Apple:

            • client_id

            • team_id

            • key_id

            • private_key

            • authorize_scopes

          • For OIDC providers:

            • client_id

            • client_secret

            • attributes_request_method

            • oidc_issuer

            • authorize_scopes

            • authorize_url if not available from discovery URL specified by oidc_issuer key

            • token_url if not available from discovery URL specified by oidc_issuer key

            • attributes_url if not available from discovery URL specified by oidc_issuer key

            • jwks_uri if not available from discovery URL specified by oidc_issuer key

          • For SAML providers:

            • MetadataFile OR MetadataURL

            • IDPSignout optional

        • identityProviderName — (String)

          The identity provider name.

        • identityProviderType — (String)

          The identity provider type.

          Possible values include:
          • "SAML"
          • "Facebook"
          • "Google"
          • "LoginWithAmazon"
          • "SignInWithApple"
          • "OIDC"

Returns:

  • (AWS.Request)

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

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

Gets the network settings.

Service Reference:

Examples:

Calling the getNetworkSettings operation

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

      The ARN of the network settings.

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:

      • networkSettings — (map)

        The network settings.

        • associatedPortalArns — (Array<String>)

          A list of web portal ARNs that this network settings is associated with.

        • networkSettingsArnrequired — (String)

          The ARN of the network settings.

        • securityGroupIds — (Array<String>)

          One or more security groups used to control access from streaming instances to your VPC.

        • subnetIds — (Array<String>)

          The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

        • vpcId — (String)

          The VPC that streaming instances will connect to.

Returns:

  • (AWS.Request)

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

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

Gets the web portal.

Service Reference:

Examples:

Calling the getPortal operation

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

      The ARN of the web portal.

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:

      • portal — (map)

        The web portal.

        • browserSettingsArn — (String)

          The ARN of the browser settings that is associated with this web portal.

        • browserType — (String)

          The browser that users see when using a streaming session.

          Possible values include:
          • "Chrome"
        • creationDate — (Date)

          The creation date of the web portal.

        • displayName — (String)

          The name of the web portal.

        • networkSettingsArn — (String)

          The ARN of the network settings that is associated with the web portal.

        • portalArn — (String)

          The ARN of the web portal.

        • portalEndpoint — (String)

          The endpoint URL of the web portal that users access in order to start streaming sessions.

        • portalStatus — (String)

          The status of the web portal.

          Possible values include:
          • "Incomplete"
          • "Pending"
          • "Active"
        • rendererType — (String)

          The renderer that is used in streaming sessions.

          Possible values include:
          • "AppStream"
        • statusReason — (String)

          A message that explains why the web portal is in its current status.

        • trustStoreArn — (String)

          The ARN of the trust store that is associated with the web portal.

        • userSettingsArn — (String)

          The ARN of the trust store that is associated with the web portal.

Returns:

  • (AWS.Request)

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

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

Gets the service provider metadata.

Examples:

Calling the getPortalServiceProviderMetadata operation

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

      The ARN of the web portal.

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:

      • portalArn — (String)

        The ARN of the web portal.

      • serviceProviderSamlMetadata — (String)

        The service provider SAML metadata.

Returns:

  • (AWS.Request)

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

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

Gets the trust store.

Service Reference:

Examples:

Calling the getTrustStore operation

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

      The ARN of the trust store.

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:

      • trustStore — (map)

        The trust store.

        • associatedPortalArns — (Array<String>)

          A list of web portal ARNs that this trust store is associated with.

        • trustStoreArn — (String)

          The ARN of the trust store.

Returns:

  • (AWS.Request)

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

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

Gets the trust store certificate.

Service Reference:

Examples:

Calling the getTrustStoreCertificate operation

var params = {
  thumbprint: 'STRING_VALUE', /* required */
  trustStoreArn: 'STRING_VALUE' /* required */
};
workspacesweb.getTrustStoreCertificate(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: {})
    • thumbprint — (String)

      The thumbprint of the trust store certificate.

    • trustStoreArn — (String)

      The ARN of the trust store certificate.

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 — (map)

        The certificate of the trust store certificate.

        • body — (Buffer, Typed Array, Blob, String)

          The body of the certificate.

        • issuer — (String)

          The entity that issued the certificate.

        • notValidAfter — (Date)

          The certificate is not valid after this date.

        • notValidBefore — (Date)

          The certificate is not valid before this date.

        • subject — (String)

          The entity the certificate belongs to.

        • thumbprint — (String)

          A hexadecimal identifier for the certificate.

      • trustStoreArn — (String)

        The ARN of the trust store certificate.

Returns:

  • (AWS.Request)

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

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

Gets user settings.

Service Reference:

Examples:

Calling the getUserSettings operation

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

      The ARN of the user settings.

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:

      • userSettings — (map)

        The user settings.

        • associatedPortalArns — (Array<String>)

          A list of web portal ARNs that this user settings is associated with.

        • copyAllowed — (String)

          Specifies whether the user can copy text from the streaming session to the local device.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • disconnectTimeoutInMinutes — (Integer)

          The amount of time that a streaming session remains active after users disconnect.

        • downloadAllowed — (String)

          Specifies whether the user can download files from the streaming session to the local device.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • idleDisconnectTimeoutInMinutes — (Integer)

          The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

        • pasteAllowed — (String)

          Specifies whether the user can paste text from the local device to the streaming session.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • printAllowed — (String)

          Specifies whether the user can print to the local device.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • uploadAllowed — (String)

          Specifies whether the user can upload files from the local device to the streaming session.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • userSettingsArnrequired — (String)

          The ARN of the user settings.

Returns:

  • (AWS.Request)

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

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

Retrieves a list of browser settings.

Service Reference:

Examples:

Calling the listBrowserSettings operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
workspacesweb.listBrowserSettings(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: {})
    • 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.

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:

      • browserSettings — (Array<map>)

        The browser settings.

        • browserSettingsArn — (String)

          The ARN of the browser settings.

      • nextToken — (String)

        The pagination token used to retrieve the next page of results for this operation.

Returns:

  • (AWS.Request)

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

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

Retrieves a list of identity providers for a specific web portal.

Service Reference:

Examples:

Calling the listIdentityProviders operation

var params = {
  portalArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
workspacesweb.listIdentityProviders(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: {})
    • 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.

    • portalArn — (String)

      The ARN of the web portal.

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:

      • identityProviders — (Array<map>)

        The identity providers.

        • identityProviderArn — (String)

          The ARN of the identity provider.

        • identityProviderName — (String)

          The identity provider name.

        • identityProviderType — (String)

          The identity provider type.

          Possible values include:
          • "SAML"
          • "Facebook"
          • "Google"
          • "LoginWithAmazon"
          • "SignInWithApple"
          • "OIDC"
      • nextToken — (String)

        The pagination token used to retrieve the next page of results for this operation.

Returns:

  • (AWS.Request)

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

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

Retrieves a list of network settings.

Service Reference:

Examples:

Calling the listNetworkSettings operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
workspacesweb.listNetworkSettings(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: {})
    • 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.

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:

      • networkSettings — (Array<map>)

        The network settings.

        • networkSettingsArn — (String)

          The ARN of the network settings.

        • vpcId — (String)

          The VPC ID of the network settings.

      • nextToken — (String)

        The pagination token used to retrieve the next page of results for this operation.

Returns:

  • (AWS.Request)

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

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

Retrieves a list or web portals.

Service Reference:

Examples:

Calling the listPortals operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
workspacesweb.listPortals(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: {})
    • 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.

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:

      • nextToken — (String)

        The pagination token used to retrieve the next page of results for this operation.

      • portals — (Array<map>)

        The portals in the list.

        • browserSettingsArn — (String)

          The ARN of the browser settings that is associated with the web portal.

        • browserType — (String)

          The browser type of the web portal.

          Possible values include:
          • "Chrome"
        • creationDate — (Date)

          The creation date of the web portal.

        • displayName — (String)

          The name of the web portal.

        • networkSettingsArn — (String)

          The ARN of the network settings that is associated with the web portal.

        • portalArn — (String)

          The ARN of the web portal.

        • portalEndpoint — (String)

          The endpoint URL of the web portal that users access in order to start streaming sessions.

        • portalStatus — (String)

          The status of the web portal.

          Possible values include:
          • "Incomplete"
          • "Pending"
          • "Active"
        • rendererType — (String)

          The renderer that is used in streaming sessions.

          Possible values include:
          • "AppStream"
        • trustStoreArn — (String)

          The ARN of the trust that is associated with this web portal.

        • userSettingsArn — (String)

          The ARN of the user settings that is associated with the web portal.

Returns:

  • (AWS.Request)

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

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

Retrieves a list of tags for a resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
workspacesweb.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 ARN of 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. The data object has the following properties:

      • tags — (Array<map>)

        The tags of the resource.

        • Keyrequired — (String)

          The key of the tag.

        • Valuerequired — (String)

          The value of the tag

Returns:

  • (AWS.Request)

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

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

Retrieves a list of trust store certificates.

Service Reference:

Examples:

Calling the listTrustStoreCertificates operation

var params = {
  trustStoreArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
workspacesweb.listTrustStoreCertificates(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: {})
    • 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.

    • trustStoreArn — (String)

      The ARN of the trust store

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:

      • certificateList — (Array<map>)

        The certificate list.

        • issuer — (String)

          The entity that issued the certificate.

        • notValidAfter — (Date)

          The certificate is not valid after this date.

        • notValidBefore — (Date)

          The certificate is not valid before this date.

        • subject — (String)

          The entity the certificate belongs to.

        • thumbprint — (String)

          A hexadecimal identifier for the certificate.

      • nextToken — (String)

        The pagination token used to retrieve the next page of results for this operation.>

      • trustStoreArn — (String)

        The ARN of the trust store.

Returns:

  • (AWS.Request)

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

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

Retrieves a list of trust stores.

Service Reference:

Examples:

Calling the listTrustStores operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
workspacesweb.listTrustStores(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: {})
    • 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.

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:

      • nextToken — (String)

        The pagination token used to retrieve the next page of results for this operation.

      • trustStores — (Array<map>)

        The trust stores.

        • trustStoreArn — (String)

          The ARN of the trust store.

Returns:

  • (AWS.Request)

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

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

Retrieves a list of user settings.

Service Reference:

Examples:

Calling the listUserSettings operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
workspacesweb.listUserSettings(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: {})
    • 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.

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:

      • nextToken — (String)

        The pagination token used to retrieve the next page of results for this operation.

      • userSettings — (Array<map>)

        The user settings.

        • copyAllowed — (String)

          Specifies whether the user can copy text from the streaming session to the local device.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • disconnectTimeoutInMinutes — (Integer)

          The amount of time that a streaming session remains active after users disconnect.

        • downloadAllowed — (String)

          Specifies whether the user can download files from the streaming session to the local device.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • idleDisconnectTimeoutInMinutes — (Integer)

          The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

        • pasteAllowed — (String)

          Specifies whether the user can paste text from the local device to the streaming session.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • printAllowed — (String)

          Specifies whether the user can print to the local device.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • uploadAllowed — (String)

          Specifies whether the user can upload files from the local device to the streaming session.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • userSettingsArn — (String)

          The ARN of the user settings.

Returns:

  • (AWS.Request)

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

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

Adds or overwrites one or more tags for the specified resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE'
};
workspacesweb.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: {})
    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the AWS SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • resourceArn — (String)

      The ARN of the resource.

    • tags — (Array<map>)

      The tags of the resource.

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (String)

        The value of the tag

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.

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

Removes one or more tags from the specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
workspacesweb.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 ARN of the resource.

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

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

Updates browser settings.

Service Reference:

Examples:

Calling the updateBrowserSettings operation

var params = {
  browserSettingsArn: 'STRING_VALUE', /* required */
  browserPolicy: 'STRING_VALUE',
  clientToken: 'STRING_VALUE'
};
workspacesweb.updateBrowserSettings(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: {})
    • browserPolicy — (String)

      A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

    • browserSettingsArn — (String)

      The ARN of the browser settings.

    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the AWS SDK.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • browserSettings — (map)

        The browser settings.

        • associatedPortalArns — (Array<String>)

          A list of web portal ARNs that this browser settings is associated with.

        • browserPolicy — (String)

          A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

        • browserSettingsArnrequired — (String)

          The ARN of the browser settings.

Returns:

  • (AWS.Request)

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

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

Updates the identity provider.

Service Reference:

Examples:

Calling the updateIdentityProvider operation

var params = {
  identityProviderArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  identityProviderDetails: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  identityProviderName: 'STRING_VALUE',
  identityProviderType: SAML | Facebook | Google | LoginWithAmazon | SignInWithApple | OIDC
};
workspacesweb.updateIdentityProvider(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: {})
    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the AWS SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • identityProviderArn — (String)

      The ARN of the identity provider.

    • identityProviderDetails — (map<String>)

      The details of the identity provider. The following list describes the provider detail keys for each identity provider type.

      • For Google and Login with Amazon:

        • client_id

        • client_secret

        • authorize_scopes

      • For Facebook:

        • client_id

        • client_secret

        • authorize_scopes

        • api_version

      • For Sign in with Apple:

        • client_id

        • team_id

        • key_id

        • private_key

        • authorize_scopes

      • For OIDC providers:

        • client_id

        • client_secret

        • attributes_request_method

        • oidc_issuer

        • authorize_scopes

        • authorize_url if not available from discovery URL specified by oidc_issuer key

        • token_url if not available from discovery URL specified by oidc_issuer key

        • attributes_url if not available from discovery URL specified by oidc_issuer key

        • jwks_uri if not available from discovery URL specified by oidc_issuer key

      • For SAML providers:

        • MetadataFile OR MetadataURL

        • IDPSignout (boolean) optional

    • identityProviderName — (String)

      The name of the identity provider.

    • identityProviderType — (String)

      The type of the identity provider.

      Possible values include:
      • "SAML"
      • "Facebook"
      • "Google"
      • "LoginWithAmazon"
      • "SignInWithApple"
      • "OIDC"

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:

      • identityProvider — (map)

        The identity provider.

        • identityProviderArnrequired — (String)

          The ARN of the identity provider.

        • identityProviderDetails — (map<String>)

          The identity provider details. The following list describes the provider detail keys for each identity provider type.

          • For Google and Login with Amazon:

            • client_id

            • client_secret

            • authorize_scopes

          • For Facebook:

            • client_id

            • client_secret

            • authorize_scopes

            • api_version

          • For Sign in with Apple:

            • client_id

            • team_id

            • key_id

            • private_key

            • authorize_scopes

          • For OIDC providers:

            • client_id

            • client_secret

            • attributes_request_method

            • oidc_issuer

            • authorize_scopes

            • authorize_url if not available from discovery URL specified by oidc_issuer key

            • token_url if not available from discovery URL specified by oidc_issuer key

            • attributes_url if not available from discovery URL specified by oidc_issuer key

            • jwks_uri if not available from discovery URL specified by oidc_issuer key

          • For SAML providers:

            • MetadataFile OR MetadataURL

            • IDPSignout optional

        • identityProviderName — (String)

          The identity provider name.

        • identityProviderType — (String)

          The identity provider type.

          Possible values include:
          • "SAML"
          • "Facebook"
          • "Google"
          • "LoginWithAmazon"
          • "SignInWithApple"
          • "OIDC"

Returns:

  • (AWS.Request)

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

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

Updates network settings.

Service Reference:

Examples:

Calling the updateNetworkSettings operation

var params = {
  networkSettingsArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  securityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  subnetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  vpcId: 'STRING_VALUE'
};
workspacesweb.updateNetworkSettings(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: {})
    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the AWS SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • networkSettingsArn — (String)

      The ARN of the network settings.

    • securityGroupIds — (Array<String>)

      One or more security groups used to control access from streaming instances to your VPC.

    • subnetIds — (Array<String>)

      The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

    • vpcId — (String)

      The VPC that streaming instances will connect to.

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:

      • networkSettings — (map)

        The network settings.

        • associatedPortalArns — (Array<String>)

          A list of web portal ARNs that this network settings is associated with.

        • networkSettingsArnrequired — (String)

          The ARN of the network settings.

        • securityGroupIds — (Array<String>)

          One or more security groups used to control access from streaming instances to your VPC.

        • subnetIds — (Array<String>)

          The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

        • vpcId — (String)

          The VPC that streaming instances will connect to.

Returns:

  • (AWS.Request)

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

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

Updates a web portal.

Service Reference:

Examples:

Calling the updatePortal operation

var params = {
  portalArn: 'STRING_VALUE', /* required */
  displayName: 'STRING_VALUE'
};
workspacesweb.updatePortal(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: {})
    • displayName — (String)

      The name of the web portal. This is not visible to users who log into the web portal.

    • portalArn — (String)

      The ARN of the web portal.

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:

      • portal — (map)

        The web portal.

        • browserSettingsArn — (String)

          The ARN of the browser settings that is associated with this web portal.

        • browserType — (String)

          The browser that users see when using a streaming session.

          Possible values include:
          • "Chrome"
        • creationDate — (Date)

          The creation date of the web portal.

        • displayName — (String)

          The name of the web portal.

        • networkSettingsArn — (String)

          The ARN of the network settings that is associated with the web portal.

        • portalArn — (String)

          The ARN of the web portal.

        • portalEndpoint — (String)

          The endpoint URL of the web portal that users access in order to start streaming sessions.

        • portalStatus — (String)

          The status of the web portal.

          Possible values include:
          • "Incomplete"
          • "Pending"
          • "Active"
        • rendererType — (String)

          The renderer that is used in streaming sessions.

          Possible values include:
          • "AppStream"
        • statusReason — (String)

          A message that explains why the web portal is in its current status.

        • trustStoreArn — (String)

          The ARN of the trust store that is associated with the web portal.

        • userSettingsArn — (String)

          The ARN of the trust store that is associated with the web portal.

Returns:

  • (AWS.Request)

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

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

Updates the trust store.

Service Reference:

Examples:

Calling the updateTrustStore operation

var params = {
  trustStoreArn: 'STRING_VALUE', /* required */
  certificatesToAdd: [
    Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    /* more items */
  ],
  certificatesToDelete: [
    'STRING_VALUE',
    /* more items */
  ],
  clientToken: 'STRING_VALUE'
};
workspacesweb.updateTrustStore(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: {})
    • certificatesToAdd — (Array<Buffer, Typed Array, Blob, String>)

      A list of CA certificates to add to the trust store.

    • certificatesToDelete — (Array<String>)

      A list of CA certificates to delete from a trust store.

    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the AWS SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • trustStoreArn — (String)

      The ARN of the trust store.

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:

      • trustStoreArn — (String)

        The ARN of the trust store.

Returns:

  • (AWS.Request)

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

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

Updates the user settings.

Service Reference:

Examples:

Calling the updateUserSettings operation

var params = {
  userSettingsArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  copyAllowed: Disabled | Enabled,
  disconnectTimeoutInMinutes: 'NUMBER_VALUE',
  downloadAllowed: Disabled | Enabled,
  idleDisconnectTimeoutInMinutes: 'NUMBER_VALUE',
  pasteAllowed: Disabled | Enabled,
  printAllowed: Disabled | Enabled,
  uploadAllowed: Disabled | Enabled
};
workspacesweb.updateUserSettings(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: {})
    • clientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

      If you do not specify a client token, one is automatically generated by the AWS SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • copyAllowed — (String)

      Specifies whether the user can copy text from the streaming session to the local device.

      Possible values include:
      • "Disabled"
      • "Enabled"
    • disconnectTimeoutInMinutes — (Integer)

      The amount of time that a streaming session remains active after users disconnect.

    • downloadAllowed — (String)

      Specifies whether the user can download files from the streaming session to the local device.

      Possible values include:
      • "Disabled"
      • "Enabled"
    • idleDisconnectTimeoutInMinutes — (Integer)

      The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

    • pasteAllowed — (String)

      Specifies whether the user can paste text from the local device to the streaming session.

      Possible values include:
      • "Disabled"
      • "Enabled"
    • printAllowed — (String)

      Specifies whether the user can print to the local device.

      Possible values include:
      • "Disabled"
      • "Enabled"
    • uploadAllowed — (String)

      Specifies whether the user can upload files from the local device to the streaming session.

      Possible values include:
      • "Disabled"
      • "Enabled"
    • userSettingsArn — (String)

      The ARN of the user settings.

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:

      • userSettings — (map)

        The user settings.

        • associatedPortalArns — (Array<String>)

          A list of web portal ARNs that this user settings is associated with.

        • copyAllowed — (String)

          Specifies whether the user can copy text from the streaming session to the local device.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • disconnectTimeoutInMinutes — (Integer)

          The amount of time that a streaming session remains active after users disconnect.

        • downloadAllowed — (String)

          Specifies whether the user can download files from the streaming session to the local device.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • idleDisconnectTimeoutInMinutes — (Integer)

          The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

        • pasteAllowed — (String)

          Specifies whether the user can paste text from the local device to the streaming session.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • printAllowed — (String)

          Specifies whether the user can print to the local device.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • uploadAllowed — (String)

          Specifies whether the user can upload files from the local device to the streaming session.

          Possible values include:
          • "Disabled"
          • "Enabled"
        • userSettingsArnrequired — (String)

          The ARN of the user settings.

Returns:

  • (AWS.Request)

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