CreateUserSettingsCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkSpacesWebClient, CreateUserSettingsCommand } from "@aws-sdk/client-workspaces-web"; // ES Modules import
// const { WorkSpacesWebClient, CreateUserSettingsCommand } = require("@aws-sdk/client-workspaces-web"); // CommonJS import
const client = new WorkSpacesWebClient(config);
const input = { // CreateUserSettingsRequest
  copyAllowed: "STRING_VALUE", // required
  pasteAllowed: "STRING_VALUE", // required
  downloadAllowed: "STRING_VALUE", // required
  uploadAllowed: "STRING_VALUE", // required
  printAllowed: "STRING_VALUE", // required
  tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
  disconnectTimeoutInMinutes: Number("int"),
  idleDisconnectTimeoutInMinutes: Number("int"),
  clientToken: "STRING_VALUE",
  cookieSynchronizationConfiguration: { // CookieSynchronizationConfiguration
    allowlist: [ // CookieSpecifications // required
      { // CookieSpecification
        domain: "STRING_VALUE", // required
        name: "STRING_VALUE",
        path: "STRING_VALUE",
      },
    ],
    blocklist: [
      {
        domain: "STRING_VALUE", // required
        name: "STRING_VALUE",
        path: "STRING_VALUE",
      },
    ],
  },
  customerManagedKey: "STRING_VALUE",
  additionalEncryptionContext: { // EncryptionContextMap
    "<keys>": "STRING_VALUE",
  },
  deepLinkAllowed: "STRING_VALUE",
  toolbarConfiguration: { // ToolbarConfiguration
    toolbarType: "STRING_VALUE",
    visualMode: "STRING_VALUE",
    hiddenToolbarItems: [ // HiddenToolbarItemList
      "STRING_VALUE",
    ],
    maxDisplayResolution: "STRING_VALUE",
  },
};
const command = new CreateUserSettingsCommand(input);
const response = await client.send(command);
// { // CreateUserSettingsResponse
//   userSettingsArn: "STRING_VALUE", // required
// };

CreateUserSettingsCommand Input

See CreateUserSettingsCommandInput for more details

Parameter
Type
Description
copyAllowed
Required
EnabledType | undefined

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

downloadAllowed
Required
EnabledType | undefined

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

pasteAllowed
Required
EnabledType | undefined

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

printAllowed
Required
EnabledType | undefined

Specifies whether the user can print to the local device.

uploadAllowed
Required
EnabledType | undefined

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

additionalEncryptionContext
Record<string, string> | undefined

The additional encryption context of the user settings.

clientToken
string | undefined

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.

cookieSynchronizationConfiguration
CookieSynchronizationConfiguration | undefined

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

customerManagedKey
string | undefined

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

deepLinkAllowed
EnabledType | undefined

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

disconnectTimeoutInMinutes
number | undefined

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

idleDisconnectTimeoutInMinutes
number | undefined

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

tags
Tag[] | undefined

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

toolbarConfiguration
ToolbarConfiguration | undefined

The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.

CreateUserSettingsCommand Output

See CreateUserSettingsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
userSettingsArn
Required
string | undefined

The ARN of the user settings.

Throws

Name
Fault
Details
AccessDeniedException
client

Access is denied.

ConflictException
client

There is a conflict.

InternalServerException
server

There is an internal server error.

ServiceQuotaExceededException
client

The service quota has been exceeded.

ThrottlingException
client

There is a throttling error.

ValidationException
client

There is a validation error.

WorkSpacesWebServiceException
Base exception class for all service exceptions from WorkSpacesWeb service.