AWS API Changes

2024/04/23 - Amazon WorkSpaces Web - 10 updated api methods

Changes Added InstanceType and MaxConcurrentSessions parameters on CreatePortal and UpdatePortal Operations as well as the ability to read Customer Managed Key & Additional Encryption Context parameters on supported resources (Portal, BrowserSettings, UserSettings, IPAccessSettings)

CreatePortal (updated)

Link ¶
Changes (request)

{'instanceType': 'standard.regular | standard.large | standard.xlarge',
 'maxConcurrentSessions': 'integer'}

Creates a web portal.

See also: AWS API Documentation

Request Syntax

client.create_portal(
    additionalEncryptionContext={
        'string': 'string'
    },
    authenticationType='Standard'|'IAM_Identity_Center',
    clientToken='string',
    customerManagedKey='string',
    displayName='string',
    instanceType='standard.regular'|'standard.large'|'standard.xlarge',
    maxConcurrentSessions=123,
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type additionalEncryptionContext:

dict

param additionalEncryptionContext:

The additional encryption context of the portal.

(string) --
- (string) --

type authenticationType:

string

param authenticationType:

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

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 Amazon Web Services SDK.

This field is autopopulated if not provided.

type customerManagedKey:

string

param customerManagedKey:

The customer managed key of the web portal.

type displayName:

string

param displayName:

The name of the web portal. This is not visible to users who log into the web portal.

type instanceType:

string

param instanceType:

The type and resources of the underlying instance.

type maxConcurrentSessions:

integer

param maxConcurrentSessions:

The maximum number of concurrent sessions for the portal.

type tags:

list

param tags:

The tags to add to the web portal. 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

rtype:

dict

returns:

Response Syntax

{
    'portalArn': 'string',
    'portalEndpoint': 'string'
}

Response Structure

(dict) --
- portalArn (string) --
  
  The ARN of the web portal.
- portalEndpoint (string) --
  
  The endpoint URL of the web portal that users access in order to start streaming sessions.

GetBrowserSettings (updated)

Link ¶
Changes (response)

{'browserSettings': {'additionalEncryptionContext': {'string': 'string'},
                     'customerManagedKey': 'string'}}

Gets browser settings.

See also: AWS API Documentation

Request Syntax

client.get_browser_settings(
    browserSettingsArn='string'
)

type browserSettingsArn:

string

param browserSettingsArn:

[REQUIRED]

The ARN of the browser settings.

rtype:

dict

returns:

Response Syntax

{
    'browserSettings': {
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'associatedPortalArns': [
            'string',
        ],
        'browserPolicy': 'string',
        'browserSettingsArn': 'string',
        'customerManagedKey': 'string'
    }
}

Response Structure

(dict) --
- browserSettings (dict) --
  
  The browser settings.
  - additionalEncryptionContext (dict) --
    
    The additional encryption context of the browser settings.
    - (string) --
      - (string) --
  - associatedPortalArns (list) --
    
    A list of web portal ARNs that this browser settings is associated with.
    - (string) --
  - browserPolicy (string) --
    
    A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
  - browserSettingsArn (string) --
    
    The ARN of the browser settings.
  - customerManagedKey (string) --
    
    The customer managed key used to encrypt sensitive information in the browser settings.

GetIpAccessSettings (updated)

Link ¶
Changes (response)

{'ipAccessSettings': {'additionalEncryptionContext': {'string': 'string'},
                      'customerManagedKey': 'string'}}

Gets the IP access settings.

See also: AWS API Documentation

Request Syntax

client.get_ip_access_settings(
    ipAccessSettingsArn='string'
)

type ipAccessSettingsArn:

string

param ipAccessSettingsArn:

[REQUIRED]

The ARN of the IP access settings.

rtype:

dict

returns:

Response Syntax

{
    'ipAccessSettings': {
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'associatedPortalArns': [
            'string',
        ],
        'creationDate': datetime(2015, 1, 1),
        'customerManagedKey': 'string',
        'description': 'string',
        'displayName': 'string',
        'ipAccessSettingsArn': 'string',
        'ipRules': [
            {
                'description': 'string',
                'ipRange': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- ipAccessSettings (dict) --
  
  The IP access settings.
  - additionalEncryptionContext (dict) --
    
    The additional encryption context of the IP access settings.
    - (string) --
      - (string) --
  - associatedPortalArns (list) --
    
    A list of web portal ARNs that this IP access settings resource is associated with.
    - (string) --
  - creationDate (datetime) --
    
    The creation date timestamp of the IP access settings.
  - customerManagedKey (string) --
    
    The customer managed key used to encrypt sensitive information in the IP access settings.
  - description (string) --
    
    The description of the IP access settings.
  - displayName (string) --
    
    The display name of the IP access settings.
  - ipAccessSettingsArn (string) --
    
    The ARN of the IP access settings resource.
  - ipRules (list) --
    
    The IP rules of the IP access settings.
    - (dict) --
      
      The IP rules of the IP access settings.
      - description (string) --
        
        The description of the IP rule.
      - ipRange (string) --
        
        The IP range of the IP rule.

GetPortal (updated)

Link ¶
Changes (response)

{'portal': {'additionalEncryptionContext': {'string': 'string'},
            'customerManagedKey': 'string',
            'instanceType': 'standard.regular | standard.large | '
                            'standard.xlarge',
            'maxConcurrentSessions': 'integer'}}

Gets the web portal.

See also: AWS API Documentation

Request Syntax

client.get_portal(
    portalArn='string'
)

type portalArn:

string

param portalArn:

[REQUIRED]

The ARN of the web portal.

rtype:

dict

returns:

Response Syntax

{
    'portal': {
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'authenticationType': 'Standard'|'IAM_Identity_Center',
        'browserSettingsArn': 'string',
        'browserType': 'Chrome',
        'creationDate': datetime(2015, 1, 1),
        'customerManagedKey': 'string',
        'displayName': 'string',
        'instanceType': 'standard.regular'|'standard.large'|'standard.xlarge',
        'ipAccessSettingsArn': 'string',
        'maxConcurrentSessions': 123,
        'networkSettingsArn': 'string',
        'portalArn': 'string',
        'portalEndpoint': 'string',
        'portalStatus': 'Incomplete'|'Pending'|'Active',
        'rendererType': 'AppStream',
        'statusReason': 'string',
        'trustStoreArn': 'string',
        'userAccessLoggingSettingsArn': 'string',
        'userSettingsArn': 'string'
    }
}

Response Structure

(dict) --
- portal (dict) --
  
  The web portal.
  - additionalEncryptionContext (dict) --
    
    The additional encryption context of the portal.
    - (string) --
      - (string) --
  - authenticationType (string) --
    
    The type of authentication integration points used when signing into the web portal. Defaults to Standard.
    
    Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
    
    IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
  - browserSettingsArn (string) --
    
    The ARN of the browser settings that is associated with this web portal.
  - browserType (string) --
    
    The browser that users see when using a streaming session.
  - creationDate (datetime) --
    
    The creation date of the web portal.
  - customerManagedKey (string) --
    
    The customer managed key used to encrypt sensitive information in the portal.
  - displayName (string) --
    
    The name of the web portal.
  - instanceType (string) --
    
    The type and resources of the underlying instance.
  - ipAccessSettingsArn (string) --
    
    The ARN of the IP access settings.
  - maxConcurrentSessions (integer) --
    
    The maximum number of concurrent sessions for the portal.
  - networkSettingsArn (string) --
    
    The ARN of the network settings that is associated with the web portal.
  - portalArn (string) --
    
    The ARN of the web portal.
  - portalEndpoint (string) --
    
    The endpoint URL of the web portal that users access in order to start streaming sessions.
  - portalStatus (string) --
    
    The status of the web portal.
  - rendererType (string) --
    
    The renderer that is used in streaming sessions.
  - statusReason (string) --
    
    A message that explains why the web portal is in its current status.
  - trustStoreArn (string) --
    
    The ARN of the trust store that is associated with the web portal.
  - userAccessLoggingSettingsArn (string) --
    
    The ARN of the user access logging settings that is associated with the web portal.
  - userSettingsArn (string) --
    
    The ARN of the user settings that is associated with the web portal.

GetUserSettings (updated)

Link ¶
Changes (response)

{'userSettings': {'additionalEncryptionContext': {'string': 'string'},
                  'customerManagedKey': 'string'}}

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': {
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'associatedPortalArns': [
            'string',
        ],
        'cookieSynchronizationConfiguration': {
            'allowlist': [
                {
                    'domain': 'string',
                    'name': 'string',
                    'path': 'string'
                },
            ],
            'blocklist': [
                {
                    'domain': 'string',
                    'name': 'string',
                    'path': 'string'
                },
            ]
        },
        'copyAllowed': 'Disabled'|'Enabled',
        'customerManagedKey': 'string',
        '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.
  - additionalEncryptionContext (dict) --
    
    The additional encryption context of the user settings.
    - (string) --
      - (string) --
  - associatedPortalArns (list) --
    
    A list of web portal ARNs that this user settings is associated with.
    - (string) --
  - cookieSynchronizationConfiguration (dict) --
    
    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.
      - (dict) --
        
        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.
      - (dict) --
        
        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.
  - copyAllowed (string) --
    
    Specifies whether the user can copy text from the streaming session to the local device.
  - customerManagedKey (string) --
    
    The customer managed key used to encrypt sensitive information in the user settings.
  - 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.

ListPortals (updated)

Link ¶
Changes (response)

{'portals': {'instanceType': 'standard.regular | standard.large | '
                             'standard.xlarge',
             'maxConcurrentSessions': 'integer'}}

Retrieves a list or web portals.

See also: AWS API Documentation

Request Syntax

client.list_portals(
    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',
    'portals': [
        {
            'authenticationType': 'Standard'|'IAM_Identity_Center',
            'browserSettingsArn': 'string',
            'browserType': 'Chrome',
            'creationDate': datetime(2015, 1, 1),
            'displayName': 'string',
            'instanceType': 'standard.regular'|'standard.large'|'standard.xlarge',
            'ipAccessSettingsArn': 'string',
            'maxConcurrentSessions': 123,
            'networkSettingsArn': 'string',
            'portalArn': 'string',
            'portalEndpoint': 'string',
            'portalStatus': 'Incomplete'|'Pending'|'Active',
            'rendererType': 'AppStream',
            'trustStoreArn': 'string',
            'userAccessLoggingSettingsArn': 'string',
            'userSettingsArn': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  The pagination token used to retrieve the next page of results for this operation.
- portals (list) --
  
  The portals in the list.
  - (dict) --
    
    The summary of the portal.
    - authenticationType (string) --
      
      The type of authentication integration points used when signing into the web portal. Defaults to Standard.
      
      Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
      
      IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
    - browserSettingsArn (string) --
      
      The ARN of the browser settings that is associated with the web portal.
    - browserType (string) --
      
      The browser type of the web portal.
    - creationDate (datetime) --
      
      The creation date of the web portal.
    - displayName (string) --
      
      The name of the web portal.
    - instanceType (string) --
      
      The type and resources of the underlying instance.
    - ipAccessSettingsArn (string) --
      
      The ARN of the IP access settings.
    - maxConcurrentSessions (integer) --
      
      The maximum number of concurrent sessions for the portal.
    - networkSettingsArn (string) --
      
      The ARN of the network settings that is associated with the web portal.
    - portalArn (string) --
      
      The ARN of the web portal.
    - portalEndpoint (string) --
      
      The endpoint URL of the web portal that users access in order to start streaming sessions.
    - portalStatus (string) --
      
      The status of the web portal.
    - rendererType (string) --
      
      The renderer that is used in streaming sessions.
    - trustStoreArn (string) --
      
      The ARN of the trust that is associated with this web portal.
    - userAccessLoggingSettingsArn (string) --
      
      The ARN of the user access logging settings that is associated with the web portal.
    - userSettingsArn (string) --
      
      The ARN of the user settings that is associated with the web portal.

UpdateBrowserSettings (updated)

Link ¶
Changes (response)

{'browserSettings': {'additionalEncryptionContext': {'string': 'string'},
                     'customerManagedKey': 'string'}}

Updates browser settings.

See also: AWS API Documentation

Request Syntax

client.update_browser_settings(
    browserPolicy='string',
    browserSettingsArn='string',
    clientToken='string'
)

type browserPolicy:

string

param browserPolicy:

A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

type browserSettingsArn:

string

param browserSettingsArn:

[REQUIRED]

The ARN of the browser settings.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'browserSettings': {
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'associatedPortalArns': [
            'string',
        ],
        'browserPolicy': 'string',
        'browserSettingsArn': 'string',
        'customerManagedKey': 'string'
    }
}

Response Structure

(dict) --
- browserSettings (dict) --
  
  The browser settings.
  - additionalEncryptionContext (dict) --
    
    The additional encryption context of the browser settings.
    - (string) --
      - (string) --
  - associatedPortalArns (list) --
    
    A list of web portal ARNs that this browser settings is associated with.
    - (string) --
  - browserPolicy (string) --
    
    A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.
  - browserSettingsArn (string) --
    
    The ARN of the browser settings.
  - customerManagedKey (string) --
    
    The customer managed key used to encrypt sensitive information in the browser settings.

UpdateIpAccessSettings (updated)

Link ¶
Changes (response)

{'ipAccessSettings': {'additionalEncryptionContext': {'string': 'string'},
                      'customerManagedKey': 'string'}}

Updates IP access settings.

See also: AWS API Documentation

Request Syntax

client.update_ip_access_settings(
    clientToken='string',
    description='string',
    displayName='string',
    ipAccessSettingsArn='string',
    ipRules=[
        {
            'description': 'string',
            'ipRange': 'string'
        },
    ]
)

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

type description:

string

param description:

The description of the IP access settings.

type displayName:

string

param displayName:

The display name of the IP access settings.

type ipAccessSettingsArn:

string

param ipAccessSettingsArn:

[REQUIRED]

The ARN of the IP access settings.

type ipRules:

list

param ipRules:

The updated IP rules of the IP access settings.

(dict) --

The IP rules of the IP access settings.
- description (string) --
  
  The description of the IP rule.
- ipRange (string) -- [REQUIRED]
  
  The IP range of the IP rule.

rtype:

dict

returns:

Response Syntax

{
    'ipAccessSettings': {
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'associatedPortalArns': [
            'string',
        ],
        'creationDate': datetime(2015, 1, 1),
        'customerManagedKey': 'string',
        'description': 'string',
        'displayName': 'string',
        'ipAccessSettingsArn': 'string',
        'ipRules': [
            {
                'description': 'string',
                'ipRange': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- ipAccessSettings (dict) --
  
  The IP access settings.
  - additionalEncryptionContext (dict) --
    
    The additional encryption context of the IP access settings.
    - (string) --
      - (string) --
  - associatedPortalArns (list) --
    
    A list of web portal ARNs that this IP access settings resource is associated with.
    - (string) --
  - creationDate (datetime) --
    
    The creation date timestamp of the IP access settings.
  - customerManagedKey (string) --
    
    The customer managed key used to encrypt sensitive information in the IP access settings.
  - description (string) --
    
    The description of the IP access settings.
  - displayName (string) --
    
    The display name of the IP access settings.
  - ipAccessSettingsArn (string) --
    
    The ARN of the IP access settings resource.
  - ipRules (list) --
    
    The IP rules of the IP access settings.
    - (dict) --
      
      The IP rules of the IP access settings.
      - description (string) --
        
        The description of the IP rule.
      - ipRange (string) --
        
        The IP range of the IP rule.

UpdatePortal (updated)

Link ¶
Changes (request, response)
Request

{'instanceType': 'standard.regular | standard.large | standard.xlarge',
 'maxConcurrentSessions': 'integer'}

Response

{'portal': {'additionalEncryptionContext': {'string': 'string'},
            'customerManagedKey': 'string',
            'instanceType': 'standard.regular | standard.large | '
                            'standard.xlarge',
            'maxConcurrentSessions': 'integer'}}

Updates a web portal.

See also: AWS API Documentation

Request Syntax

client.update_portal(
    authenticationType='Standard'|'IAM_Identity_Center',
    displayName='string',
    instanceType='standard.regular'|'standard.large'|'standard.xlarge',
    maxConcurrentSessions=123,
    portalArn='string'
)

type authenticationType:

string

param authenticationType:

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

type displayName:

string

param displayName:

The name of the web portal. This is not visible to users who log into the web portal.

type instanceType:

string

param instanceType:

The type and resources of the underlying instance.

type maxConcurrentSessions:

integer

param maxConcurrentSessions:

The maximum number of concurrent sessions for the portal.

type portalArn:

string

param portalArn:

[REQUIRED]

The ARN of the web portal.

rtype:

dict

returns:

Response Syntax

{
    'portal': {
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'authenticationType': 'Standard'|'IAM_Identity_Center',
        'browserSettingsArn': 'string',
        'browserType': 'Chrome',
        'creationDate': datetime(2015, 1, 1),
        'customerManagedKey': 'string',
        'displayName': 'string',
        'instanceType': 'standard.regular'|'standard.large'|'standard.xlarge',
        'ipAccessSettingsArn': 'string',
        'maxConcurrentSessions': 123,
        'networkSettingsArn': 'string',
        'portalArn': 'string',
        'portalEndpoint': 'string',
        'portalStatus': 'Incomplete'|'Pending'|'Active',
        'rendererType': 'AppStream',
        'statusReason': 'string',
        'trustStoreArn': 'string',
        'userAccessLoggingSettingsArn': 'string',
        'userSettingsArn': 'string'
    }
}

Response Structure

(dict) --
- portal (dict) --
  
  The web portal.
  - additionalEncryptionContext (dict) --
    
    The additional encryption context of the portal.
    - (string) --
      - (string) --
  - authenticationType (string) --
    
    The type of authentication integration points used when signing into the web portal. Defaults to Standard.
    
    Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
    
    IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
  - browserSettingsArn (string) --
    
    The ARN of the browser settings that is associated with this web portal.
  - browserType (string) --
    
    The browser that users see when using a streaming session.
  - creationDate (datetime) --
    
    The creation date of the web portal.
  - customerManagedKey (string) --
    
    The customer managed key used to encrypt sensitive information in the portal.
  - displayName (string) --
    
    The name of the web portal.
  - instanceType (string) --
    
    The type and resources of the underlying instance.
  - ipAccessSettingsArn (string) --
    
    The ARN of the IP access settings.
  - maxConcurrentSessions (integer) --
    
    The maximum number of concurrent sessions for the portal.
  - networkSettingsArn (string) --
    
    The ARN of the network settings that is associated with the web portal.
  - portalArn (string) --
    
    The ARN of the web portal.
  - portalEndpoint (string) --
    
    The endpoint URL of the web portal that users access in order to start streaming sessions.
  - portalStatus (string) --
    
    The status of the web portal.
  - rendererType (string) --
    
    The renderer that is used in streaming sessions.
  - statusReason (string) --
    
    A message that explains why the web portal is in its current status.
  - trustStoreArn (string) --
    
    The ARN of the trust store that is associated with the web portal.
  - userAccessLoggingSettingsArn (string) --
    
    The ARN of the user access logging settings that is associated with the web portal.
  - userSettingsArn (string) --
    
    The ARN of the user settings that is associated with the web portal.

UpdateUserSettings (updated)

Link ¶
Changes (response)

{'userSettings': {'additionalEncryptionContext': {'string': 'string'},
                  'customerManagedKey': 'string'}}

Updates the user settings.

See also: AWS API Documentation

Request Syntax

client.update_user_settings(
    clientToken='string',
    cookieSynchronizationConfiguration={
        'allowlist': [
            {
                'domain': 'string',
                'name': 'string',
                'path': 'string'
            },
        ],
        'blocklist': [
            {
                'domain': 'string',
                'name': 'string',
                'path': '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:

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

This field is autopopulated if not provided.

type cookieSynchronizationConfiguration:

dict

param cookieSynchronizationConfiguration:

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

If the allowlist and blocklist are empty, the configuration becomes null.

allowlist (list) -- [REQUIRED]

The list of cookie specifications that are allowed to be synchronized to the remote browser.
- (dict) --
  
  Specifies a single cookie or set of cookies in an end user's browser.
  - domain (string) -- [REQUIRED]
    
    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.
- (dict) --
  
  Specifies a single cookie or set of cookies in an end user's browser.
  - domain (string) -- [REQUIRED]
    
    The domain of the cookie.
  - name (string) --
    
    The name of the cookie.
  - path (string) --
    
    The path of the cookie.

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': {
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'associatedPortalArns': [
            'string',
        ],
        'cookieSynchronizationConfiguration': {
            'allowlist': [
                {
                    'domain': 'string',
                    'name': 'string',
                    'path': 'string'
                },
            ],
            'blocklist': [
                {
                    'domain': 'string',
                    'name': 'string',
                    'path': 'string'
                },
            ]
        },
        'copyAllowed': 'Disabled'|'Enabled',
        'customerManagedKey': 'string',
        '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.
  - additionalEncryptionContext (dict) --
    
    The additional encryption context of the user settings.
    - (string) --
      - (string) --
  - associatedPortalArns (list) --
    
    A list of web portal ARNs that this user settings is associated with.
    - (string) --
  - cookieSynchronizationConfiguration (dict) --
    
    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.
      - (dict) --
        
        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.
      - (dict) --
        
        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.
  - copyAllowed (string) --
    
    Specifies whether the user can copy text from the streaming session to the local device.
  - customerManagedKey (string) --
    
    The customer managed key used to encrypt sensitive information in the user settings.
  - 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.