[ aws . workspaces-web ]

list-user-settings

Description

Retrieves a list of user settings.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-user-settings
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--max-results (integer)

The maximum number of results to be included in the next page.

--next-token (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

nextToken -> (string)

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

userSettings -> (list)

The user settings.

(structure)

The summary of user settings.

copyAllowed -> (string)

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

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.

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.

printAllowed -> (string)

Specifies whether the user can print to the local device.

uploadAllowed -> (string)

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

userSettingsArn -> (string)

The ARN of the user settings.