Class: AWS.WorkSpacesWeb

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

    The ARN of the IP access 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:

    • ipAccessSettingsArn — (String)

      The ARN of the IP access settings resource.

    • portalArn — (String)

      The ARN of the web portal.

Returns:

• (AWS.Request) —

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

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.

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.

var params = {
  portalArn: 'STRING_VALUE', /* required */
  userAccessLoggingSettingsArn: 'STRING_VALUE' /* required */
};
workspacesweb.associateUserAccessLoggingSettings(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.

  • userAccessLoggingSettingsArn — (String)

    The ARN of the user access logging 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.

    • userAccessLoggingSettingsArn — (String)

      The ARN of the user access logging settings.

Returns:

• (AWS.Request) —

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

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.

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 Amazon Web Services 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.

    • Key — required — (String)

      The key of the tag.

    • Value — required — (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.

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',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
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 Amazon Web Services 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

      • IDPInit (boolean) optional

      • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

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

  • tags — (Array<map>)

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

    • Key — required — (String)

      The key of the tag.

    • Value — required — (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:

    • identityProviderArn — (String)

      The ARN of the identity provider.

Returns:

• (AWS.Request) —

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

var params = {
  ipRules: [ /* required */
    {
      ipRange: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE'
    },
    /* more items */
  ],
  additionalEncryptionContext: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  clientToken: 'STRING_VALUE',
  customerManagedKey: 'STRING_VALUE',
  description: 'STRING_VALUE',
  displayName: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
workspacesweb.createIpAccessSettings(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 IP access 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 returns the result from the original successful request.

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

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

    The custom managed key of the IP access settings.

  • description — (String)

    The description of the IP access settings.

  • displayName — (String)

    The display name of the IP access settings.

  • ipRules — (Array<map>)

    The IP rules of the IP access settings.

    • description — (String)

      The description of the IP rule.

    • ipRange — required — (String)

      The IP range of the IP rule.

  • tags — (Array<map>)

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

    • Key — required — (String)

      The key of the tag.

    • Value — required — (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:

    • ipAccessSettingsArn — (String)

      The ARN of the IP access settings resource.

Returns:

• (AWS.Request) —

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

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 Amazon Web Services 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.

    • Key — required — (String)

      The key of the tag.

    • Value — required — (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.

var params = {
  additionalEncryptionContext: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  authenticationType: Standard | IAM_Identity_Center,
  clientToken: 'STRING_VALUE',
  customerManagedKey: 'STRING_VALUE',
  displayName: 'STRING_VALUE',
  instanceType: standard.regular | standard.large | standard.xlarge,
  maxConcurrentSessions: 'NUMBER_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.

  • authenticationType — (String)

    The type of authentication integration points used when signing into the web portal. Defaults to Standard.

    Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

    IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

    Possible values include:
    • "Standard"
    • "IAM_Identity_Center"
  • 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 Amazon Web Services 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.

  • instanceType — (String)

    The type and resources of the underlying instance.

    Possible values include:
    • "standard.regular"
    • "standard.large"
    • "standard.xlarge"
  • maxConcurrentSessions — (Integer)

    The maximum number of concurrent sessions for the portal.

  • tags — (Array<map>)

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

    • Key — required — (String)

      The key of the tag.

    • Value — required — (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.

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 Amazon Web Services 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.

    • Key — required — (String)

      The key of the tag.

    • Value — required — (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.

var params = {
  kinesisStreamArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
workspacesweb.createUserAccessLoggingSettings(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 Amazon Web Services SDK.

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

    The ARN of the Kinesis stream.

  • tags — (Array<map>)

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

    • Key — required — (String)

      The key of the tag.

    • Value — required — (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:

    • userAccessLoggingSettingsArn — (String)

      The ARN of the user access logging settings.

Returns:

• (AWS.Request) —

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

var params = {
  copyAllowed: Disabled | Enabled, /* required */
  downloadAllowed: Disabled | Enabled, /* required */
  pasteAllowed: Disabled | Enabled, /* required */
  printAllowed: Disabled | Enabled, /* required */
  uploadAllowed: Disabled | Enabled, /* required */
  additionalEncryptionContext: {
    '<StringType>': 'STRING_VALUE',
    /* '<StringType>': ... */
  },
  clientToken: 'STRING_VALUE',
  cookieSynchronizationConfiguration: {
    allowlist: [ /* required */
      {
        domain: 'STRING_VALUE', /* required */
        name: 'STRING_VALUE',
        path: 'STRING_VALUE'
      },
      /* more items */
    ],
    blocklist: [
      {
        domain: 'STRING_VALUE', /* required */
        name: 'STRING_VALUE',
        path: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  customerManagedKey: 'STRING_VALUE',
  deepLinkAllowed: Disabled | Enabled,
  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: {}) —
  • additionalEncryptionContext — (map<String>)

    The additional encryption context of the user 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 returns the result from the original successful request.

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

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

    The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

    • allowlist — required — (Array<map>)

      The list of cookie specifications that are allowed to be synchronized to the remote browser.

      • domain — required — (String)

        The domain of the cookie.

      • name — (String)

        The name of the cookie.

      • path — (String)

        The path of the cookie.

    • blocklist — (Array<map>)

      The list of cookie specifications that are blocked from being synchronized to the remote browser.

      • domain — required — (String)

        The domain of the cookie.

      • name — (String)

        The name of the cookie.

      • path — (String)

        The path of the cookie.

  • copyAllowed — (String)

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

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

    The customer managed key used to encrypt sensitive information in the user settings.

  • deepLinkAllowed — (String)

    Specifies whether the user can use deep links that open automatically when connecting to a session.

    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.

    • Key — required — (String)

      The key of the tag.

    • Value — required — (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.

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.

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.

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

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

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.

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.

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.

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

    The ARN of the user access logging 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.

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.

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.

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

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.

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.

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

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.

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.

      • additionalEncryptionContext — (map<String>)

        The additional encryption context of 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.

      • browserSettingsArn — required — (String)

        The ARN of the browser settings.

      • customerManagedKey — (String)

        The customer managed key used to encrypt sensitive information in the browser settings.

Returns:

• (AWS.Request) —

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

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.

      • identityProviderArn — required — (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 (boolean) optional

          • IDPInit (boolean) optional

          • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

          • EncryptedResponses (boolean) 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.

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

    The ARN of the IP access 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:

    • ipAccessSettings — (map)

      The IP access settings.

      • additionalEncryptionContext — (map<String>)

        The additional encryption context of the IP access settings.

      • associatedPortalArns — (Array<String>)

        A list of web portal ARNs that this IP access settings resource is associated with.

      • creationDate — (Date)

        The creation date timestamp of the IP access settings.

      • customerManagedKey — (String)

        The customer managed key used to encrypt sensitive information in the IP access settings.

      • description — (String)

        The description of the IP access settings.

      • displayName — (String)

        The display name of the IP access settings.

      • ipAccessSettingsArn — required — (String)

        The ARN of the IP access settings resource.

      • ipRules — (Array<map>)

        The IP rules of the IP access settings.

        • description — (String)

          The description of the IP rule.

        • ipRange — required — (String)

          The IP range of the IP rule.

Returns:

• (AWS.Request) —

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

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.

      • networkSettingsArn — required — (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.

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.

      • additionalEncryptionContext — (map<String>)

        The additional encryption context of the portal.

      • authenticationType — (String)

        The type of authentication integration points used when signing into the web portal. Defaults to Standard.

        Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

        IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

        Possible values include:
        • "Standard"
        • "IAM_Identity_Center"
      • 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.

      • customerManagedKey — (String)

        The customer managed key used to encrypt sensitive information in the portal.

      • displayName — (String)

        The name of the web portal.

      • instanceType — (String)

        The type and resources of the underlying instance.

        Possible values include:
        • "standard.regular"
        • "standard.large"
        • "standard.xlarge"
      • ipAccessSettingsArn — (String)

        The ARN of the IP access settings.

      • maxConcurrentSessions — (Integer)

        The maximum number of concurrent sessions for the portal.

      • networkSettingsArn — (String)

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

      • portalArn — required — (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.

      • userAccessLoggingSettingsArn — (String)

        The ARN of the user access logging settings that is associated with the 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.

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.

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 — required — (String)

        The ARN of the trust store.

Returns:

• (AWS.Request) —

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

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.

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

    The ARN of the user access logging 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:

    • userAccessLoggingSettings — (map)

      The user access logging settings.

      • associatedPortalArns — (Array<String>)

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

      • kinesisStreamArn — (String)

        The ARN of the Kinesis stream.

      • userAccessLoggingSettingsArn — required — (String)

        The ARN of the user access logging settings.

Returns:

• (AWS.Request) —

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

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.

      • additionalEncryptionContext — (map<String>)

        The additional encryption context of the user settings.

      • associatedPortalArns — (Array<String>)

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

      • cookieSynchronizationConfiguration — (map)

        The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

        • allowlist — required — (Array<map>)

          The list of cookie specifications that are allowed to be synchronized to the remote browser.

          • domain — required — (String)

            The domain of the cookie.

          • name — (String)

            The name of the cookie.

          • path — (String)

            The path of the cookie.

        • blocklist — (Array<map>)

          The list of cookie specifications that are blocked from being synchronized to the remote browser.

          • domain — required — (String)

            The domain of the cookie.

          • name — (String)

            The name of the cookie.

          • path — (String)

            The path of the cookie.

      • copyAllowed — (String)

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

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

        The customer managed key used to encrypt sensitive information in the user settings.

      • deepLinkAllowed — (String)

        Specifies whether the user can use deep links that open automatically when connecting to a session.

        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 — required — (String)

        The ARN of the user settings.

Returns:

• (AWS.Request) —

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

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 — required — (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.

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 — required — (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.

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

    • ipAccessSettings — (Array<map>)

      The IP access settings.

      • creationDate — (Date)

        The creation date timestamp of the IP access settings.

      • description — (String)

        The description of the IP access settings.

      • displayName — (String)

        The display name of the IP access settings.

      • ipAccessSettingsArn — required — (String)

        The ARN of IP access 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.

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 — required — (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.

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.

      • authenticationType — (String)

        The type of authentication integration points used when signing into the web portal. Defaults to Standard.

        Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

        IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

        Possible values include:
        • "Standard"
        • "IAM_Identity_Center"
      • 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.

      • instanceType — (String)

        The type and resources of the underlying instance.

        Possible values include:
        • "standard.regular"
        • "standard.large"
        • "standard.xlarge"
      • ipAccessSettingsArn — (String)

        The ARN of the IP access settings.

      • maxConcurrentSessions — (Integer)

        The maximum number of concurrent sessions for the portal.

      • networkSettingsArn — (String)

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

      • portalArn — required — (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.

      • userAccessLoggingSettingsArn — (String)

        The ARN of the user access logging settings that is associated with the 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.

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.

      • Key — required — (String)

        The key of the tag.

      • Value — required — (String)

        The value of the tag

Returns:

• (AWS.Request) —

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

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.

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.

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

    • userAccessLoggingSettings — (Array<map>)

      The user access logging settings.

      • kinesisStreamArn — (String)

        The ARN of the Kinesis stream.

      • userAccessLoggingSettingsArn — required — (String)

        The ARN of the user access logging settings.

Returns:

• (AWS.Request) —

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

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.

      • cookieSynchronizationConfiguration — (map)

        The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

        • allowlist — required — (Array<map>)

          The list of cookie specifications that are allowed to be synchronized to the remote browser.

          • domain — required — (String)

            The domain of the cookie.

          • name — (String)

            The name of the cookie.

          • path — (String)

            The path of the cookie.

        • blocklist — (Array<map>)

          The list of cookie specifications that are blocked from being synchronized to the remote browser.

          • domain — required — (String)

            The domain of the cookie.

          • name — (String)

            The name of the cookie.

          • path — (String)

            The path of the cookie.

      • copyAllowed — (String)

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

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

        Specifies whether the user can use deep links that open automatically when connecting to a session.

        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 — required — (String)

        The ARN of the user settings.

Returns:

• (AWS.Request) —

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

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 Amazon Web Services 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.

    • Key — required — (String)

      The key of the tag.

    • Value — required — (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.

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.

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 Amazon Web Services 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.

      • additionalEncryptionContext — (map<String>)

        The additional encryption context of 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.

      • browserSettingsArn — required — (String)

        The ARN of the browser settings.

      • customerManagedKey — (String)

        The customer managed key used to encrypt sensitive information in the browser settings.

Returns:

• (AWS.Request) —

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

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 Amazon Web Services 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

      • IDPInit (boolean) optional

      • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

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

      • identityProviderArn — required — (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 (boolean) optional

          • IDPInit (boolean) optional

          • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

          • EncryptedResponses (boolean) 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.

var params = {
  ipAccessSettingsArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  displayName: 'STRING_VALUE',
  ipRules: [
    {
      ipRange: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE'
    },
    /* more items */
  ]
};
workspacesweb.updateIpAccessSettings(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 Amazon Web Services SDK.

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

    The description of the IP access settings.

  • displayName — (String)

    The display name of the IP access settings.

  • ipAccessSettingsArn — (String)

    The ARN of the IP access settings.

  • ipRules — (Array<map>)

    The updated IP rules of the IP access settings.

    • description — (String)

      The description of the IP rule.

    • ipRange — required — (String)

      The IP range of the IP rule.

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:

    • ipAccessSettings — (map)

      The IP access settings.

      • additionalEncryptionContext — (map<String>)

        The additional encryption context of the IP access settings.

      • associatedPortalArns — (Array<String>)

        A list of web portal ARNs that this IP access settings resource is associated with.

      • creationDate — (Date)

        The creation date timestamp of the IP access settings.

      • customerManagedKey — (String)

        The customer managed key used to encrypt sensitive information in the IP access settings.

      • description — (String)

        The description of the IP access settings.

      • displayName — (String)

        The display name of the IP access settings.

      • ipAccessSettingsArn — required — (String)

        The ARN of the IP access settings resource.

      • ipRules — (Array<map>)

        The IP rules of the IP access settings.

        • description — (String)

          The description of the IP rule.

        • ipRange — required — (String)

          The IP range of the IP rule.

Returns:

• (AWS.Request) —

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

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 Amazon Web Services 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.

      • networkSettingsArn — required — (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.

var params = {
  portalArn: 'STRING_VALUE', /* required */
  authenticationType: Standard | IAM_Identity_Center,
  displayName: 'STRING_VALUE',
  instanceType: standard.regular | standard.large | standard.xlarge,
  maxConcurrentSessions: 'NUMBER_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: {}) —
  • authenticationType — (String)

    The type of authentication integration points used when signing into the web portal. Defaults to Standard.

    Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

    IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

    Possible values include:
    • "Standard"
    • "IAM_Identity_Center"
  • displayName — (String)

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

  • instanceType — (String)

    The type and resources of the underlying instance.

    Possible values include:
    • "standard.regular"
    • "standard.large"
    • "standard.xlarge"
  • maxConcurrentSessions — (Integer)

    The maximum number of concurrent sessions for the portal.

  • portalArn — (String)

    The ARN of the web portal.