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.