AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . workspaces-web ]

create-user-settings

Description

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.

See also: AWS API Documentation

Synopsis

  create-user-settings
[--additional-encryption-context <value>]
[--client-token <value>]
[--cookie-synchronization-configuration <value>]
--copy-allowed <value>
[--customer-managed-key <value>]
[--disconnect-timeout-in-minutes <value>]
--download-allowed <value>
[--idle-disconnect-timeout-in-minutes <value>]
--paste-allowed <value>
--print-allowed <value>
[--tags <value>]
--upload-allowed <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--additional-encryption-context (map)

The additional encryption context of the user settings.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

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

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

--cookie-synchronization-configuration (structure)

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

allowlist -> (list)

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

(structure)

Specifies a single cookie or set of cookies in an end user's browser.

domain -> (string)

The domain of the cookie.

name -> (string)

The name of the cookie.

path -> (string)

The path of the cookie.

blocklist -> (list)

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

(structure)

Specifies a single cookie or set of cookies in an end user's browser.

domain -> (string)

The domain of the cookie.

name -> (string)

The name of the cookie.

path -> (string)

The path of the cookie.

Shorthand Syntax:

allowlist=[{domain=string,name=string,path=string},{domain=string,name=string,path=string}],blocklist=[{domain=string,name=string,path=string},{domain=string,name=string,path=string}]

JSON Syntax:

{
  "allowlist": [
    {
      "domain": "string",
      "name": "string",
      "path": "string"
    }
    ...
  ],
  "blocklist": [
    {
      "domain": "string",
      "name": "string",
      "path": "string"
    }
    ...
  ]
}

--copy-allowed (string)

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

Possible values:

  • Disabled
  • Enabled

--customer-managed-key (string)

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

--disconnect-timeout-in-minutes (integer)

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

--download-allowed (string)

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

Possible values:

  • Disabled
  • Enabled

--idle-disconnect-timeout-in-minutes (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.

--paste-allowed (string)

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

Possible values:

  • Disabled
  • Enabled

--print-allowed (string)

Specifies whether the user can print to the local device.

Possible values:

  • Disabled
  • Enabled

--tags (list)

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

(structure)

The tag.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--upload-allowed (string)

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

Possible values:

  • Disabled
  • Enabled

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

userSettingsArn -> (string)

The ARN of the user settings.