Amazon WorkSpaces Web

2022/05/16 - Amazon WorkSpaces Web - 4 updated api methods

Changes  Amazon WorkSpaces Web now supports Administrator timeout control

CreateUserSettings (updated) Link ¶
Changes (request) 
{'disconnectTimeoutInMinutes': 'integer',
 'idleDisconnectTimeoutInMinutes': 'integer'}

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

Request Syntax

client.create_user_settings(
    clientToken='string',
    copyAllowed='Disabled'|'Enabled',
    disconnectTimeoutInMinutes=123,
    downloadAllowed='Disabled'|'Enabled',
    idleDisconnectTimeoutInMinutes=123,
    pasteAllowed='Disabled'|'Enabled',
    printAllowed='Disabled'|'Enabled',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    uploadAllowed='Disabled'|'Enabled'
)
type clientToken:

string

param clientToken:

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.

This field is autopopulated if not provided.

type copyAllowed:

string

param copyAllowed:

[REQUIRED]

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

type disconnectTimeoutInMinutes:

integer

param disconnectTimeoutInMinutes:

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

type downloadAllowed:

string

param downloadAllowed:

[REQUIRED]

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

type idleDisconnectTimeoutInMinutes:

integer

param idleDisconnectTimeoutInMinutes:

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

type pasteAllowed:

string

param pasteAllowed:

[REQUIRED]

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

type printAllowed:

string

param printAllowed:

[REQUIRED]

Specifies whether the user can print to the local device.

type tags:

list

param tags:

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

  • (dict) --

    The tag.

    • Key (string) -- [REQUIRED]

      The key of the tag.

    • Value (string) -- [REQUIRED]

      The value of the tag

type uploadAllowed:

string

param uploadAllowed:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'userSettingsArn': 'string'
}

Response Structure

  • (dict) --

    • userSettingsArn (string) --

      The ARN of the user settings.

GetUserSettings (updated) Link ¶
Changes (response) 
{'userSettings': {'disconnectTimeoutInMinutes': 'integer',
                  'idleDisconnectTimeoutInMinutes': 'integer'}}

Gets user settings.

See also: AWS API Documentation

Request Syntax

client.get_user_settings(
    userSettingsArn='string'
)
type userSettingsArn:

string

param userSettingsArn:

[REQUIRED]

The ARN of the user settings.

rtype:

dict

returns:

Response Syntax

{
    'userSettings': {
        'associatedPortalArns': [
            'string',
        ],
        'copyAllowed': 'Disabled'|'Enabled',
        'disconnectTimeoutInMinutes': 123,
        'downloadAllowed': 'Disabled'|'Enabled',
        'idleDisconnectTimeoutInMinutes': 123,
        'pasteAllowed': 'Disabled'|'Enabled',
        'printAllowed': 'Disabled'|'Enabled',
        'uploadAllowed': 'Disabled'|'Enabled',
        'userSettingsArn': 'string'
    }
}

Response Structure

  • (dict) --

    • userSettings (dict) --

      The user settings.

      • associatedPortalArns (list) --

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

        • (string) --

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

ListUserSettings (updated) Link ¶
Changes (response) 
{'userSettings': {'disconnectTimeoutInMinutes': 'integer',
                  'idleDisconnectTimeoutInMinutes': 'integer'}}

Retrieves a list of user settings.

See also: AWS API Documentation

Request Syntax

client.list_user_settings(
    maxResults=123,
    nextToken='string'
)
type maxResults:

integer

param maxResults:

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

type nextToken:

string

param nextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'userSettings': [
        {
            'copyAllowed': 'Disabled'|'Enabled',
            'disconnectTimeoutInMinutes': 123,
            'downloadAllowed': 'Disabled'|'Enabled',
            'idleDisconnectTimeoutInMinutes': 123,
            'pasteAllowed': 'Disabled'|'Enabled',
            'printAllowed': 'Disabled'|'Enabled',
            'uploadAllowed': 'Disabled'|'Enabled',
            'userSettingsArn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

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

    • userSettings (list) --

      The user settings.

      • (dict) --

        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.

UpdateUserSettings (updated) Link ¶
Changes (request, response)
Request 
{'disconnectTimeoutInMinutes': 'integer',
 'idleDisconnectTimeoutInMinutes': 'integer'}
Response 
{'userSettings': {'disconnectTimeoutInMinutes': 'integer',
                  'idleDisconnectTimeoutInMinutes': 'integer'}}

Updates the user settings.

See also: AWS API Documentation

Request Syntax

client.update_user_settings(
    clientToken='string',
    copyAllowed='Disabled'|'Enabled',
    disconnectTimeoutInMinutes=123,
    downloadAllowed='Disabled'|'Enabled',
    idleDisconnectTimeoutInMinutes=123,
    pasteAllowed='Disabled'|'Enabled',
    printAllowed='Disabled'|'Enabled',
    uploadAllowed='Disabled'|'Enabled',
    userSettingsArn='string'
)
type clientToken:

string

param clientToken:

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 AWS SDK.

This field is autopopulated if not provided.

type copyAllowed:

string

param copyAllowed:

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

type disconnectTimeoutInMinutes:

integer

param disconnectTimeoutInMinutes:

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

type downloadAllowed:

string

param downloadAllowed:

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

type idleDisconnectTimeoutInMinutes:

integer

param idleDisconnectTimeoutInMinutes:

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

type pasteAllowed:

string

param pasteAllowed:

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

type printAllowed:

string

param printAllowed:

Specifies whether the user can print to the local device.

type uploadAllowed:

string

param uploadAllowed:

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

type userSettingsArn:

string

param userSettingsArn:

[REQUIRED]

The ARN of the user settings.

rtype:

dict

returns:

Response Syntax

{
    'userSettings': {
        'associatedPortalArns': [
            'string',
        ],
        'copyAllowed': 'Disabled'|'Enabled',
        'disconnectTimeoutInMinutes': 123,
        'downloadAllowed': 'Disabled'|'Enabled',
        'idleDisconnectTimeoutInMinutes': 123,
        'pasteAllowed': 'Disabled'|'Enabled',
        'printAllowed': 'Disabled'|'Enabled',
        'uploadAllowed': 'Disabled'|'Enabled',
        'userSettingsArn': 'string'
    }
}

Response Structure

  • (dict) --

    • userSettings (dict) --

      The user settings.

      • associatedPortalArns (list) --

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

        • (string) --

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