WorkSpacesWeb ************* Client ====== class WorkSpacesWeb.Client A low-level client representing Amazon WorkSpaces Web Amazon WorkSpaces Secure Browser is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Secure Browser makes it easy for customers to safely provide their employees with access to internal websites and SaaS web applications without the administrative burden of appliances or specialized client software. WorkSpaces Secure Browser provides simple policy tools tailored for user interactions, while offloading common tasks like capacity management, scaling, and maintaining browser images. import boto3 client = boto3.client('workspaces-web') These are the available methods: * associate_browser_settings * associate_data_protection_settings * associate_ip_access_settings * associate_network_settings * associate_session_logger * associate_trust_store * associate_user_access_logging_settings * associate_user_settings * can_paginate * close * create_browser_settings * create_data_protection_settings * create_identity_provider * create_ip_access_settings * create_network_settings * create_portal * create_session_logger * create_trust_store * create_user_access_logging_settings * create_user_settings * delete_browser_settings * delete_data_protection_settings * delete_identity_provider * delete_ip_access_settings * delete_network_settings * delete_portal * delete_session_logger * delete_trust_store * delete_user_access_logging_settings * delete_user_settings * disassociate_browser_settings * disassociate_data_protection_settings * disassociate_ip_access_settings * disassociate_network_settings * disassociate_session_logger * disassociate_trust_store * disassociate_user_access_logging_settings * disassociate_user_settings * expire_session * get_browser_settings * get_data_protection_settings * get_identity_provider * get_ip_access_settings * get_network_settings * get_paginator * get_portal * get_portal_service_provider_metadata * get_session * get_session_logger * get_trust_store * get_trust_store_certificate * get_user_access_logging_settings * get_user_settings * get_waiter * list_browser_settings * list_data_protection_settings * list_identity_providers * list_ip_access_settings * list_network_settings * list_portals * list_session_loggers * list_sessions * list_tags_for_resource * list_trust_store_certificates * list_trust_stores * list_user_access_logging_settings * list_user_settings * tag_resource * untag_resource * update_browser_settings * update_data_protection_settings * update_identity_provider * update_ip_access_settings * update_network_settings * update_portal * update_session_logger * update_trust_store * update_user_access_logging_settings * update_user_settings Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListDataProtectionSettings * ListSessionLoggers * ListSessions WorkSpacesWeb / Paginator / ListSessions ListSessions ************ class WorkSpacesWeb.Paginator.ListSessions paginator = client.get_paginator('list_sessions') paginate(**kwargs) Creates an iterator that will paginate through responses from "WorkSpacesWeb.Client.list_sessions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( portalId='string', username='string', sessionId='string', sortBy='StartTimeAscending'|'StartTimeDescending', status='Active'|'Terminated', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **portalId** (*string*) -- **[REQUIRED]** The ID of the web portal for the sessions. * **username** (*string*) -- The username of the session. * **sessionId** (*string*) -- The ID of the session. * **sortBy** (*string*) -- The method in which the returned sessions should be sorted. * **status** (*string*) -- The status of the session. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'sessions': [ { 'portalArn': 'string', 'sessionId': 'string', 'username': 'string', 'status': 'Active'|'Terminated', 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **sessions** *(list) --* The sessions in a list. * *(dict) --* Summary information about a secure browser session. * **portalArn** *(string) --* The ARN of the web portal. * **sessionId** *(string) --* The ID of the session. * **username** *(string) --* The username of the session. * **status** *(string) --* The status of the session. * **startTime** *(datetime) --* The start time of the session. * **endTime** *(datetime) --* The end time of the session. * **NextToken** *(string) --* A token to resume pagination. WorkSpacesWeb / Paginator / ListSessionLoggers ListSessionLoggers ****************** class WorkSpacesWeb.Paginator.ListSessionLoggers paginator = client.get_paginator('list_session_loggers') paginate(**kwargs) Creates an iterator that will paginate through responses from "WorkSpacesWeb.Client.list_session_loggers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'sessionLoggers': [ { 'sessionLoggerArn': 'string', 'logConfiguration': { 's3': { 'bucket': 'string', 'keyPrefix': 'string', 'bucketOwner': 'string', 'logFileFormat': 'JSONLines'|'Json', 'folderStructure': 'Flat'|'NestedByDate' } }, 'displayName': 'string', 'creationDate': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **sessionLoggers** *(list) --* The list of session loggers, including summaries of their details. * *(dict) --* The summary of the session logger resource. * **sessionLoggerArn** *(string) --* The ARN of the session logger resource. * **logConfiguration** *(dict) --* The configuration that specifies where the logs are fowarded. * **s3** *(dict) --* The configuration for delivering the logs to S3. * **bucket** *(string) --* The S3 bucket name where logs are delivered. * **keyPrefix** *(string) --* The S3 path prefix that determines where log files are stored. * **bucketOwner** *(string) --* The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket. * **logFileFormat** *(string) --* The format of the LogFile that is written to S3. * **folderStructure** *(string) --* The folder structure that defines the organizational structure for log files in S3. * **displayName** *(string) --* The human-readable display name. * **creationDate** *(datetime) --* The date the session logger resource was created. * **NextToken** *(string) --* A token to resume pagination. WorkSpacesWeb / Paginator / ListDataProtectionSettings ListDataProtectionSettings ************************** class WorkSpacesWeb.Paginator.ListDataProtectionSettings paginator = client.get_paginator('list_data_protection_settings') paginate(**kwargs) Creates an iterator that will paginate through responses from "WorkSpacesWeb.Client.list_data_protection_settings()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'dataProtectionSettings': [ { 'dataProtectionSettingsArn': 'string', 'displayName': 'string', 'description': 'string', 'creationDate': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **dataProtectionSettings** *(list) --* The data protection settings. * *(dict) --* The summary of the data protection settings. * **dataProtectionSettingsArn** *(string) --* The ARN of the data protection settings. * **displayName** *(string) --* The display name of the data protection settings. * **description** *(string) --* The description of the data protection settings. * **creationDate** *(datetime) --* The creation date timestamp of the data protection settings. * **NextToken** *(string) --* A token to resume pagination. WorkSpacesWeb / Client / get_network_settings get_network_settings ******************** WorkSpacesWeb.Client.get_network_settings(**kwargs) Gets the network settings. See also: AWS API Documentation **Request Syntax** response = client.get_network_settings( networkSettingsArn='string' ) Parameters: **networkSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the network settings. Return type: dict Returns: **Response Syntax** { 'networkSettings': { 'networkSettingsArn': 'string', 'associatedPortalArns': [ 'string', ], 'vpcId': 'string', 'subnetIds': [ 'string', ], 'securityGroupIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **networkSettings** *(dict) --* The network settings. * **networkSettingsArn** *(string) --* The ARN of the network settings. * **associatedPortalArns** *(list) --* A list of web portal ARNs that this network settings is associated with. * *(string) --* * **vpcId** *(string) --* The VPC that streaming instances will connect to. * **subnetIds** *(list) --* The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones. * *(string) --* * **securityGroupIds** *(list) --* One or more security groups used to control access from streaming instances to your VPC. * *(string) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / create_user_access_logging_settings create_user_access_logging_settings *********************************** WorkSpacesWeb.Client.create_user_access_logging_settings(**kwargs) Creates a user access logging settings resource that can be associated with a web portal. See also: AWS API Documentation **Request Syntax** response = client.create_user_access_logging_settings( kinesisStreamArn='string', tags=[ { 'Key': 'string', 'Value': 'string' }, ], clientToken='string' ) Parameters: * **kinesisStreamArn** (*string*) -- **[REQUIRED]** The ARN of the Kinesis stream. * **tags** (*list*) -- 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 * **clientToken** (*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 Amazon Web Services SDK. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'userAccessLoggingSettingsArn': 'string' } **Response Structure** * *(dict) --* * **userAccessLoggingSettingsArn** *(string) --* The ARN of the user access logging settings. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / create_ip_access_settings create_ip_access_settings ************************* WorkSpacesWeb.Client.create_ip_access_settings(**kwargs) Creates an IP access settings resource that can be associated with a web portal. See also: AWS API Documentation **Request Syntax** response = client.create_ip_access_settings( displayName='string', description='string', tags=[ { 'Key': 'string', 'Value': 'string' }, ], customerManagedKey='string', additionalEncryptionContext={ 'string': 'string' }, ipRules=[ { 'ipRange': 'string', 'description': 'string' }, ], clientToken='string' ) Parameters: * **displayName** (*string*) -- The display name of the IP access settings. * **description** (*string*) -- The description of the IP access settings. * **tags** (*list*) -- The tags to add to the IP access 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 * **customerManagedKey** (*string*) -- The custom managed key of the IP access settings. * **additionalEncryptionContext** (*dict*) -- Additional encryption context of the IP access settings. * *(string) --* * *(string) --* * **ipRules** (*list*) -- **[REQUIRED]** The IP rules of the IP access settings. * *(dict) --* The IP rules of the IP access settings. * **ipRange** *(string) --* **[REQUIRED]** The IP range of the IP rule. * **description** *(string) --* The description of the IP rule. * **clientToken** (*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 Amazon Web Services SDK. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'ipAccessSettingsArn': 'string' } **Response Structure** * *(dict) --* * **ipAccessSettingsArn** *(string) --* The ARN of the IP access settings resource. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / get_paginator get_paginator ************* WorkSpacesWeb.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. WorkSpacesWeb / Client / get_data_protection_settings get_data_protection_settings **************************** WorkSpacesWeb.Client.get_data_protection_settings(**kwargs) Gets the data protection settings. See also: AWS API Documentation **Request Syntax** response = client.get_data_protection_settings( dataProtectionSettingsArn='string' ) Parameters: **dataProtectionSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the data protection settings. Return type: dict Returns: **Response Syntax** { 'dataProtectionSettings': { 'dataProtectionSettingsArn': 'string', 'inlineRedactionConfiguration': { 'inlineRedactionPatterns': [ { 'builtInPatternId': 'string', 'customPattern': { 'patternName': 'string', 'patternRegex': 'string', 'patternDescription': 'string', 'keywordRegex': 'string' }, 'redactionPlaceHolder': { 'redactionPlaceHolderType': 'CustomText', 'redactionPlaceHolderText': 'string' }, 'enforcedUrls': [ 'string', ], 'exemptUrls': [ 'string', ], 'confidenceLevel': 123 }, ], 'globalEnforcedUrls': [ 'string', ], 'globalExemptUrls': [ 'string', ], 'globalConfidenceLevel': 123 }, 'associatedPortalArns': [ 'string', ], 'displayName': 'string', 'description': 'string', 'creationDate': datetime(2015, 1, 1), 'customerManagedKey': 'string', 'additionalEncryptionContext': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **dataProtectionSettings** *(dict) --* The data protection settings. * **dataProtectionSettingsArn** *(string) --* The ARN of the data protection settings resource. * **inlineRedactionConfiguration** *(dict) --* The inline redaction configuration for the data protection settings. * **inlineRedactionPatterns** *(list) --* The inline redaction patterns to be enabled for the inline redaction configuration. * *(dict) --* The set of patterns that determine the data types redacted in session. * **builtInPatternId** *(string) --* The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required. * **customPattern** *(dict) --* >The configuration for a custom pattern. Either a customPattern or builtInPatternId is required. * **patternName** *(string) --* The pattern name for the custom pattern. * **patternRegex** *(string) --* The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”. * **patternDescription** *(string) --* The pattern description for the customer pattern. * **keywordRegex** *(string) --* The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi” * **redactionPlaceHolder** *(dict) --* The redaction placeholder that will replace the redacted text in session for the inline redaction pattern. * **redactionPlaceHolderType** *(string) --* The redaction placeholder type that will replace the redacted text in session. * **redactionPlaceHolderText** *(string) --* The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type. * **enforcedUrls** *(list) --* The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration. * *(string) --* * **exemptUrls** *(list) --* The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern. * *(string) --* * **confidenceLevel** *(integer) --* The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level. * **globalEnforcedUrls** *(list) --* The global enforced URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level enforced URL list. * *(string) --* * **globalExemptUrls** *(list) --* The global exempt URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level exempt URL list. * *(string) --* * **globalConfidenceLevel** *(integer) --* The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This is applied to patterns that do not have a pattern-level confidence level. Defaults to confidence level 2. * **associatedPortalArns** *(list) --* A list of web portal ARNs that this data protection settings resource is associated with. * *(string) --* * **displayName** *(string) --* The display name of the data protection settings. * **description** *(string) --* The description of the data protection settings. * **creationDate** *(datetime) --* The creation date timestamp of the data protection settings. * **customerManagedKey** *(string) --* The customer managed key used to encrypt sensitive information in the data protection settings. * **additionalEncryptionContext** *(dict) --* The additional encryption context of the data protection settings. * *(string) --* * *(string) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / list_ip_access_settings list_ip_access_settings *********************** WorkSpacesWeb.Client.list_ip_access_settings(**kwargs) Retrieves a list of IP access settings. See also: AWS API Documentation **Request Syntax** response = client.list_ip_access_settings( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The pagination token used to retrieve the next page of results for this operation. * **maxResults** (*integer*) -- The maximum number of results to be included in the next page. Return type: dict Returns: **Response Syntax** { 'ipAccessSettings': [ { 'ipAccessSettingsArn': 'string', 'displayName': 'string', 'description': 'string', 'creationDate': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **ipAccessSettings** *(list) --* The IP access settings. * *(dict) --* The summary of IP access settings. * **ipAccessSettingsArn** *(string) --* The ARN of IP access settings. * **displayName** *(string) --* The display name of the IP access settings. * **description** *(string) --* The description of the IP access settings. * **creationDate** *(datetime) --* The creation date timestamp of the IP access settings. * **nextToken** *(string) --* The pagination token used to retrieve the next page of results for this operation. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / list_session_loggers list_session_loggers ******************** WorkSpacesWeb.Client.list_session_loggers(**kwargs) Lists all available session logger resources. See also: AWS API Documentation **Request Syntax** response = client.list_session_loggers( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The pagination token used to retrieve the next page of results for this operation. * **maxResults** (*integer*) -- The maximum number of results to be included in the next page. Return type: dict Returns: **Response Syntax** { 'sessionLoggers': [ { 'sessionLoggerArn': 'string', 'logConfiguration': { 's3': { 'bucket': 'string', 'keyPrefix': 'string', 'bucketOwner': 'string', 'logFileFormat': 'JSONLines'|'Json', 'folderStructure': 'Flat'|'NestedByDate' } }, 'displayName': 'string', 'creationDate': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **sessionLoggers** *(list) --* The list of session loggers, including summaries of their details. * *(dict) --* The summary of the session logger resource. * **sessionLoggerArn** *(string) --* The ARN of the session logger resource. * **logConfiguration** *(dict) --* The configuration that specifies where the logs are fowarded. * **s3** *(dict) --* The configuration for delivering the logs to S3. * **bucket** *(string) --* The S3 bucket name where logs are delivered. * **keyPrefix** *(string) --* The S3 path prefix that determines where log files are stored. * **bucketOwner** *(string) --* The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket. * **logFileFormat** *(string) --* The format of the LogFile that is written to S3. * **folderStructure** *(string) --* The folder structure that defines the organizational structure for log files in S3. * **displayName** *(string) --* The human-readable display name. * **creationDate** *(datetime) --* The date the session logger resource was created. * **nextToken** *(string) --* The pagination token used to retrieve the next page of results for this operation. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / delete_network_settings delete_network_settings *********************** WorkSpacesWeb.Client.delete_network_settings(**kwargs) Deletes network settings. See also: AWS API Documentation **Request Syntax** response = client.delete_network_settings( networkSettingsArn='string' ) Parameters: **networkSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the network settings. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / update_session_logger update_session_logger ********************* WorkSpacesWeb.Client.update_session_logger(**kwargs) Updates the details of a session logger. See also: AWS API Documentation **Request Syntax** response = client.update_session_logger( sessionLoggerArn='string', eventFilter={ 'all': {} , 'include': [ 'WebsiteInteract'|'FileDownloadFromSecureBrowserToRemoteDisk'|'FileTransferFromRemoteToLocalDisk'|'FileTransferFromLocalToRemoteDisk'|'FileUploadFromRemoteDiskToSecureBrowser'|'ContentPasteToWebsite'|'ContentTransferFromLocalToRemoteClipboard'|'ContentCopyFromWebsite'|'UrlLoad'|'TabOpen'|'TabClose'|'PrintJobSubmit'|'SessionConnect'|'SessionStart'|'SessionDisconnect'|'SessionEnd', ] }, logConfiguration={ 's3': { 'bucket': 'string', 'keyPrefix': 'string', 'bucketOwner': 'string', 'logFileFormat': 'JSONLines'|'Json', 'folderStructure': 'Flat'|'NestedByDate' } }, displayName='string' ) Parameters: * **sessionLoggerArn** (*string*) -- **[REQUIRED]** The ARN of the session logger to update. * **eventFilter** (*dict*) -- The updated eventFilter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "all", "include". * **all** *(dict) --* The filter that monitors all of the available events, including any new events emitted in the future. * **include** *(list) --* The filter that monitors only the listed set of events. New events are not auto-monitored. * *(string) --* * **logConfiguration** (*dict*) -- The updated logConfiguration. * **s3** *(dict) --* The configuration for delivering the logs to S3. * **bucket** *(string) --* **[REQUIRED]** The S3 bucket name where logs are delivered. * **keyPrefix** *(string) --* The S3 path prefix that determines where log files are stored. * **bucketOwner** *(string) --* The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket. * **logFileFormat** *(string) --* **[REQUIRED]** The format of the LogFile that is written to S3. * **folderStructure** *(string) --* **[REQUIRED]** The folder structure that defines the organizational structure for log files in S3. * **displayName** (*string*) -- The updated display name. Return type: dict Returns: **Response Syntax** { 'sessionLogger': { 'sessionLoggerArn': 'string', 'eventFilter': { 'all': {}, 'include': [ 'WebsiteInteract'|'FileDownloadFromSecureBrowserToRemoteDisk'|'FileTransferFromRemoteToLocalDisk'|'FileTransferFromLocalToRemoteDisk'|'FileUploadFromRemoteDiskToSecureBrowser'|'ContentPasteToWebsite'|'ContentTransferFromLocalToRemoteClipboard'|'ContentCopyFromWebsite'|'UrlLoad'|'TabOpen'|'TabClose'|'PrintJobSubmit'|'SessionConnect'|'SessionStart'|'SessionDisconnect'|'SessionEnd', ] }, 'logConfiguration': { 's3': { 'bucket': 'string', 'keyPrefix': 'string', 'bucketOwner': 'string', 'logFileFormat': 'JSONLines'|'Json', 'folderStructure': 'Flat'|'NestedByDate' } }, 'customerManagedKey': 'string', 'additionalEncryptionContext': { 'string': 'string' }, 'associatedPortalArns': [ 'string', ], 'displayName': 'string', 'creationDate': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **sessionLogger** *(dict) --* The updated details of the session logger. * **sessionLoggerArn** *(string) --* The ARN of the session logger resource. * **eventFilter** *(dict) --* The filter that specifies which events to monitor. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "all", "include". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **all** *(dict) --* The filter that monitors all of the available events, including any new events emitted in the future. * **include** *(list) --* The filter that monitors only the listed set of events. New events are not auto-monitored. * *(string) --* * **logConfiguration** *(dict) --* The configuration that specifies where logs are fowarded. * **s3** *(dict) --* The configuration for delivering the logs to S3. * **bucket** *(string) --* The S3 bucket name where logs are delivered. * **keyPrefix** *(string) --* The S3 path prefix that determines where log files are stored. * **bucketOwner** *(string) --* The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket. * **logFileFormat** *(string) --* The format of the LogFile that is written to S3. * **folderStructure** *(string) --* The folder structure that defines the organizational structure for log files in S3. * **customerManagedKey** *(string) --* The custom managed key of the session logger. * **additionalEncryptionContext** *(dict) --* The additional encryption context of the session logger. * *(string) --* * *(string) --* * **associatedPortalArns** *(list) --* The associated portal ARN. * *(string) --* * **displayName** *(string) --* The human-readable display name. * **creationDate** *(datetime) --* The date the session logger resource was created. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / update_trust_store update_trust_store ****************** WorkSpacesWeb.Client.update_trust_store(**kwargs) Updates the trust store. See also: AWS API Documentation **Request Syntax** response = client.update_trust_store( trustStoreArn='string', certificatesToAdd=[ b'bytes', ], certificatesToDelete=[ 'string', ], clientToken='string' ) Parameters: * **trustStoreArn** (*string*) -- **[REQUIRED]** The ARN of the trust store. * **certificatesToAdd** (*list*) -- A list of CA certificates to add to the trust store. * *(bytes) --* * **certificatesToDelete** (*list*) -- A list of CA certificates to delete from a trust store. * *(string) --* * **clientToken** (*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 return 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. Return type: dict Returns: **Response Syntax** { 'trustStoreArn': 'string' } **Response Structure** * *(dict) --* * **trustStoreArn** *(string) --* The ARN of the trust store. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / disassociate_user_settings disassociate_user_settings ************************** WorkSpacesWeb.Client.disassociate_user_settings(**kwargs) Disassociates user settings from a web portal. See also: AWS API Documentation **Request Syntax** response = client.disassociate_user_settings( portalArn='string' ) Parameters: **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / delete_user_settings delete_user_settings ******************** WorkSpacesWeb.Client.delete_user_settings(**kwargs) Deletes user settings. See also: AWS API Documentation **Request Syntax** response = client.delete_user_settings( userSettingsArn='string' ) Parameters: **userSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the user settings. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / can_paginate can_paginate ************ WorkSpacesWeb.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. WorkSpacesWeb / Client / delete_browser_settings delete_browser_settings *********************** WorkSpacesWeb.Client.delete_browser_settings(**kwargs) Deletes browser settings. See also: AWS API Documentation **Request Syntax** response = client.delete_browser_settings( browserSettingsArn='string' ) Parameters: **browserSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the browser settings. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / create_identity_provider create_identity_provider ************************ WorkSpacesWeb.Client.create_identity_provider(**kwargs) Creates an identity provider resource that is then associated with a web portal. See also: AWS API Documentation **Request Syntax** response = client.create_identity_provider( portalArn='string', identityProviderName='string', identityProviderType='SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC', identityProviderDetails={ 'string': 'string' }, clientToken='string', tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. * **identityProviderName** (*string*) -- **[REQUIRED]** The identity provider name. * **identityProviderType** (*string*) -- **[REQUIRED]** The identity provider type. * **identityProviderDetails** (*dict*) -- **[REQUIRED]** The identity provider details. The following list describes the provider detail keys for each identity provider type. * For Google and Login with Amazon: * "client_id" * "client_secret" * "authorize_scopes" * For Facebook: * "client_id" * "client_secret" * "authorize_scopes" * "api_version" * For Sign in with Apple: * "client_id" * "team_id" * "key_id" * "private_key" * "authorize_scopes" * For OIDC providers: * "client_id" * "client_secret" * "attributes_request_method" * "oidc_issuer" * "authorize_scopes" * "authorize_url" if not available from discovery URL specified by "oidc_issuer" key * "token_url" if not available from discovery URL specified by "oidc_issuer" key * "attributes_url" if not available from discovery URL specified by "oidc_issuer" key * "jwks_uri" if not available from discovery URL specified by "oidc_issuer" key * For SAML providers: * "MetadataFile" OR "MetadataURL" * "IDPSignout" (boolean) *optional* * "IDPInit" (boolean) *optional* * "RequestSigningAlgorithm" (string) *optional* - Only accepts "rsa-sha256" * "EncryptedResponses" (boolean) *optional* * *(string) --* * *(string) --* * **clientToken** (*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 Amazon Web Services SDK. This field is autopopulated if not provided. * **tags** (*list*) -- The tags to add to the identity provider 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 Return type: dict Returns: **Response Syntax** { 'identityProviderArn': 'string' } **Response Structure** * *(dict) --* * **identityProviderArn** *(string) --* The ARN of the identity provider. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / update_user_settings update_user_settings ******************** WorkSpacesWeb.Client.update_user_settings(**kwargs) Updates the user settings. See also: AWS API Documentation **Request Syntax** response = client.update_user_settings( userSettingsArn='string', copyAllowed='Disabled'|'Enabled', pasteAllowed='Disabled'|'Enabled', downloadAllowed='Disabled'|'Enabled', uploadAllowed='Disabled'|'Enabled', printAllowed='Disabled'|'Enabled', disconnectTimeoutInMinutes=123, idleDisconnectTimeoutInMinutes=123, clientToken='string', cookieSynchronizationConfiguration={ 'allowlist': [ { 'domain': 'string', 'name': 'string', 'path': 'string' }, ], 'blocklist': [ { 'domain': 'string', 'name': 'string', 'path': 'string' }, ] }, deepLinkAllowed='Disabled'|'Enabled', toolbarConfiguration={ 'toolbarType': 'Floating'|'Docked', 'visualMode': 'Dark'|'Light', 'hiddenToolbarItems': [ 'Windows'|'DualMonitor'|'FullScreen'|'Webcam'|'Microphone', ], 'maxDisplayResolution': 'size4096X2160'|'size3840X2160'|'size3440X1440'|'size2560X1440'|'size1920X1080'|'size1280X720'|'size1024X768'|'size800X600' } ) Parameters: * **userSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the user settings. * **copyAllowed** (*string*) -- Specifies whether the user can copy text from the streaming session to the local device. * **pasteAllowed** (*string*) -- Specifies whether the user can paste text from the local device to the streaming session. * **downloadAllowed** (*string*) -- Specifies whether the user can download files from the streaming session to the local device. * **uploadAllowed** (*string*) -- Specifies whether the user can upload files from the local device to the streaming session. * **printAllowed** (*string*) -- Specifies whether the user can print to the local device. * **disconnectTimeoutInMinutes** (*integer*) -- The amount of time that a streaming session remains active after users disconnect. * **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. * **clientToken** (*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 return 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. * **cookieSynchronizationConfiguration** (*dict*) -- 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. * **deepLinkAllowed** (*string*) -- Specifies whether the user can use deep links that open automatically when connecting to a session. * **toolbarConfiguration** (*dict*) -- 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. * **toolbarType** *(string) --* The type of toolbar displayed during the session. * **visualMode** *(string) --* The visual mode of the toolbar. * **hiddenToolbarItems** *(list) --* The list of toolbar items to be hidden. * *(string) --* * **maxDisplayResolution** *(string) --* The maximum display resolution that is allowed for the session. Return type: dict Returns: **Response Syntax** { 'userSettings': { 'userSettingsArn': 'string', 'associatedPortalArns': [ 'string', ], 'copyAllowed': 'Disabled'|'Enabled', 'pasteAllowed': 'Disabled'|'Enabled', 'downloadAllowed': 'Disabled'|'Enabled', 'uploadAllowed': 'Disabled'|'Enabled', 'printAllowed': 'Disabled'|'Enabled', 'disconnectTimeoutInMinutes': 123, 'idleDisconnectTimeoutInMinutes': 123, 'cookieSynchronizationConfiguration': { 'allowlist': [ { 'domain': 'string', 'name': 'string', 'path': 'string' }, ], 'blocklist': [ { 'domain': 'string', 'name': 'string', 'path': 'string' }, ] }, 'customerManagedKey': 'string', 'additionalEncryptionContext': { 'string': 'string' }, 'deepLinkAllowed': 'Disabled'|'Enabled', 'toolbarConfiguration': { 'toolbarType': 'Floating'|'Docked', 'visualMode': 'Dark'|'Light', 'hiddenToolbarItems': [ 'Windows'|'DualMonitor'|'FullScreen'|'Webcam'|'Microphone', ], 'maxDisplayResolution': 'size4096X2160'|'size3840X2160'|'size3440X1440'|'size2560X1440'|'size1920X1080'|'size1280X720'|'size1024X768'|'size800X600' } } } **Response Structure** * *(dict) --* * **userSettings** *(dict) --* The user settings. * **userSettingsArn** *(string) --* The ARN of 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. * **pasteAllowed** *(string) --* Specifies whether the user can paste text from the local device to the streaming session. * **downloadAllowed** *(string) --* Specifies whether the user can download files from the streaming session to the local device. * **uploadAllowed** *(string) --* Specifies whether the user can upload files from the local device to the streaming session. * **printAllowed** *(string) --* Specifies whether the user can print to the local device. * **disconnectTimeoutInMinutes** *(integer) --* The amount of time that a streaming session remains active after users disconnect. * **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. * **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. * **customerManagedKey** *(string) --* The customer managed key used to encrypt sensitive information in the user settings. * **additionalEncryptionContext** *(dict) --* The additional encryption context of the user settings. * *(string) --* * *(string) --* * **deepLinkAllowed** *(string) --* Specifies whether the user can use deep links that open automatically when connecting to a session. * **toolbarConfiguration** *(dict) --* 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. * **toolbarType** *(string) --* The type of toolbar displayed during the session. * **visualMode** *(string) --* The visual mode of the toolbar. * **hiddenToolbarItems** *(list) --* The list of toolbar items to be hidden. * *(string) --* * **maxDisplayResolution** *(string) --* The maximum display resolution that is allowed for the session. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / get_browser_settings get_browser_settings ******************** WorkSpacesWeb.Client.get_browser_settings(**kwargs) Gets browser settings. See also: AWS API Documentation **Request Syntax** response = client.get_browser_settings( browserSettingsArn='string' ) Parameters: **browserSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the browser settings. Return type: dict Returns: **Response Syntax** { 'browserSettings': { 'browserSettingsArn': 'string', 'associatedPortalArns': [ 'string', ], 'browserPolicy': 'string', 'customerManagedKey': 'string', 'additionalEncryptionContext': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **browserSettings** *(dict) --* The browser settings. * **browserSettingsArn** *(string) --* The ARN of the browser settings. * **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. * **customerManagedKey** *(string) --* The customer managed key used to encrypt sensitive information in the browser settings. * **additionalEncryptionContext** *(dict) --* The additional encryption context of the browser settings. * *(string) --* * *(string) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / list_trust_stores list_trust_stores ***************** WorkSpacesWeb.Client.list_trust_stores(**kwargs) Retrieves a list of trust stores. See also: AWS API Documentation **Request Syntax** response = client.list_trust_stores( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The pagination token used to retrieve the next page of results for this operation. * **maxResults** (*integer*) -- The maximum number of results to be included in the next page. Return type: dict Returns: **Response Syntax** { 'trustStores': [ { 'trustStoreArn': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **trustStores** *(list) --* The trust stores. * *(dict) --* The summary of the trust store. * **trustStoreArn** *(string) --* The ARN of the trust store. * **nextToken** *(string) --* The pagination token used to retrieve the next page of results for this operation. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / list_sessions list_sessions ************* WorkSpacesWeb.Client.list_sessions(**kwargs) Lists information for multiple secure browser sessions from a specific portal. See also: AWS API Documentation **Request Syntax** response = client.list_sessions( portalId='string', username='string', sessionId='string', sortBy='StartTimeAscending'|'StartTimeDescending', status='Active'|'Terminated', maxResults=123, nextToken='string' ) Parameters: * **portalId** (*string*) -- **[REQUIRED]** The ID of the web portal for the sessions. * **username** (*string*) -- The username of the session. * **sessionId** (*string*) -- The ID of the session. * **sortBy** (*string*) -- The method in which the returned sessions should be sorted. * **status** (*string*) -- The status of the session. * **maxResults** (*integer*) -- The maximum number of results to be included in the next page. * **nextToken** (*string*) -- The pagination token used to retrieve the next page of results for this operation. Return type: dict Returns: **Response Syntax** { 'sessions': [ { 'portalArn': 'string', 'sessionId': 'string', 'username': 'string', 'status': 'Active'|'Terminated', 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **sessions** *(list) --* The sessions in a list. * *(dict) --* Summary information about a secure browser session. * **portalArn** *(string) --* The ARN of the web portal. * **sessionId** *(string) --* The ID of the session. * **username** *(string) --* The username of the session. * **status** *(string) --* The status of the session. * **startTime** *(datetime) --* The start time of the session. * **endTime** *(datetime) --* The end time of the session. * **nextToken** *(string) --* The pagination token used to retrieve the next page of results for this operation. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / associate_trust_store associate_trust_store ********************* WorkSpacesWeb.Client.associate_trust_store(**kwargs) Associates a trust store with a web portal. See also: AWS API Documentation **Request Syntax** response = client.associate_trust_store( portalArn='string', trustStoreArn='string' ) Parameters: * **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. * **trustStoreArn** (*string*) -- **[REQUIRED]** The ARN of the trust store. Return type: dict Returns: **Response Syntax** { 'portalArn': 'string', 'trustStoreArn': 'string' } **Response Structure** * *(dict) --* * **portalArn** *(string) --* The ARN of the web portal. * **trustStoreArn** *(string) --* The ARN of the trust store. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / get_trust_store get_trust_store *************** WorkSpacesWeb.Client.get_trust_store(**kwargs) Gets the trust store. See also: AWS API Documentation **Request Syntax** response = client.get_trust_store( trustStoreArn='string' ) Parameters: **trustStoreArn** (*string*) -- **[REQUIRED]** The ARN of the trust store. Return type: dict Returns: **Response Syntax** { 'trustStore': { 'associatedPortalArns': [ 'string', ], 'trustStoreArn': 'string' } } **Response Structure** * *(dict) --* * **trustStore** *(dict) --* The trust store. * **associatedPortalArns** *(list) --* A list of web portal ARNs that this trust store is associated with. * *(string) --* * **trustStoreArn** *(string) --* The ARN of the trust store. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / update_browser_settings update_browser_settings *********************** WorkSpacesWeb.Client.update_browser_settings(**kwargs) Updates browser settings. See also: AWS API Documentation **Request Syntax** response = client.update_browser_settings( browserSettingsArn='string', browserPolicy='string', clientToken='string' ) Parameters: * **browserSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the browser settings. * **browserPolicy** (*string*) -- A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions. * **clientToken** (*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 return 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. Return type: dict Returns: **Response Syntax** { 'browserSettings': { 'browserSettingsArn': 'string', 'associatedPortalArns': [ 'string', ], 'browserPolicy': 'string', 'customerManagedKey': 'string', 'additionalEncryptionContext': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **browserSettings** *(dict) --* The browser settings. * **browserSettingsArn** *(string) --* The ARN of the browser settings. * **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. * **customerManagedKey** *(string) --* The customer managed key used to encrypt sensitive information in the browser settings. * **additionalEncryptionContext** *(dict) --* The additional encryption context of the browser settings. * *(string) --* * *(string) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / create_browser_settings create_browser_settings *********************** WorkSpacesWeb.Client.create_browser_settings(**kwargs) Creates a browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal. See also: AWS API Documentation **Request Syntax** response = client.create_browser_settings( tags=[ { 'Key': 'string', 'Value': 'string' }, ], customerManagedKey='string', additionalEncryptionContext={ 'string': 'string' }, browserPolicy='string', clientToken='string' ) Parameters: * **tags** (*list*) -- The tags to add to the browser 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 * **customerManagedKey** (*string*) -- The custom managed key of the browser settings. * **additionalEncryptionContext** (*dict*) -- Additional encryption context of the browser settings. * *(string) --* * *(string) --* * **browserPolicy** (*string*) -- **[REQUIRED]** A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions. * **clientToken** (*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 Amazon Web Services SDK. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'browserSettingsArn': 'string' } **Response Structure** * *(dict) --* * **browserSettingsArn** *(string) --* The ARN of the browser settings. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / disassociate_network_settings disassociate_network_settings ***************************** WorkSpacesWeb.Client.disassociate_network_settings(**kwargs) Disassociates network settings from a web portal. See also: AWS API Documentation **Request Syntax** response = client.disassociate_network_settings( portalArn='string' ) Parameters: **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / associate_ip_access_settings associate_ip_access_settings **************************** WorkSpacesWeb.Client.associate_ip_access_settings(**kwargs) Associates an IP access settings resource with a web portal. See also: AWS API Documentation **Request Syntax** response = client.associate_ip_access_settings( portalArn='string', ipAccessSettingsArn='string' ) Parameters: * **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. * **ipAccessSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the IP access settings. Return type: dict Returns: **Response Syntax** { 'portalArn': 'string', 'ipAccessSettingsArn': 'string' } **Response Structure** * *(dict) --* * **portalArn** *(string) --* The ARN of the web portal. * **ipAccessSettingsArn** *(string) --* The ARN of the IP access settings resource. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / list_browser_settings list_browser_settings ********************* WorkSpacesWeb.Client.list_browser_settings(**kwargs) Retrieves a list of browser settings. See also: AWS API Documentation **Request Syntax** response = client.list_browser_settings( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The pagination token used to retrieve the next page of results for this operation. * **maxResults** (*integer*) -- The maximum number of results to be included in the next page. Return type: dict Returns: **Response Syntax** { 'browserSettings': [ { 'browserSettingsArn': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **browserSettings** *(list) --* The browser settings. * *(dict) --* The summary for browser settings. * **browserSettingsArn** *(string) --* The ARN of the browser settings. * **nextToken** *(string) --* The pagination token used to retrieve the next page of results for this operation. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / list_tags_for_resource list_tags_for_resource ********************** WorkSpacesWeb.Client.list_tags_for_resource(**kwargs) Retrieves a list of tags for a resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource. Return type: dict Returns: **Response Syntax** { 'tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **tags** *(list) --* The tags of the resource. * *(dict) --* The tag. * **Key** *(string) --* The key of the tag. * **Value** *(string) --* The value of the tag **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / disassociate_session_logger disassociate_session_logger *************************** WorkSpacesWeb.Client.disassociate_session_logger(**kwargs) Disassociates a session logger from a portal. See also: AWS API Documentation **Request Syntax** response = client.disassociate_session_logger( portalArn='string' ) Parameters: **portalArn** (*string*) -- **[REQUIRED]** The ARN of the portal to disassociate from the a session logger. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / get_user_settings get_user_settings ***************** WorkSpacesWeb.Client.get_user_settings(**kwargs) Gets user settings. See also: AWS API Documentation **Request Syntax** response = client.get_user_settings( userSettingsArn='string' ) Parameters: **userSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the user settings. Return type: dict Returns: **Response Syntax** { 'userSettings': { 'userSettingsArn': 'string', 'associatedPortalArns': [ 'string', ], 'copyAllowed': 'Disabled'|'Enabled', 'pasteAllowed': 'Disabled'|'Enabled', 'downloadAllowed': 'Disabled'|'Enabled', 'uploadAllowed': 'Disabled'|'Enabled', 'printAllowed': 'Disabled'|'Enabled', 'disconnectTimeoutInMinutes': 123, 'idleDisconnectTimeoutInMinutes': 123, 'cookieSynchronizationConfiguration': { 'allowlist': [ { 'domain': 'string', 'name': 'string', 'path': 'string' }, ], 'blocklist': [ { 'domain': 'string', 'name': 'string', 'path': 'string' }, ] }, 'customerManagedKey': 'string', 'additionalEncryptionContext': { 'string': 'string' }, 'deepLinkAllowed': 'Disabled'|'Enabled', 'toolbarConfiguration': { 'toolbarType': 'Floating'|'Docked', 'visualMode': 'Dark'|'Light', 'hiddenToolbarItems': [ 'Windows'|'DualMonitor'|'FullScreen'|'Webcam'|'Microphone', ], 'maxDisplayResolution': 'size4096X2160'|'size3840X2160'|'size3440X1440'|'size2560X1440'|'size1920X1080'|'size1280X720'|'size1024X768'|'size800X600' } } } **Response Structure** * *(dict) --* * **userSettings** *(dict) --* The user settings. * **userSettingsArn** *(string) --* The ARN of 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. * **pasteAllowed** *(string) --* Specifies whether the user can paste text from the local device to the streaming session. * **downloadAllowed** *(string) --* Specifies whether the user can download files from the streaming session to the local device. * **uploadAllowed** *(string) --* Specifies whether the user can upload files from the local device to the streaming session. * **printAllowed** *(string) --* Specifies whether the user can print to the local device. * **disconnectTimeoutInMinutes** *(integer) --* The amount of time that a streaming session remains active after users disconnect. * **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. * **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. * **customerManagedKey** *(string) --* The customer managed key used to encrypt sensitive information in the user settings. * **additionalEncryptionContext** *(dict) --* The additional encryption context of the user settings. * *(string) --* * *(string) --* * **deepLinkAllowed** *(string) --* Specifies whether the user can use deep links that open automatically when connecting to a session. * **toolbarConfiguration** *(dict) --* 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. * **toolbarType** *(string) --* The type of toolbar displayed during the session. * **visualMode** *(string) --* The visual mode of the toolbar. * **hiddenToolbarItems** *(list) --* The list of toolbar items to be hidden. * *(string) --* * **maxDisplayResolution** *(string) --* The maximum display resolution that is allowed for the session. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / associate_browser_settings associate_browser_settings ************************** WorkSpacesWeb.Client.associate_browser_settings(**kwargs) Associates a browser settings resource with a web portal. See also: AWS API Documentation **Request Syntax** response = client.associate_browser_settings( portalArn='string', browserSettingsArn='string' ) Parameters: * **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. * **browserSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the browser settings. Return type: dict Returns: **Response Syntax** { 'portalArn': 'string', 'browserSettingsArn': 'string' } **Response Structure** * *(dict) --* * **portalArn** *(string) --* The ARN of the web portal. * **browserSettingsArn** *(string) --* The ARN of the browser settings. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / expire_session expire_session ************** WorkSpacesWeb.Client.expire_session(**kwargs) Expires an active secure browser session. See also: AWS API Documentation **Request Syntax** response = client.expire_session( portalId='string', sessionId='string' ) Parameters: * **portalId** (*string*) -- **[REQUIRED]** The ID of the web portal for the session. * **sessionId** (*string*) -- **[REQUIRED]** The ID of the session to expire. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / list_user_settings list_user_settings ****************** WorkSpacesWeb.Client.list_user_settings(**kwargs) Retrieves a list of user settings. See also: AWS API Documentation **Request Syntax** response = client.list_user_settings( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The pagination token used to retrieve the next page of results for this operation. * **maxResults** (*integer*) -- The maximum number of results to be included in the next page. Return type: dict Returns: **Response Syntax** { 'userSettings': [ { 'userSettingsArn': 'string', 'copyAllowed': 'Disabled'|'Enabled', 'pasteAllowed': 'Disabled'|'Enabled', 'downloadAllowed': 'Disabled'|'Enabled', 'uploadAllowed': 'Disabled'|'Enabled', 'printAllowed': 'Disabled'|'Enabled', 'disconnectTimeoutInMinutes': 123, 'idleDisconnectTimeoutInMinutes': 123, 'cookieSynchronizationConfiguration': { 'allowlist': [ { 'domain': 'string', 'name': 'string', 'path': 'string' }, ], 'blocklist': [ { 'domain': 'string', 'name': 'string', 'path': 'string' }, ] }, 'deepLinkAllowed': 'Disabled'|'Enabled', 'toolbarConfiguration': { 'toolbarType': 'Floating'|'Docked', 'visualMode': 'Dark'|'Light', 'hiddenToolbarItems': [ 'Windows'|'DualMonitor'|'FullScreen'|'Webcam'|'Microphone', ], 'maxDisplayResolution': 'size4096X2160'|'size3840X2160'|'size3440X1440'|'size2560X1440'|'size1920X1080'|'size1280X720'|'size1024X768'|'size800X600' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **userSettings** *(list) --* The user settings. * *(dict) --* The summary of user settings. * **userSettingsArn** *(string) --* The ARN of the user settings. * **copyAllowed** *(string) --* Specifies whether the user can copy text from the streaming session to the local device. * **pasteAllowed** *(string) --* Specifies whether the user can paste text from the local device to the streaming session. * **downloadAllowed** *(string) --* Specifies whether the user can download files from the streaming session to the local device. * **uploadAllowed** *(string) --* Specifies whether the user can upload files from the local device to the streaming session. * **printAllowed** *(string) --* Specifies whether the user can print to the local device. * **disconnectTimeoutInMinutes** *(integer) --* The amount of time that a streaming session remains active after users disconnect. * **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. * **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. * **deepLinkAllowed** *(string) --* Specifies whether the user can use deep links that open automatically when connecting to a session. * **toolbarConfiguration** *(dict) --* 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. * **toolbarType** *(string) --* The type of toolbar displayed during the session. * **visualMode** *(string) --* The visual mode of the toolbar. * **hiddenToolbarItems** *(list) --* The list of toolbar items to be hidden. * *(string) --* * **maxDisplayResolution** *(string) --* The maximum display resolution that is allowed for the session. * **nextToken** *(string) --* The pagination token used to retrieve the next page of results for this operation. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / untag_resource untag_resource ************** WorkSpacesWeb.Client.untag_resource(**kwargs) Removes one or more tags from the specified resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource. * **tagKeys** (*list*) -- **[REQUIRED]** The list of tag keys to remove from the resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / delete_ip_access_settings delete_ip_access_settings ************************* WorkSpacesWeb.Client.delete_ip_access_settings(**kwargs) Deletes IP access settings. See also: AWS API Documentation **Request Syntax** response = client.delete_ip_access_settings( ipAccessSettingsArn='string' ) Parameters: **ipAccessSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the IP access settings. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / get_user_access_logging_settings get_user_access_logging_settings ******************************** WorkSpacesWeb.Client.get_user_access_logging_settings(**kwargs) Gets user access logging settings. See also: AWS API Documentation **Request Syntax** response = client.get_user_access_logging_settings( userAccessLoggingSettingsArn='string' ) Parameters: **userAccessLoggingSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the user access logging settings. Return type: dict Returns: **Response Syntax** { 'userAccessLoggingSettings': { 'userAccessLoggingSettingsArn': 'string', 'associatedPortalArns': [ 'string', ], 'kinesisStreamArn': 'string' } } **Response Structure** * *(dict) --* * **userAccessLoggingSettings** *(dict) --* The user access logging settings. * **userAccessLoggingSettingsArn** *(string) --* The ARN of the user access logging settings. * **associatedPortalArns** *(list) --* A list of web portal ARNs that this user access logging settings is associated with. * *(string) --* * **kinesisStreamArn** *(string) --* The ARN of the Kinesis stream. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / create_trust_store create_trust_store ****************** WorkSpacesWeb.Client.create_trust_store(**kwargs) Creates a trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store. See also: AWS API Documentation **Request Syntax** response = client.create_trust_store( certificateList=[ b'bytes', ], tags=[ { 'Key': 'string', 'Value': 'string' }, ], clientToken='string' ) Parameters: * **certificateList** (*list*) -- **[REQUIRED]** A list of CA certificates to be added to the trust store. * *(bytes) --* * **tags** (*list*) -- The tags to add to the trust store. 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 * **clientToken** (*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 Amazon Web Services SDK. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'trustStoreArn': 'string' } **Response Structure** * *(dict) --* * **trustStoreArn** *(string) --* The ARN of the trust store. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / associate_network_settings associate_network_settings ************************** WorkSpacesWeb.Client.associate_network_settings(**kwargs) Associates a network settings resource with a web portal. See also: AWS API Documentation **Request Syntax** response = client.associate_network_settings( portalArn='string', networkSettingsArn='string' ) Parameters: * **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. * **networkSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the network settings. Return type: dict Returns: **Response Syntax** { 'portalArn': 'string', 'networkSettingsArn': 'string' } **Response Structure** * *(dict) --* * **portalArn** *(string) --* The ARN of the web portal. * **networkSettingsArn** *(string) --* The ARN of the network settings. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / update_identity_provider update_identity_provider ************************ WorkSpacesWeb.Client.update_identity_provider(**kwargs) Updates the identity provider. See also: AWS API Documentation **Request Syntax** response = client.update_identity_provider( identityProviderArn='string', identityProviderName='string', identityProviderType='SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC', identityProviderDetails={ 'string': 'string' }, clientToken='string' ) Parameters: * **identityProviderArn** (*string*) -- **[REQUIRED]** The ARN of the identity provider. * **identityProviderName** (*string*) -- The name of the identity provider. * **identityProviderType** (*string*) -- The type of the identity provider. * **identityProviderDetails** (*dict*) -- The details of the identity provider. The following list describes the provider detail keys for each identity provider type. * For Google and Login with Amazon: * "client_id" * "client_secret" * "authorize_scopes" * For Facebook: * "client_id" * "client_secret" * "authorize_scopes" * "api_version" * For Sign in with Apple: * "client_id" * "team_id" * "key_id" * "private_key" * "authorize_scopes" * For OIDC providers: * "client_id" * "client_secret" * "attributes_request_method" * "oidc_issuer" * "authorize_scopes" * "authorize_url" if not available from discovery URL specified by "oidc_issuer" key * "token_url" if not available from discovery URL specified by "oidc_issuer" key * "attributes_url" if not available from discovery URL specified by "oidc_issuer" key * "jwks_uri" if not available from discovery URL specified by "oidc_issuer" key * For SAML providers: * "MetadataFile" OR "MetadataURL" * "IDPSignout" (boolean) *optional* * "IDPInit" (boolean) *optional* * "RequestSigningAlgorithm" (string) *optional* - Only accepts "rsa-sha256" * "EncryptedResponses" (boolean) *optional* * *(string) --* * *(string) --* * **clientToken** (*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 return 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. Return type: dict Returns: **Response Syntax** { 'identityProvider': { 'identityProviderArn': 'string', 'identityProviderName': 'string', 'identityProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC', 'identityProviderDetails': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **identityProvider** *(dict) --* The identity provider. * **identityProviderArn** *(string) --* The ARN of the identity provider. * **identityProviderName** *(string) --* The identity provider name. * **identityProviderType** *(string) --* The identity provider type. * **identityProviderDetails** *(dict) --* The identity provider details. The following list describes the provider detail keys for each identity provider type. * For Google and Login with Amazon: * "client_id" * "client_secret" * "authorize_scopes" * For Facebook: * "client_id" * "client_secret" * "authorize_scopes" * "api_version" * For Sign in with Apple: * "client_id" * "team_id" * "key_id" * "private_key" * "authorize_scopes" * For OIDC providers: * "client_id" * "client_secret" * "attributes_request_method" * "oidc_issuer" * "authorize_scopes" * "authorize_url" *if not available from discovery URL specified by oidc_issuer key* * "token_url" *if not available from discovery URL specified by oidc_issuer key* * "attributes_url" *if not available from discovery URL specified by oidc_issuer key* * "jwks_uri" *if not available from discovery URL specified by oidc_issuer key* * For SAML providers: * "MetadataFile" OR "MetadataURL" * "IDPSignout" (boolean) *optional* * "IDPInit" (boolean) *optional* * "RequestSigningAlgorithm" (string) *optional* - Only accepts "rsa-sha256" * "EncryptedResponses" (boolean) *optional* * *(string) --* * *(string) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / delete_data_protection_settings delete_data_protection_settings ******************************* WorkSpacesWeb.Client.delete_data_protection_settings(**kwargs) Deletes data protection settings. See also: AWS API Documentation **Request Syntax** response = client.delete_data_protection_settings( dataProtectionSettingsArn='string' ) Parameters: **dataProtectionSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the data protection settings. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / delete_trust_store delete_trust_store ****************** WorkSpacesWeb.Client.delete_trust_store(**kwargs) Deletes the trust store. See also: AWS API Documentation **Request Syntax** response = client.delete_trust_store( trustStoreArn='string' ) Parameters: **trustStoreArn** (*string*) -- **[REQUIRED]** The ARN of the trust store. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / associate_data_protection_settings associate_data_protection_settings ********************************** WorkSpacesWeb.Client.associate_data_protection_settings(**kwargs) Associates a data protection settings resource with a web portal. See also: AWS API Documentation **Request Syntax** response = client.associate_data_protection_settings( portalArn='string', dataProtectionSettingsArn='string' ) Parameters: * **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. * **dataProtectionSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the data protection settings. Return type: dict Returns: **Response Syntax** { 'portalArn': 'string', 'dataProtectionSettingsArn': 'string' } **Response Structure** * *(dict) --* * **portalArn** *(string) --* The ARN of the web portal. * **dataProtectionSettingsArn** *(string) --* The ARN of the data protection settings resource. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / list_network_settings list_network_settings ********************* WorkSpacesWeb.Client.list_network_settings(**kwargs) Retrieves a list of network settings. See also: AWS API Documentation **Request Syntax** response = client.list_network_settings( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The pagination token used to retrieve the next page of results for this operation. * **maxResults** (*integer*) -- The maximum number of results to be included in the next page. Return type: dict Returns: **Response Syntax** { 'networkSettings': [ { 'networkSettingsArn': 'string', 'vpcId': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **networkSettings** *(list) --* The network settings. * *(dict) --* The summary of network settings. * **networkSettingsArn** *(string) --* The ARN of the network settings. * **vpcId** *(string) --* The VPC ID of the network settings. * **nextToken** *(string) --* The pagination token used to retrieve the next page of results for this operation. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / get_trust_store_certificate get_trust_store_certificate *************************** WorkSpacesWeb.Client.get_trust_store_certificate(**kwargs) Gets the trust store certificate. See also: AWS API Documentation **Request Syntax** response = client.get_trust_store_certificate( trustStoreArn='string', thumbprint='string' ) Parameters: * **trustStoreArn** (*string*) -- **[REQUIRED]** The ARN of the trust store certificate. * **thumbprint** (*string*) -- **[REQUIRED]** The thumbprint of the trust store certificate. Return type: dict Returns: **Response Syntax** { 'trustStoreArn': 'string', 'certificate': { 'thumbprint': 'string', 'subject': 'string', 'issuer': 'string', 'notValidBefore': datetime(2015, 1, 1), 'notValidAfter': datetime(2015, 1, 1), 'body': b'bytes' } } **Response Structure** * *(dict) --* * **trustStoreArn** *(string) --* The ARN of the trust store certificate. * **certificate** *(dict) --* The certificate of the trust store certificate. * **thumbprint** *(string) --* A hexadecimal identifier for the certificate. * **subject** *(string) --* The entity the certificate belongs to. * **issuer** *(string) --* The entity that issued the certificate. * **notValidBefore** *(datetime) --* The certificate is not valid before this date. * **notValidAfter** *(datetime) --* The certificate is not valid after this date. * **body** *(bytes) --* The body of the certificate. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / get_waiter get_waiter ********** WorkSpacesWeb.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" WorkSpacesWeb / Client / list_user_access_logging_settings list_user_access_logging_settings ********************************* WorkSpacesWeb.Client.list_user_access_logging_settings(**kwargs) Retrieves a list of user access logging settings. See also: AWS API Documentation **Request Syntax** response = client.list_user_access_logging_settings( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The pagination token used to retrieve the next page of results for this operation. * **maxResults** (*integer*) -- The maximum number of results to be included in the next page. Return type: dict Returns: **Response Syntax** { 'userAccessLoggingSettings': [ { 'userAccessLoggingSettingsArn': 'string', 'kinesisStreamArn': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **userAccessLoggingSettings** *(list) --* The user access logging settings. * *(dict) --* The summary of user access logging settings. * **userAccessLoggingSettingsArn** *(string) --* The ARN of the user access logging settings. * **kinesisStreamArn** *(string) --* The ARN of the Kinesis stream. * **nextToken** *(string) --* The pagination token used to retrieve the next page of results for this operation. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / update_data_protection_settings update_data_protection_settings ******************************* WorkSpacesWeb.Client.update_data_protection_settings(**kwargs) Updates data protection settings. See also: AWS API Documentation **Request Syntax** response = client.update_data_protection_settings( dataProtectionSettingsArn='string', inlineRedactionConfiguration={ 'inlineRedactionPatterns': [ { 'builtInPatternId': 'string', 'customPattern': { 'patternName': 'string', 'patternRegex': 'string', 'patternDescription': 'string', 'keywordRegex': 'string' }, 'redactionPlaceHolder': { 'redactionPlaceHolderType': 'CustomText', 'redactionPlaceHolderText': 'string' }, 'enforcedUrls': [ 'string', ], 'exemptUrls': [ 'string', ], 'confidenceLevel': 123 }, ], 'globalEnforcedUrls': [ 'string', ], 'globalExemptUrls': [ 'string', ], 'globalConfidenceLevel': 123 }, displayName='string', description='string', clientToken='string' ) Parameters: * **dataProtectionSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the data protection settings. * **inlineRedactionConfiguration** (*dict*) -- The inline redaction configuration of the data protection settings that will be applied to all sessions. * **inlineRedactionPatterns** *(list) --* **[REQUIRED]** The inline redaction patterns to be enabled for the inline redaction configuration. * *(dict) --* The set of patterns that determine the data types redacted in session. * **builtInPatternId** *(string) --* The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required. * **customPattern** *(dict) --* >The configuration for a custom pattern. Either a customPattern or builtInPatternId is required. * **patternName** *(string) --* **[REQUIRED]** The pattern name for the custom pattern. * **patternRegex** *(string) --* **[REQUIRED]** The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”. * **patternDescription** *(string) --* The pattern description for the customer pattern. * **keywordRegex** *(string) --* The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi” * **redactionPlaceHolder** *(dict) --* **[REQUIRED]** The redaction placeholder that will replace the redacted text in session for the inline redaction pattern. * **redactionPlaceHolderType** *(string) --* **[REQUIRED]** The redaction placeholder type that will replace the redacted text in session. * **redactionPlaceHolderText** *(string) --* The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type. * **enforcedUrls** *(list) --* The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration. * *(string) --* * **exemptUrls** *(list) --* The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern. * *(string) --* * **confidenceLevel** *(integer) --* The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level. * **globalEnforcedUrls** *(list) --* The global enforced URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level enforced URL list. * *(string) --* * **globalExemptUrls** *(list) --* The global exempt URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level exempt URL list. * *(string) --* * **globalConfidenceLevel** *(integer) --* The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This is applied to patterns that do not have a pattern-level confidence level. Defaults to confidence level 2. * **displayName** (*string*) -- The display name of the data protection settings. * **description** (*string*) -- The description of the data protection settings. * **clientToken** (*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 return 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. Return type: dict Returns: **Response Syntax** { 'dataProtectionSettings': { 'dataProtectionSettingsArn': 'string', 'inlineRedactionConfiguration': { 'inlineRedactionPatterns': [ { 'builtInPatternId': 'string', 'customPattern': { 'patternName': 'string', 'patternRegex': 'string', 'patternDescription': 'string', 'keywordRegex': 'string' }, 'redactionPlaceHolder': { 'redactionPlaceHolderType': 'CustomText', 'redactionPlaceHolderText': 'string' }, 'enforcedUrls': [ 'string', ], 'exemptUrls': [ 'string', ], 'confidenceLevel': 123 }, ], 'globalEnforcedUrls': [ 'string', ], 'globalExemptUrls': [ 'string', ], 'globalConfidenceLevel': 123 }, 'associatedPortalArns': [ 'string', ], 'displayName': 'string', 'description': 'string', 'creationDate': datetime(2015, 1, 1), 'customerManagedKey': 'string', 'additionalEncryptionContext': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **dataProtectionSettings** *(dict) --* The data protection settings. * **dataProtectionSettingsArn** *(string) --* The ARN of the data protection settings resource. * **inlineRedactionConfiguration** *(dict) --* The inline redaction configuration for the data protection settings. * **inlineRedactionPatterns** *(list) --* The inline redaction patterns to be enabled for the inline redaction configuration. * *(dict) --* The set of patterns that determine the data types redacted in session. * **builtInPatternId** *(string) --* The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required. * **customPattern** *(dict) --* >The configuration for a custom pattern. Either a customPattern or builtInPatternId is required. * **patternName** *(string) --* The pattern name for the custom pattern. * **patternRegex** *(string) --* The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”. * **patternDescription** *(string) --* The pattern description for the customer pattern. * **keywordRegex** *(string) --* The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi” * **redactionPlaceHolder** *(dict) --* The redaction placeholder that will replace the redacted text in session for the inline redaction pattern. * **redactionPlaceHolderType** *(string) --* The redaction placeholder type that will replace the redacted text in session. * **redactionPlaceHolderText** *(string) --* The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type. * **enforcedUrls** *(list) --* The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration. * *(string) --* * **exemptUrls** *(list) --* The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern. * *(string) --* * **confidenceLevel** *(integer) --* The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level. * **globalEnforcedUrls** *(list) --* The global enforced URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level enforced URL list. * *(string) --* * **globalExemptUrls** *(list) --* The global exempt URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level exempt URL list. * *(string) --* * **globalConfidenceLevel** *(integer) --* The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This is applied to patterns that do not have a pattern-level confidence level. Defaults to confidence level 2. * **associatedPortalArns** *(list) --* A list of web portal ARNs that this data protection settings resource is associated with. * *(string) --* * **displayName** *(string) --* The display name of the data protection settings. * **description** *(string) --* The description of the data protection settings. * **creationDate** *(datetime) --* The creation date timestamp of the data protection settings. * **customerManagedKey** *(string) --* The customer managed key used to encrypt sensitive information in the data protection settings. * **additionalEncryptionContext** *(dict) --* The additional encryption context of the data protection settings. * *(string) --* * *(string) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / associate_user_settings associate_user_settings *********************** WorkSpacesWeb.Client.associate_user_settings(**kwargs) Associates a user settings resource with a web portal. See also: AWS API Documentation **Request Syntax** response = client.associate_user_settings( portalArn='string', userSettingsArn='string' ) Parameters: * **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. * **userSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the user settings. Return type: dict Returns: **Response Syntax** { 'portalArn': 'string', 'userSettingsArn': 'string' } **Response Structure** * *(dict) --* * **portalArn** *(string) --* The ARN of the web portal. * **userSettingsArn** *(string) --* The ARN of the user settings. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / disassociate_browser_settings disassociate_browser_settings ***************************** WorkSpacesWeb.Client.disassociate_browser_settings(**kwargs) Disassociates browser settings from a web portal. See also: AWS API Documentation **Request Syntax** response = client.disassociate_browser_settings( portalArn='string' ) Parameters: **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / update_ip_access_settings update_ip_access_settings ************************* WorkSpacesWeb.Client.update_ip_access_settings(**kwargs) Updates IP access settings. See also: AWS API Documentation **Request Syntax** response = client.update_ip_access_settings( ipAccessSettingsArn='string', displayName='string', description='string', ipRules=[ { 'ipRange': 'string', 'description': 'string' }, ], clientToken='string' ) Parameters: * **ipAccessSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the IP access settings. * **displayName** (*string*) -- The display name of the IP access settings. * **description** (*string*) -- The description of the IP access settings. * **ipRules** (*list*) -- The updated IP rules of the IP access settings. * *(dict) --* The IP rules of the IP access settings. * **ipRange** *(string) --* **[REQUIRED]** The IP range of the IP rule. * **description** *(string) --* The description of the IP rule. * **clientToken** (*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 return 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. Return type: dict Returns: **Response Syntax** { 'ipAccessSettings': { 'ipAccessSettingsArn': 'string', 'associatedPortalArns': [ 'string', ], 'ipRules': [ { 'ipRange': 'string', 'description': 'string' }, ], 'displayName': 'string', 'description': 'string', 'creationDate': datetime(2015, 1, 1), 'customerManagedKey': 'string', 'additionalEncryptionContext': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **ipAccessSettings** *(dict) --* The IP access settings. * **ipAccessSettingsArn** *(string) --* The ARN of the IP access settings resource. * **associatedPortalArns** *(list) --* A list of web portal ARNs that this IP access settings resource is associated with. * *(string) --* * **ipRules** *(list) --* The IP rules of the IP access settings. * *(dict) --* The IP rules of the IP access settings. * **ipRange** *(string) --* The IP range of the IP rule. * **description** *(string) --* The description of the IP rule. * **displayName** *(string) --* The display name of the IP access settings. * **description** *(string) --* The description of the IP access settings. * **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. * **additionalEncryptionContext** *(dict) --* The additional encryption context of the IP access settings. * *(string) --* * *(string) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / disassociate_trust_store disassociate_trust_store ************************ WorkSpacesWeb.Client.disassociate_trust_store(**kwargs) Disassociates a trust store from a web portal. See also: AWS API Documentation **Request Syntax** response = client.disassociate_trust_store( portalArn='string' ) Parameters: **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / get_session_logger get_session_logger ****************** WorkSpacesWeb.Client.get_session_logger(**kwargs) Gets details about a specific session logger resource. See also: AWS API Documentation **Request Syntax** response = client.get_session_logger( sessionLoggerArn='string' ) Parameters: **sessionLoggerArn** (*string*) -- **[REQUIRED]** The ARN of the session logger. Return type: dict Returns: **Response Syntax** { 'sessionLogger': { 'sessionLoggerArn': 'string', 'eventFilter': { 'all': {}, 'include': [ 'WebsiteInteract'|'FileDownloadFromSecureBrowserToRemoteDisk'|'FileTransferFromRemoteToLocalDisk'|'FileTransferFromLocalToRemoteDisk'|'FileUploadFromRemoteDiskToSecureBrowser'|'ContentPasteToWebsite'|'ContentTransferFromLocalToRemoteClipboard'|'ContentCopyFromWebsite'|'UrlLoad'|'TabOpen'|'TabClose'|'PrintJobSubmit'|'SessionConnect'|'SessionStart'|'SessionDisconnect'|'SessionEnd', ] }, 'logConfiguration': { 's3': { 'bucket': 'string', 'keyPrefix': 'string', 'bucketOwner': 'string', 'logFileFormat': 'JSONLines'|'Json', 'folderStructure': 'Flat'|'NestedByDate' } }, 'customerManagedKey': 'string', 'additionalEncryptionContext': { 'string': 'string' }, 'associatedPortalArns': [ 'string', ], 'displayName': 'string', 'creationDate': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **sessionLogger** *(dict) --* The session logger details. * **sessionLoggerArn** *(string) --* The ARN of the session logger resource. * **eventFilter** *(dict) --* The filter that specifies which events to monitor. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "all", "include". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **all** *(dict) --* The filter that monitors all of the available events, including any new events emitted in the future. * **include** *(list) --* The filter that monitors only the listed set of events. New events are not auto-monitored. * *(string) --* * **logConfiguration** *(dict) --* The configuration that specifies where logs are fowarded. * **s3** *(dict) --* The configuration for delivering the logs to S3. * **bucket** *(string) --* The S3 bucket name where logs are delivered. * **keyPrefix** *(string) --* The S3 path prefix that determines where log files are stored. * **bucketOwner** *(string) --* The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket. * **logFileFormat** *(string) --* The format of the LogFile that is written to S3. * **folderStructure** *(string) --* The folder structure that defines the organizational structure for log files in S3. * **customerManagedKey** *(string) --* The custom managed key of the session logger. * **additionalEncryptionContext** *(dict) --* The additional encryption context of the session logger. * *(string) --* * *(string) --* * **associatedPortalArns** *(list) --* The associated portal ARN. * *(string) --* * **displayName** *(string) --* The human-readable display name. * **creationDate** *(datetime) --* The date the session logger resource was created. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / update_network_settings update_network_settings *********************** WorkSpacesWeb.Client.update_network_settings(**kwargs) Updates network settings. See also: AWS API Documentation **Request Syntax** response = client.update_network_settings( networkSettingsArn='string', vpcId='string', subnetIds=[ 'string', ], securityGroupIds=[ 'string', ], clientToken='string' ) Parameters: * **networkSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the network settings. * **vpcId** (*string*) -- The VPC that streaming instances will connect to. * **subnetIds** (*list*) -- The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones. * *(string) --* * **securityGroupIds** (*list*) -- One or more security groups used to control access from streaming instances to your VPC. * *(string) --* * **clientToken** (*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 return 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. Return type: dict Returns: **Response Syntax** { 'networkSettings': { 'networkSettingsArn': 'string', 'associatedPortalArns': [ 'string', ], 'vpcId': 'string', 'subnetIds': [ 'string', ], 'securityGroupIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **networkSettings** *(dict) --* The network settings. * **networkSettingsArn** *(string) --* The ARN of the network settings. * **associatedPortalArns** *(list) --* A list of web portal ARNs that this network settings is associated with. * *(string) --* * **vpcId** *(string) --* The VPC that streaming instances will connect to. * **subnetIds** *(list) --* The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones. * *(string) --* * **securityGroupIds** *(list) --* One or more security groups used to control access from streaming instances to your VPC. * *(string) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / create_network_settings create_network_settings *********************** WorkSpacesWeb.Client.create_network_settings(**kwargs) Creates a network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC. See also: AWS API Documentation **Request Syntax** response = client.create_network_settings( vpcId='string', subnetIds=[ 'string', ], securityGroupIds=[ 'string', ], tags=[ { 'Key': 'string', 'Value': 'string' }, ], clientToken='string' ) Parameters: * **vpcId** (*string*) -- **[REQUIRED]** The VPC that streaming instances will connect to. * **subnetIds** (*list*) -- **[REQUIRED]** The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones. * *(string) --* * **securityGroupIds** (*list*) -- **[REQUIRED]** One or more security groups used to control access from streaming instances to your VPC. * *(string) --* * **tags** (*list*) -- The tags to add to the network 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 * **clientToken** (*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 Amazon Web Services SDK. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'networkSettingsArn': 'string' } **Response Structure** * *(dict) --* * **networkSettingsArn** *(string) --* The ARN of the network settings. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / associate_session_logger associate_session_logger ************************ WorkSpacesWeb.Client.associate_session_logger(**kwargs) Associates a session logger with a portal. See also: AWS API Documentation **Request Syntax** response = client.associate_session_logger( portalArn='string', sessionLoggerArn='string' ) Parameters: * **portalArn** (*string*) -- **[REQUIRED]** The ARN of the portal to associate to the session logger ARN. * **sessionLoggerArn** (*string*) -- **[REQUIRED]** The ARN of the session logger to associate to the portal ARN. Return type: dict Returns: **Response Syntax** { 'portalArn': 'string', 'sessionLoggerArn': 'string' } **Response Structure** * *(dict) --* * **portalArn** *(string) --* The ARN of the portal. * **sessionLoggerArn** *(string) --* The ARN of the session logger. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / get_portal get_portal ********** WorkSpacesWeb.Client.get_portal(**kwargs) Gets the web portal. See also: AWS API Documentation **Request Syntax** response = client.get_portal( portalArn='string' ) Parameters: **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. Return type: dict Returns: **Response Syntax** { 'portal': { 'portalArn': 'string', 'rendererType': 'AppStream', 'browserType': 'Chrome', 'portalStatus': 'Incomplete'|'Pending'|'Active', 'portalEndpoint': 'string', 'displayName': 'string', 'creationDate': datetime(2015, 1, 1), 'browserSettingsArn': 'string', 'dataProtectionSettingsArn': 'string', 'userSettingsArn': 'string', 'networkSettingsArn': 'string', 'sessionLoggerArn': 'string', 'trustStoreArn': 'string', 'statusReason': 'string', 'userAccessLoggingSettingsArn': 'string', 'authenticationType': 'Standard'|'IAM_Identity_Center', 'ipAccessSettingsArn': 'string', 'customerManagedKey': 'string', 'additionalEncryptionContext': { 'string': 'string' }, 'instanceType': 'standard.regular'|'standard.large'|'standard.xlarge', 'maxConcurrentSessions': 123 } } **Response Structure** * *(dict) --* * **portal** *(dict) --* The web portal. * **portalArn** *(string) --* The ARN of the web portal. * **rendererType** *(string) --* The renderer that is used in streaming sessions. * **browserType** *(string) --* The browser that users see when using a streaming session. * **portalStatus** *(string) --* The status of the web portal. * **portalEndpoint** *(string) --* The endpoint URL of the web portal that users access in order to start streaming sessions. * **displayName** *(string) --* The name of the web portal. * **creationDate** *(datetime) --* The creation date of the web portal. * **browserSettingsArn** *(string) --* The ARN of the browser settings that is associated with this web portal. * **dataProtectionSettingsArn** *(string) --* The ARN of the data protection settings. * **userSettingsArn** *(string) --* The ARN of the user settings that is associated with the web portal. * **networkSettingsArn** *(string) --* The ARN of the network settings that is associated with the web portal. * **sessionLoggerArn** *(string) --* The ARN of the session logger that is assocaited with the portal. * **trustStoreArn** *(string) --* The ARN of the trust store that is associated with the web portal. * **statusReason** *(string) --* A message that explains why the web portal is in its current status. * **userAccessLoggingSettingsArn** *(string) --* The ARN of the user access logging settings that is associated with the web 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. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center. * **ipAccessSettingsArn** *(string) --* The ARN of the IP access settings. * **customerManagedKey** *(string) --* The customer managed key used to encrypt sensitive information in the portal. * **additionalEncryptionContext** *(dict) --* The additional encryption context of the portal. * *(string) --* * *(string) --* * **instanceType** *(string) --* The type and resources of the underlying instance. * **maxConcurrentSessions** *(integer) --* The maximum number of concurrent sessions for the portal. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / delete_session_logger delete_session_logger ********************* WorkSpacesWeb.Client.delete_session_logger(**kwargs) Deletes a session logger resource. See also: AWS API Documentation **Request Syntax** response = client.delete_session_logger( sessionLoggerArn='string' ) Parameters: **sessionLoggerArn** (*string*) -- **[REQUIRED]** The ARN of the session logger. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / list_portals list_portals ************ WorkSpacesWeb.Client.list_portals(**kwargs) Retrieves a list or web portals. See also: AWS API Documentation **Request Syntax** response = client.list_portals( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The pagination token used to retrieve the next page of results for this operation. * **maxResults** (*integer*) -- The maximum number of results to be included in the next page. Return type: dict Returns: **Response Syntax** { 'portals': [ { 'portalArn': 'string', 'rendererType': 'AppStream', 'browserType': 'Chrome', 'portalStatus': 'Incomplete'|'Pending'|'Active', 'portalEndpoint': 'string', 'displayName': 'string', 'creationDate': datetime(2015, 1, 1), 'browserSettingsArn': 'string', 'dataProtectionSettingsArn': 'string', 'userSettingsArn': 'string', 'networkSettingsArn': 'string', 'sessionLoggerArn': 'string', 'trustStoreArn': 'string', 'userAccessLoggingSettingsArn': 'string', 'authenticationType': 'Standard'|'IAM_Identity_Center', 'ipAccessSettingsArn': 'string', 'instanceType': 'standard.regular'|'standard.large'|'standard.xlarge', 'maxConcurrentSessions': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **portals** *(list) --* The portals in the list. * *(dict) --* The summary of the portal. * **portalArn** *(string) --* The ARN of the web portal. * **rendererType** *(string) --* The renderer that is used in streaming sessions. * **browserType** *(string) --* The browser type of the web portal. * **portalStatus** *(string) --* The status of the web portal. * **portalEndpoint** *(string) --* The endpoint URL of the web portal that users access in order to start streaming sessions. * **displayName** *(string) --* The name of the web portal. * **creationDate** *(datetime) --* The creation date of the web portal. * **browserSettingsArn** *(string) --* The ARN of the browser settings that is associated with the web portal. * **dataProtectionSettingsArn** *(string) --* The ARN of the data protection settings. * **userSettingsArn** *(string) --* The ARN of the user settings that is associated with the web portal. * **networkSettingsArn** *(string) --* The ARN of the network settings that is associated with the web portal. * **sessionLoggerArn** *(string) --* The ARN of the session logger that is assocaited with the portal. * **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. * **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. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center. * **ipAccessSettingsArn** *(string) --* The ARN of the IP access settings. * **instanceType** *(string) --* The type and resources of the underlying instance. * **maxConcurrentSessions** *(integer) --* The maximum number of concurrent sessions for the portal. * **nextToken** *(string) --* The pagination token used to retrieve the next page of results for this operation. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / create_session_logger create_session_logger ********************* WorkSpacesWeb.Client.create_session_logger(**kwargs) Creates a session logger. See also: AWS API Documentation **Request Syntax** response = client.create_session_logger( eventFilter={ 'all': {} , 'include': [ 'WebsiteInteract'|'FileDownloadFromSecureBrowserToRemoteDisk'|'FileTransferFromRemoteToLocalDisk'|'FileTransferFromLocalToRemoteDisk'|'FileUploadFromRemoteDiskToSecureBrowser'|'ContentPasteToWebsite'|'ContentTransferFromLocalToRemoteClipboard'|'ContentCopyFromWebsite'|'UrlLoad'|'TabOpen'|'TabClose'|'PrintJobSubmit'|'SessionConnect'|'SessionStart'|'SessionDisconnect'|'SessionEnd', ] }, logConfiguration={ 's3': { 'bucket': 'string', 'keyPrefix': 'string', 'bucketOwner': 'string', 'logFileFormat': 'JSONLines'|'Json', 'folderStructure': 'Flat'|'NestedByDate' } }, displayName='string', customerManagedKey='string', additionalEncryptionContext={ 'string': 'string' }, tags=[ { 'Key': 'string', 'Value': 'string' }, ], clientToken='string' ) Parameters: * **eventFilter** (*dict*) -- **[REQUIRED]** The filter that specifies the events to monitor. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "all", "include". * **all** *(dict) --* The filter that monitors all of the available events, including any new events emitted in the future. * **include** *(list) --* The filter that monitors only the listed set of events. New events are not auto-monitored. * *(string) --* * **logConfiguration** (*dict*) -- **[REQUIRED]** The configuration that specifies where logs are delivered. * **s3** *(dict) --* The configuration for delivering the logs to S3. * **bucket** *(string) --* **[REQUIRED]** The S3 bucket name where logs are delivered. * **keyPrefix** *(string) --* The S3 path prefix that determines where log files are stored. * **bucketOwner** *(string) --* The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket. * **logFileFormat** *(string) --* **[REQUIRED]** The format of the LogFile that is written to S3. * **folderStructure** *(string) --* **[REQUIRED]** The folder structure that defines the organizational structure for log files in S3. * **displayName** (*string*) -- The human-readable display name for the session logger resource. * **customerManagedKey** (*string*) -- The custom managed key of the session logger. * **additionalEncryptionContext** (*dict*) -- The additional encryption context of the session logger. * *(string) --* * *(string) --* * **tags** (*list*) -- The tags to add to the session logger. * *(dict) --* The tag. * **Key** *(string) --* **[REQUIRED]** The key of the tag. * **Value** *(string) --* **[REQUIRED]** The value of the tag * **clientToken** (*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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'sessionLoggerArn': 'string' } **Response Structure** * *(dict) --* * **sessionLoggerArn** *(string) --* The ARN of the session logger. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / disassociate_user_access_logging_settings disassociate_user_access_logging_settings ***************************************** WorkSpacesWeb.Client.disassociate_user_access_logging_settings(**kwargs) Disassociates user access logging settings from a web portal. See also: AWS API Documentation **Request Syntax** response = client.disassociate_user_access_logging_settings( portalArn='string' ) Parameters: **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / disassociate_data_protection_settings disassociate_data_protection_settings ************************************* WorkSpacesWeb.Client.disassociate_data_protection_settings(**kwargs) Disassociates data protection settings from a web portal. See also: AWS API Documentation **Request Syntax** response = client.disassociate_data_protection_settings( portalArn='string' ) Parameters: **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / get_session get_session *********** WorkSpacesWeb.Client.get_session(**kwargs) Gets information for a secure browser session. See also: AWS API Documentation **Request Syntax** response = client.get_session( portalId='string', sessionId='string' ) Parameters: * **portalId** (*string*) -- **[REQUIRED]** The ID of the web portal for the session. * **sessionId** (*string*) -- **[REQUIRED]** The ID of the session. Return type: dict Returns: **Response Syntax** { 'session': { 'portalArn': 'string', 'sessionId': 'string', 'username': 'string', 'clientIpAddresses': [ 'string', ], 'status': 'Active'|'Terminated', 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **session** *(dict) --* The sessions in a list. * **portalArn** *(string) --* The ARN of the web portal. * **sessionId** *(string) --* The ID of the session. * **username** *(string) --* The username of the session. * **clientIpAddresses** *(list) --* The IP address of the client. * *(string) --* * **status** *(string) --* The status of the session. * **startTime** *(datetime) --* The start time of the session. * **endTime** *(datetime) --* The end time of the session. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / get_portal_service_provider_metadata get_portal_service_provider_metadata ************************************ WorkSpacesWeb.Client.get_portal_service_provider_metadata(**kwargs) Gets the service provider metadata. See also: AWS API Documentation **Request Syntax** response = client.get_portal_service_provider_metadata( portalArn='string' ) Parameters: **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. Return type: dict Returns: **Response Syntax** { 'portalArn': 'string', 'serviceProviderSamlMetadata': 'string' } **Response Structure** * *(dict) --* * **portalArn** *(string) --* The ARN of the web portal. * **serviceProviderSamlMetadata** *(string) --* The service provider SAML metadata. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / list_identity_providers list_identity_providers *********************** WorkSpacesWeb.Client.list_identity_providers(**kwargs) Retrieves a list of identity providers for a specific web portal. See also: AWS API Documentation **Request Syntax** response = client.list_identity_providers( nextToken='string', maxResults=123, portalArn='string' ) Parameters: * **nextToken** (*string*) -- The pagination token used to retrieve the next page of results for this operation. * **maxResults** (*integer*) -- The maximum number of results to be included in the next page. * **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'identityProviders': [ { 'identityProviderArn': 'string', 'identityProviderName': 'string', 'identityProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The pagination token used to retrieve the next page of results for this operation. * **identityProviders** *(list) --* The identity providers. * *(dict) --* The summary of the identity provider. * **identityProviderArn** *(string) --* The ARN of the identity provider. * **identityProviderName** *(string) --* The identity provider name. * **identityProviderType** *(string) --* The identity provider type. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / close close ***** WorkSpacesWeb.Client.close() Closes underlying endpoint connections. WorkSpacesWeb / Client / associate_user_access_logging_settings associate_user_access_logging_settings ************************************** WorkSpacesWeb.Client.associate_user_access_logging_settings(**kwargs) Associates a user access logging settings resource with a web portal. See also: AWS API Documentation **Request Syntax** response = client.associate_user_access_logging_settings( portalArn='string', userAccessLoggingSettingsArn='string' ) Parameters: * **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. * **userAccessLoggingSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the user access logging settings. Return type: dict Returns: **Response Syntax** { 'portalArn': 'string', 'userAccessLoggingSettingsArn': 'string' } **Response Structure** * *(dict) --* * **portalArn** *(string) --* The ARN of the web portal. * **userAccessLoggingSettingsArn** *(string) --* The ARN of the user access logging settings. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / create_data_protection_settings create_data_protection_settings ******************************* WorkSpacesWeb.Client.create_data_protection_settings(**kwargs) Creates a data protection settings resource that can be associated with a web portal. See also: AWS API Documentation **Request Syntax** response = client.create_data_protection_settings( displayName='string', description='string', tags=[ { 'Key': 'string', 'Value': 'string' }, ], customerManagedKey='string', additionalEncryptionContext={ 'string': 'string' }, inlineRedactionConfiguration={ 'inlineRedactionPatterns': [ { 'builtInPatternId': 'string', 'customPattern': { 'patternName': 'string', 'patternRegex': 'string', 'patternDescription': 'string', 'keywordRegex': 'string' }, 'redactionPlaceHolder': { 'redactionPlaceHolderType': 'CustomText', 'redactionPlaceHolderText': 'string' }, 'enforcedUrls': [ 'string', ], 'exemptUrls': [ 'string', ], 'confidenceLevel': 123 }, ], 'globalEnforcedUrls': [ 'string', ], 'globalExemptUrls': [ 'string', ], 'globalConfidenceLevel': 123 }, clientToken='string' ) Parameters: * **displayName** (*string*) -- The display name of the data protection settings. * **description** (*string*) -- The description of the data protection settings. * **tags** (*list*) -- The tags to add to the data protection 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 * **customerManagedKey** (*string*) -- The custom managed key of the data protection settings. * **additionalEncryptionContext** (*dict*) -- Additional encryption context of the data protection settings. * *(string) --* * *(string) --* * **inlineRedactionConfiguration** (*dict*) -- The inline redaction configuration of the data protection settings that will be applied to all sessions. * **inlineRedactionPatterns** *(list) --* **[REQUIRED]** The inline redaction patterns to be enabled for the inline redaction configuration. * *(dict) --* The set of patterns that determine the data types redacted in session. * **builtInPatternId** *(string) --* The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required. * **customPattern** *(dict) --* >The configuration for a custom pattern. Either a customPattern or builtInPatternId is required. * **patternName** *(string) --* **[REQUIRED]** The pattern name for the custom pattern. * **patternRegex** *(string) --* **[REQUIRED]** The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”. * **patternDescription** *(string) --* The pattern description for the customer pattern. * **keywordRegex** *(string) --* The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi” * **redactionPlaceHolder** *(dict) --* **[REQUIRED]** The redaction placeholder that will replace the redacted text in session for the inline redaction pattern. * **redactionPlaceHolderType** *(string) --* **[REQUIRED]** The redaction placeholder type that will replace the redacted text in session. * **redactionPlaceHolderText** *(string) --* The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type. * **enforcedUrls** *(list) --* The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration. * *(string) --* * **exemptUrls** *(list) --* The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern. * *(string) --* * **confidenceLevel** *(integer) --* The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level. * **globalEnforcedUrls** *(list) --* The global enforced URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level enforced URL list. * *(string) --* * **globalExemptUrls** *(list) --* The global exempt URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level exempt URL list. * *(string) --* * **globalConfidenceLevel** *(integer) --* The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This is applied to patterns that do not have a pattern-level confidence level. Defaults to confidence level 2. * **clientToken** (*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 Amazon Web Services SDK. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'dataProtectionSettingsArn': 'string' } **Response Structure** * *(dict) --* * **dataProtectionSettingsArn** *(string) --* The ARN of the data protection settings resource. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / create_user_settings create_user_settings ******************** WorkSpacesWeb.Client.create_user_settings(**kwargs) 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** response = client.create_user_settings( copyAllowed='Disabled'|'Enabled', pasteAllowed='Disabled'|'Enabled', downloadAllowed='Disabled'|'Enabled', uploadAllowed='Disabled'|'Enabled', printAllowed='Disabled'|'Enabled', tags=[ { 'Key': 'string', 'Value': 'string' }, ], disconnectTimeoutInMinutes=123, idleDisconnectTimeoutInMinutes=123, clientToken='string', cookieSynchronizationConfiguration={ 'allowlist': [ { 'domain': 'string', 'name': 'string', 'path': 'string' }, ], 'blocklist': [ { 'domain': 'string', 'name': 'string', 'path': 'string' }, ] }, customerManagedKey='string', additionalEncryptionContext={ 'string': 'string' }, deepLinkAllowed='Disabled'|'Enabled', toolbarConfiguration={ 'toolbarType': 'Floating'|'Docked', 'visualMode': 'Dark'|'Light', 'hiddenToolbarItems': [ 'Windows'|'DualMonitor'|'FullScreen'|'Webcam'|'Microphone', ], 'maxDisplayResolution': 'size4096X2160'|'size3840X2160'|'size3440X1440'|'size2560X1440'|'size1920X1080'|'size1280X720'|'size1024X768'|'size800X600' } ) Parameters: * **copyAllowed** (*string*) -- **[REQUIRED]** Specifies whether the user can copy text from the streaming session to the local device. * **pasteAllowed** (*string*) -- **[REQUIRED]** Specifies whether the user can paste text from the local device to the streaming session. * **downloadAllowed** (*string*) -- **[REQUIRED]** Specifies whether the user can download files from the streaming session to the local device. * **uploadAllowed** (*string*) -- **[REQUIRED]** Specifies whether the user can upload files from the local device to the streaming session. * **printAllowed** (*string*) -- **[REQUIRED]** Specifies whether the user can print to the local device. * **tags** (*list*) -- 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 * **disconnectTimeoutInMinutes** (*integer*) -- The amount of time that a streaming session remains active after users disconnect. * **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. * **clientToken** (*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 Amazon Web Services SDK. This field is autopopulated if not provided. * **cookieSynchronizationConfiguration** (*dict*) -- The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. * **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. * **customerManagedKey** (*string*) -- The customer managed key used to encrypt sensitive information in the user settings. * **additionalEncryptionContext** (*dict*) -- The additional encryption context of the user settings. * *(string) --* * *(string) --* * **deepLinkAllowed** (*string*) -- Specifies whether the user can use deep links that open automatically when connecting to a session. * **toolbarConfiguration** (*dict*) -- 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. * **toolbarType** *(string) --* The type of toolbar displayed during the session. * **visualMode** *(string) --* The visual mode of the toolbar. * **hiddenToolbarItems** *(list) --* The list of toolbar items to be hidden. * *(string) --* * **maxDisplayResolution** *(string) --* The maximum display resolution that is allowed for the session. Return type: dict Returns: **Response Syntax** { 'userSettingsArn': 'string' } **Response Structure** * *(dict) --* * **userSettingsArn** *(string) --* The ARN of the user settings. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / delete_identity_provider delete_identity_provider ************************ WorkSpacesWeb.Client.delete_identity_provider(**kwargs) Deletes the identity provider. See also: AWS API Documentation **Request Syntax** response = client.delete_identity_provider( identityProviderArn='string' ) Parameters: **identityProviderArn** (*string*) -- **[REQUIRED]** The ARN of the identity provider. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / create_portal create_portal ************* WorkSpacesWeb.Client.create_portal(**kwargs) Creates a web portal. See also: AWS API Documentation **Request Syntax** response = client.create_portal( displayName='string', tags=[ { 'Key': 'string', 'Value': 'string' }, ], customerManagedKey='string', additionalEncryptionContext={ 'string': 'string' }, clientToken='string', authenticationType='Standard'|'IAM_Identity_Center', instanceType='standard.regular'|'standard.large'|'standard.xlarge', maxConcurrentSessions=123 ) Parameters: * **displayName** (*string*) -- The name of the web portal. This is not visible to users who log into the web portal. * **tags** (*list*) -- 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 * **customerManagedKey** (*string*) -- The customer managed key of the web portal. * **additionalEncryptionContext** (*dict*) -- The additional encryption context of the portal. * *(string) --* * *(string) --* * **clientToken** (*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 Amazon Web Services SDK. This field is autopopulated if not provided. * **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. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center. * **instanceType** (*string*) -- The type and resources of the underlying instance. * **maxConcurrentSessions** (*integer*) -- The maximum number of concurrent sessions for the portal. Return type: 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. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / delete_portal delete_portal ************* WorkSpacesWeb.Client.delete_portal(**kwargs) Deletes a web portal. See also: AWS API Documentation **Request Syntax** response = client.delete_portal( portalArn='string' ) Parameters: **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / get_identity_provider get_identity_provider ********************* WorkSpacesWeb.Client.get_identity_provider(**kwargs) Gets the identity provider. See also: AWS API Documentation **Request Syntax** response = client.get_identity_provider( identityProviderArn='string' ) Parameters: **identityProviderArn** (*string*) -- **[REQUIRED]** The ARN of the identity provider. Return type: dict Returns: **Response Syntax** { 'identityProvider': { 'identityProviderArn': 'string', 'identityProviderName': 'string', 'identityProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC', 'identityProviderDetails': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **identityProvider** *(dict) --* The identity provider. * **identityProviderArn** *(string) --* The ARN of the identity provider. * **identityProviderName** *(string) --* The identity provider name. * **identityProviderType** *(string) --* The identity provider type. * **identityProviderDetails** *(dict) --* The identity provider details. The following list describes the provider detail keys for each identity provider type. * For Google and Login with Amazon: * "client_id" * "client_secret" * "authorize_scopes" * For Facebook: * "client_id" * "client_secret" * "authorize_scopes" * "api_version" * For Sign in with Apple: * "client_id" * "team_id" * "key_id" * "private_key" * "authorize_scopes" * For OIDC providers: * "client_id" * "client_secret" * "attributes_request_method" * "oidc_issuer" * "authorize_scopes" * "authorize_url" *if not available from discovery URL specified by oidc_issuer key* * "token_url" *if not available from discovery URL specified by oidc_issuer key* * "attributes_url" *if not available from discovery URL specified by oidc_issuer key* * "jwks_uri" *if not available from discovery URL specified by oidc_issuer key* * For SAML providers: * "MetadataFile" OR "MetadataURL" * "IDPSignout" (boolean) *optional* * "IDPInit" (boolean) *optional* * "RequestSigningAlgorithm" (string) *optional* - Only accepts "rsa-sha256" * "EncryptedResponses" (boolean) *optional* * *(string) --* * *(string) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / delete_user_access_logging_settings delete_user_access_logging_settings *********************************** WorkSpacesWeb.Client.delete_user_access_logging_settings(**kwargs) Deletes user access logging settings. See also: AWS API Documentation **Request Syntax** response = client.delete_user_access_logging_settings( userAccessLoggingSettingsArn='string' ) Parameters: **userAccessLoggingSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the user access logging settings. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / list_data_protection_settings list_data_protection_settings ***************************** WorkSpacesWeb.Client.list_data_protection_settings(**kwargs) Retrieves a list of data protection settings. See also: AWS API Documentation **Request Syntax** response = client.list_data_protection_settings( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The pagination token used to retrieve the next page of results for this operation. * **maxResults** (*integer*) -- The maximum number of results to be included in the next page. Return type: dict Returns: **Response Syntax** { 'dataProtectionSettings': [ { 'dataProtectionSettingsArn': 'string', 'displayName': 'string', 'description': 'string', 'creationDate': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **dataProtectionSettings** *(list) --* The data protection settings. * *(dict) --* The summary of the data protection settings. * **dataProtectionSettingsArn** *(string) --* The ARN of the data protection settings. * **displayName** *(string) --* The display name of the data protection settings. * **description** *(string) --* The description of the data protection settings. * **creationDate** *(datetime) --* The creation date timestamp of the data protection settings. * **nextToken** *(string) --* The pagination token used to retrieve the next page of results for this operation. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / get_ip_access_settings get_ip_access_settings ********************** WorkSpacesWeb.Client.get_ip_access_settings(**kwargs) Gets the IP access settings. See also: AWS API Documentation **Request Syntax** response = client.get_ip_access_settings( ipAccessSettingsArn='string' ) Parameters: **ipAccessSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the IP access settings. Return type: dict Returns: **Response Syntax** { 'ipAccessSettings': { 'ipAccessSettingsArn': 'string', 'associatedPortalArns': [ 'string', ], 'ipRules': [ { 'ipRange': 'string', 'description': 'string' }, ], 'displayName': 'string', 'description': 'string', 'creationDate': datetime(2015, 1, 1), 'customerManagedKey': 'string', 'additionalEncryptionContext': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **ipAccessSettings** *(dict) --* The IP access settings. * **ipAccessSettingsArn** *(string) --* The ARN of the IP access settings resource. * **associatedPortalArns** *(list) --* A list of web portal ARNs that this IP access settings resource is associated with. * *(string) --* * **ipRules** *(list) --* The IP rules of the IP access settings. * *(dict) --* The IP rules of the IP access settings. * **ipRange** *(string) --* The IP range of the IP rule. * **description** *(string) --* The description of the IP rule. * **displayName** *(string) --* The display name of the IP access settings. * **description** *(string) --* The description of the IP access settings. * **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. * **additionalEncryptionContext** *(dict) --* The additional encryption context of the IP access settings. * *(string) --* * *(string) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / tag_resource tag_resource ************ WorkSpacesWeb.Client.tag_resource(**kwargs) Adds or overwrites one or more tags for the specified resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags=[ { 'Key': 'string', 'Value': 'string' }, ], clientToken='string' ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource. * **tags** (*list*) -- **[REQUIRED]** The tags of the resource. * *(dict) --* The tag. * **Key** *(string) --* **[REQUIRED]** The key of the tag. * **Value** *(string) --* **[REQUIRED]** The value of the tag * **clientToken** (*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 Amazon Web Services SDK. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.TooManyTagsException" WorkSpacesWeb / Client / list_trust_store_certificates list_trust_store_certificates ***************************** WorkSpacesWeb.Client.list_trust_store_certificates(**kwargs) Retrieves a list of trust store certificates. See also: AWS API Documentation **Request Syntax** response = client.list_trust_store_certificates( trustStoreArn='string', nextToken='string', maxResults=123 ) Parameters: * **trustStoreArn** (*string*) -- **[REQUIRED]** The ARN of the trust store * **nextToken** (*string*) -- The pagination token used to retrieve the next page of results for this operation. * **maxResults** (*integer*) -- The maximum number of results to be included in the next page. Return type: dict Returns: **Response Syntax** { 'certificateList': [ { 'thumbprint': 'string', 'subject': 'string', 'issuer': 'string', 'notValidBefore': datetime(2015, 1, 1), 'notValidAfter': datetime(2015, 1, 1) }, ], 'trustStoreArn': 'string', 'nextToken': 'string' } **Response Structure** * *(dict) --* * **certificateList** *(list) --* The certificate list. * *(dict) --* The summary of the certificate. * **thumbprint** *(string) --* A hexadecimal identifier for the certificate. * **subject** *(string) --* The entity the certificate belongs to. * **issuer** *(string) --* The entity that issued the certificate. * **notValidBefore** *(datetime) --* The certificate is not valid before this date. * **notValidAfter** *(datetime) --* The certificate is not valid after this date. * **trustStoreArn** *(string) --* The ARN of the trust store. * **nextToken** *(string) --* The pagination token used to retrieve the next page of results for this operation.> **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" WorkSpacesWeb / Client / update_portal update_portal ************* WorkSpacesWeb.Client.update_portal(**kwargs) Updates a web portal. See also: AWS API Documentation **Request Syntax** response = client.update_portal( portalArn='string', displayName='string', authenticationType='Standard'|'IAM_Identity_Center', instanceType='standard.regular'|'standard.large'|'standard.xlarge', maxConcurrentSessions=123 ) Parameters: * **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. * **displayName** (*string*) -- The name of the web portal. This is not visible to users who log into the web 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. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center. * **instanceType** (*string*) -- The type and resources of the underlying instance. * **maxConcurrentSessions** (*integer*) -- The maximum number of concurrent sessions for the portal. Return type: dict Returns: **Response Syntax** { 'portal': { 'portalArn': 'string', 'rendererType': 'AppStream', 'browserType': 'Chrome', 'portalStatus': 'Incomplete'|'Pending'|'Active', 'portalEndpoint': 'string', 'displayName': 'string', 'creationDate': datetime(2015, 1, 1), 'browserSettingsArn': 'string', 'dataProtectionSettingsArn': 'string', 'userSettingsArn': 'string', 'networkSettingsArn': 'string', 'sessionLoggerArn': 'string', 'trustStoreArn': 'string', 'statusReason': 'string', 'userAccessLoggingSettingsArn': 'string', 'authenticationType': 'Standard'|'IAM_Identity_Center', 'ipAccessSettingsArn': 'string', 'customerManagedKey': 'string', 'additionalEncryptionContext': { 'string': 'string' }, 'instanceType': 'standard.regular'|'standard.large'|'standard.xlarge', 'maxConcurrentSessions': 123 } } **Response Structure** * *(dict) --* * **portal** *(dict) --* The web portal. * **portalArn** *(string) --* The ARN of the web portal. * **rendererType** *(string) --* The renderer that is used in streaming sessions. * **browserType** *(string) --* The browser that users see when using a streaming session. * **portalStatus** *(string) --* The status of the web portal. * **portalEndpoint** *(string) --* The endpoint URL of the web portal that users access in order to start streaming sessions. * **displayName** *(string) --* The name of the web portal. * **creationDate** *(datetime) --* The creation date of the web portal. * **browserSettingsArn** *(string) --* The ARN of the browser settings that is associated with this web portal. * **dataProtectionSettingsArn** *(string) --* The ARN of the data protection settings. * **userSettingsArn** *(string) --* The ARN of the user settings that is associated with the web portal. * **networkSettingsArn** *(string) --* The ARN of the network settings that is associated with the web portal. * **sessionLoggerArn** *(string) --* The ARN of the session logger that is assocaited with the portal. * **trustStoreArn** *(string) --* The ARN of the trust store that is associated with the web portal. * **statusReason** *(string) --* A message that explains why the web portal is in its current status. * **userAccessLoggingSettingsArn** *(string) --* The ARN of the user access logging settings that is associated with the web 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. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center. * **ipAccessSettingsArn** *(string) --* The ARN of the IP access settings. * **customerManagedKey** *(string) --* The customer managed key used to encrypt sensitive information in the portal. * **additionalEncryptionContext** *(dict) --* The additional encryption context of the portal. * *(string) --* * *(string) --* * **instanceType** *(string) --* The type and resources of the underlying instance. * **maxConcurrentSessions** *(integer) --* The maximum number of concurrent sessions for the portal. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / disassociate_ip_access_settings disassociate_ip_access_settings ******************************* WorkSpacesWeb.Client.disassociate_ip_access_settings(**kwargs) Disassociates IP access settings from a web portal. See also: AWS API Documentation **Request Syntax** response = client.disassociate_ip_access_settings( portalArn='string' ) Parameters: **portalArn** (*string*) -- **[REQUIRED]** The ARN of the web portal. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException" * "WorkSpacesWeb.Client.exceptions.ConflictException" WorkSpacesWeb / Client / update_user_access_logging_settings update_user_access_logging_settings *********************************** WorkSpacesWeb.Client.update_user_access_logging_settings(**kwargs) Updates the user access logging settings. See also: AWS API Documentation **Request Syntax** response = client.update_user_access_logging_settings( userAccessLoggingSettingsArn='string', kinesisStreamArn='string', clientToken='string' ) Parameters: * **userAccessLoggingSettingsArn** (*string*) -- **[REQUIRED]** The ARN of the user access logging settings. * **kinesisStreamArn** (*string*) -- The ARN of the Kinesis stream. * **clientToken** (*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 return 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. Return type: dict Returns: **Response Syntax** { 'userAccessLoggingSettings': { 'userAccessLoggingSettingsArn': 'string', 'associatedPortalArns': [ 'string', ], 'kinesisStreamArn': 'string' } } **Response Structure** * *(dict) --* * **userAccessLoggingSettings** *(dict) --* The user access logging settings. * **userAccessLoggingSettingsArn** *(string) --* The ARN of the user access logging settings. * **associatedPortalArns** *(list) --* A list of web portal ARNs that this user access logging settings is associated with. * *(string) --* * **kinesisStreamArn** *(string) --* The ARN of the Kinesis stream. **Exceptions** * "WorkSpacesWeb.Client.exceptions.InternalServerException" * "WorkSpacesWeb.Client.exceptions.ResourceNotFoundException" * "WorkSpacesWeb.Client.exceptions.AccessDeniedException" * "WorkSpacesWeb.Client.exceptions.ThrottlingException" * "WorkSpacesWeb.Client.exceptions.ValidationException"