Skip to content

WorkSpacesWebClient#

Index > WorkSpacesWeb > WorkSpacesWebClient

Auto-generated documentation for WorkSpacesWeb type annotations stubs module mypy-boto3-workspaces-web.

WorkSpacesWebClient#

Type annotations and code completion for boto3.client("workspaces-web"). boto3 documentation

# WorkSpacesWebClient usage example

from boto3.session import Session
from mypy_boto3_workspaces_web.client import WorkSpacesWebClient

def get_workspaces-web_client() -> WorkSpacesWebClient:
    return Session().client("workspaces-web")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("workspaces-web").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("workspaces-web")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.TooManyTagsException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_workspaces_web.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("workspaces-web").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("workspaces-web").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

associate_browser_settings#

Associates a browser settings resource with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").associate_browser_settings method. boto3 documentation

# associate_browser_settings method definition

def associate_browser_settings(
    self,
    *,
    browserSettingsArn: str,
    portalArn: str,
) -> AssociateBrowserSettingsResponseTypeDef:  # (1)
    ...
  1. See AssociateBrowserSettingsResponseTypeDef 
# associate_browser_settings method usage example with argument unpacking

kwargs: AssociateBrowserSettingsRequestTypeDef = {  # (1)
    "browserSettingsArn": ...,
    "portalArn": ...,
}

parent.associate_browser_settings(**kwargs)
  1. See AssociateBrowserSettingsRequestTypeDef

associate_data_protection_settings#

Associates a data protection settings resource with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").associate_data_protection_settings method. boto3 documentation

# associate_data_protection_settings method definition

def associate_data_protection_settings(
    self,
    *,
    dataProtectionSettingsArn: str,
    portalArn: str,
) -> AssociateDataProtectionSettingsResponseTypeDef:  # (1)
    ...
  1. See AssociateDataProtectionSettingsResponseTypeDef 
# associate_data_protection_settings method usage example with argument unpacking

kwargs: AssociateDataProtectionSettingsRequestTypeDef = {  # (1)
    "dataProtectionSettingsArn": ...,
    "portalArn": ...,
}

parent.associate_data_protection_settings(**kwargs)
  1. See AssociateDataProtectionSettingsRequestTypeDef

associate_ip_access_settings#

Associates an IP access settings resource with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").associate_ip_access_settings method. boto3 documentation

# associate_ip_access_settings method definition

def associate_ip_access_settings(
    self,
    *,
    ipAccessSettingsArn: str,
    portalArn: str,
) -> AssociateIpAccessSettingsResponseTypeDef:  # (1)
    ...
  1. See AssociateIpAccessSettingsResponseTypeDef 
# associate_ip_access_settings method usage example with argument unpacking

kwargs: AssociateIpAccessSettingsRequestTypeDef = {  # (1)
    "ipAccessSettingsArn": ...,
    "portalArn": ...,
}

parent.associate_ip_access_settings(**kwargs)
  1. See AssociateIpAccessSettingsRequestTypeDef

associate_network_settings#

Associates a network settings resource with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").associate_network_settings method. boto3 documentation

# associate_network_settings method definition

def associate_network_settings(
    self,
    *,
    networkSettingsArn: str,
    portalArn: str,
) -> AssociateNetworkSettingsResponseTypeDef:  # (1)
    ...
  1. See AssociateNetworkSettingsResponseTypeDef 
# associate_network_settings method usage example with argument unpacking

kwargs: AssociateNetworkSettingsRequestTypeDef = {  # (1)
    "networkSettingsArn": ...,
    "portalArn": ...,
}

parent.associate_network_settings(**kwargs)
  1. See AssociateNetworkSettingsRequestTypeDef

associate_trust_store#

Associates a trust store with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").associate_trust_store method. boto3 documentation

# associate_trust_store method definition

def associate_trust_store(
    self,
    *,
    portalArn: str,
    trustStoreArn: str,
) -> AssociateTrustStoreResponseTypeDef:  # (1)
    ...
  1. See AssociateTrustStoreResponseTypeDef 
# associate_trust_store method usage example with argument unpacking

kwargs: AssociateTrustStoreRequestTypeDef = {  # (1)
    "portalArn": ...,
    "trustStoreArn": ...,
}

parent.associate_trust_store(**kwargs)
  1. See AssociateTrustStoreRequestTypeDef

associate_user_access_logging_settings#

Associates a user access logging settings resource with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").associate_user_access_logging_settings method. boto3 documentation

# associate_user_access_logging_settings method definition

def associate_user_access_logging_settings(
    self,
    *,
    portalArn: str,
    userAccessLoggingSettingsArn: str,
) -> AssociateUserAccessLoggingSettingsResponseTypeDef:  # (1)
    ...
  1. See AssociateUserAccessLoggingSettingsResponseTypeDef 
# associate_user_access_logging_settings method usage example with argument unpacking

kwargs: AssociateUserAccessLoggingSettingsRequestTypeDef = {  # (1)
    "portalArn": ...,
    "userAccessLoggingSettingsArn": ...,
}

parent.associate_user_access_logging_settings(**kwargs)
  1. See AssociateUserAccessLoggingSettingsRequestTypeDef

associate_user_settings#

Associates a user settings resource with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").associate_user_settings method. boto3 documentation

# associate_user_settings method definition

def associate_user_settings(
    self,
    *,
    portalArn: str,
    userSettingsArn: str,
) -> AssociateUserSettingsResponseTypeDef:  # (1)
    ...
  1. See AssociateUserSettingsResponseTypeDef 
# associate_user_settings method usage example with argument unpacking

kwargs: AssociateUserSettingsRequestTypeDef = {  # (1)
    "portalArn": ...,
    "userSettingsArn": ...,
}

parent.associate_user_settings(**kwargs)
  1. See AssociateUserSettingsRequestTypeDef

create_browser_settings#

Creates a browser settings resource that can be associated with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").create_browser_settings method. boto3 documentation

# create_browser_settings method definition

def create_browser_settings(
    self,
    *,
    browserPolicy: str,
    additionalEncryptionContext: Mapping[str, str] = ...,
    clientToken: str = ...,
    customerManagedKey: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateBrowserSettingsResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateBrowserSettingsResponseTypeDef 
# create_browser_settings method usage example with argument unpacking

kwargs: CreateBrowserSettingsRequestTypeDef = {  # (1)
    "browserPolicy": ...,
}

parent.create_browser_settings(**kwargs)
  1. See CreateBrowserSettingsRequestTypeDef

create_data_protection_settings#

Creates a data protection settings resource that can be associated with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").create_data_protection_settings method. boto3 documentation

# create_data_protection_settings method definition

def create_data_protection_settings(
    self,
    *,
    additionalEncryptionContext: Mapping[str, str] = ...,
    clientToken: str = ...,
    customerManagedKey: str = ...,
    description: str = ...,
    displayName: str = ...,
    inlineRedactionConfiguration: InlineRedactionConfigurationUnionTypeDef = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateDataProtectionSettingsResponseTypeDef:  # (3)
    ...
  1. See InlineRedactionConfigurationTypeDef InlineRedactionConfigurationOutputTypeDef
  2. See TagTypeDef
  3. See CreateDataProtectionSettingsResponseTypeDef 
# create_data_protection_settings method usage example with argument unpacking

kwargs: CreateDataProtectionSettingsRequestTypeDef = {  # (1)
    "additionalEncryptionContext": ...,
}

parent.create_data_protection_settings(**kwargs)
  1. See CreateDataProtectionSettingsRequestTypeDef

create_identity_provider#

Creates an identity provider resource that is then associated with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").create_identity_provider method. boto3 documentation

# create_identity_provider method definition

def create_identity_provider(
    self,
    *,
    identityProviderDetails: Mapping[str, str],
    identityProviderName: str,
    identityProviderType: IdentityProviderTypeType,  # (1)
    portalArn: str,
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateIdentityProviderResponseTypeDef:  # (3)
    ...
  1. See IdentityProviderTypeType
  2. See TagTypeDef
  3. See CreateIdentityProviderResponseTypeDef 
# create_identity_provider method usage example with argument unpacking

kwargs: CreateIdentityProviderRequestTypeDef = {  # (1)
    "identityProviderDetails": ...,
    "identityProviderName": ...,
    "identityProviderType": ...,
    "portalArn": ...,
}

parent.create_identity_provider(**kwargs)
  1. See CreateIdentityProviderRequestTypeDef

create_ip_access_settings#

Creates an IP access settings resource that can be associated with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").create_ip_access_settings method. boto3 documentation

# create_ip_access_settings method definition

def create_ip_access_settings(
    self,
    *,
    ipRules: Sequence[IpRuleTypeDef],  # (1)
    additionalEncryptionContext: Mapping[str, str] = ...,
    clientToken: str = ...,
    customerManagedKey: str = ...,
    description: str = ...,
    displayName: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateIpAccessSettingsResponseTypeDef:  # (3)
    ...
  1. See IpRuleTypeDef
  2. See TagTypeDef
  3. See CreateIpAccessSettingsResponseTypeDef 
# create_ip_access_settings method usage example with argument unpacking

kwargs: CreateIpAccessSettingsRequestTypeDef = {  # (1)
    "ipRules": ...,
}

parent.create_ip_access_settings(**kwargs)
  1. See CreateIpAccessSettingsRequestTypeDef

create_network_settings#

Creates a network settings resource that can be associated with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").create_network_settings method. boto3 documentation

# create_network_settings method definition

def create_network_settings(
    self,
    *,
    securityGroupIds: Sequence[str],
    subnetIds: Sequence[str],
    vpcId: str,
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateNetworkSettingsResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateNetworkSettingsResponseTypeDef 
# create_network_settings method usage example with argument unpacking

kwargs: CreateNetworkSettingsRequestTypeDef = {  # (1)
    "securityGroupIds": ...,
    "subnetIds": ...,
    "vpcId": ...,
}

parent.create_network_settings(**kwargs)
  1. See CreateNetworkSettingsRequestTypeDef

create_portal#

Creates a web portal.

Type annotations and code completion for boto3.client("workspaces-web").create_portal method. boto3 documentation

# create_portal method definition

def create_portal(
    self,
    *,
    additionalEncryptionContext: Mapping[str, str] = ...,
    authenticationType: AuthenticationTypeType = ...,  # (1)
    clientToken: str = ...,
    customerManagedKey: str = ...,
    displayName: str = ...,
    instanceType: InstanceTypeType = ...,  # (2)
    maxConcurrentSessions: int = ...,
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreatePortalResponseTypeDef:  # (4)
    ...
  1. See AuthenticationTypeType
  2. See InstanceTypeType
  3. See TagTypeDef
  4. See CreatePortalResponseTypeDef 
# create_portal method usage example with argument unpacking

kwargs: CreatePortalRequestTypeDef = {  # (1)
    "additionalEncryptionContext": ...,
}

parent.create_portal(**kwargs)
  1. See CreatePortalRequestTypeDef

create_trust_store#

Creates a trust store that can be associated with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").create_trust_store method. boto3 documentation

# create_trust_store method definition

def create_trust_store(
    self,
    *,
    certificateList: Sequence[BlobTypeDef],
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateTrustStoreResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateTrustStoreResponseTypeDef 
# create_trust_store method usage example with argument unpacking

kwargs: CreateTrustStoreRequestTypeDef = {  # (1)
    "certificateList": ...,
}

parent.create_trust_store(**kwargs)
  1. See CreateTrustStoreRequestTypeDef

create_user_access_logging_settings#

Creates a user access logging settings resource that can be associated with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").create_user_access_logging_settings method. boto3 documentation

# create_user_access_logging_settings method definition

def create_user_access_logging_settings(
    self,
    *,
    kinesisStreamArn: str,
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateUserAccessLoggingSettingsResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateUserAccessLoggingSettingsResponseTypeDef 
# create_user_access_logging_settings method usage example with argument unpacking

kwargs: CreateUserAccessLoggingSettingsRequestTypeDef = {  # (1)
    "kinesisStreamArn": ...,
}

parent.create_user_access_logging_settings(**kwargs)
  1. See CreateUserAccessLoggingSettingsRequestTypeDef

create_user_settings#

Creates a user settings resource that can be associated with a web portal.

Type annotations and code completion for boto3.client("workspaces-web").create_user_settings method. boto3 documentation

# create_user_settings method definition

def create_user_settings(
    self,
    *,
    copyAllowed: EnabledTypeType,  # (1)
    downloadAllowed: EnabledTypeType,  # (1)
    pasteAllowed: EnabledTypeType,  # (1)
    printAllowed: EnabledTypeType,  # (1)
    uploadAllowed: EnabledTypeType,  # (1)
    additionalEncryptionContext: Mapping[str, str] = ...,
    clientToken: str = ...,
    cookieSynchronizationConfiguration: CookieSynchronizationConfigurationUnionTypeDef = ...,  # (6)
    customerManagedKey: str = ...,
    deepLinkAllowed: EnabledTypeType = ...,  # (1)
    disconnectTimeoutInMinutes: int = ...,
    idleDisconnectTimeoutInMinutes: int = ...,
    tags: Sequence[TagTypeDef] = ...,  # (8)
    toolbarConfiguration: ToolbarConfigurationUnionTypeDef = ...,  # (9)
) -> CreateUserSettingsResponseTypeDef:  # (10)
    ...
  1. See EnabledTypeType
  2. See EnabledTypeType
  3. See EnabledTypeType
  4. See EnabledTypeType
  5. See EnabledTypeType
  6. See CookieSynchronizationConfigurationTypeDef CookieSynchronizationConfigurationOutputTypeDef
  7. See EnabledTypeType
  8. See TagTypeDef
  9. See ToolbarConfigurationTypeDef ToolbarConfigurationOutputTypeDef
  10. See CreateUserSettingsResponseTypeDef 
# create_user_settings method usage example with argument unpacking

kwargs: CreateUserSettingsRequestTypeDef = {  # (1)
    "copyAllowed": ...,
    "downloadAllowed": ...,
    "pasteAllowed": ...,
    "printAllowed": ...,
    "uploadAllowed": ...,
}

parent.create_user_settings(**kwargs)
  1. See CreateUserSettingsRequestTypeDef

delete_browser_settings#

Deletes browser settings.

Type annotations and code completion for boto3.client("workspaces-web").delete_browser_settings method. boto3 documentation

# delete_browser_settings method definition

def delete_browser_settings(
    self,
    *,
    browserSettingsArn: str,
) -> Dict[str, Any]:
    ...
# delete_browser_settings method usage example with argument unpacking

kwargs: DeleteBrowserSettingsRequestTypeDef = {  # (1)
    "browserSettingsArn": ...,
}

parent.delete_browser_settings(**kwargs)
  1. See DeleteBrowserSettingsRequestTypeDef

delete_data_protection_settings#

Deletes data protection settings.

Type annotations and code completion for boto3.client("workspaces-web").delete_data_protection_settings method. boto3 documentation

# delete_data_protection_settings method definition

def delete_data_protection_settings(
    self,
    *,
    dataProtectionSettingsArn: str,
) -> Dict[str, Any]:
    ...
# delete_data_protection_settings method usage example with argument unpacking

kwargs: DeleteDataProtectionSettingsRequestTypeDef = {  # (1)
    "dataProtectionSettingsArn": ...,
}

parent.delete_data_protection_settings(**kwargs)
  1. See DeleteDataProtectionSettingsRequestTypeDef

delete_identity_provider#

Deletes the identity provider.

Type annotations and code completion for boto3.client("workspaces-web").delete_identity_provider method. boto3 documentation

# delete_identity_provider method definition

def delete_identity_provider(
    self,
    *,
    identityProviderArn: str,
) -> Dict[str, Any]:
    ...
# delete_identity_provider method usage example with argument unpacking

kwargs: DeleteIdentityProviderRequestTypeDef = {  # (1)
    "identityProviderArn": ...,
}

parent.delete_identity_provider(**kwargs)
  1. See DeleteIdentityProviderRequestTypeDef

delete_ip_access_settings#

Deletes IP access settings.

Type annotations and code completion for boto3.client("workspaces-web").delete_ip_access_settings method. boto3 documentation

# delete_ip_access_settings method definition

def delete_ip_access_settings(
    self,
    *,
    ipAccessSettingsArn: str,
) -> Dict[str, Any]:
    ...
# delete_ip_access_settings method usage example with argument unpacking

kwargs: DeleteIpAccessSettingsRequestTypeDef = {  # (1)
    "ipAccessSettingsArn": ...,
}

parent.delete_ip_access_settings(**kwargs)
  1. See DeleteIpAccessSettingsRequestTypeDef

delete_network_settings#

Deletes network settings.

Type annotations and code completion for boto3.client("workspaces-web").delete_network_settings method. boto3 documentation

# delete_network_settings method definition

def delete_network_settings(
    self,
    *,
    networkSettingsArn: str,
) -> Dict[str, Any]:
    ...
# delete_network_settings method usage example with argument unpacking

kwargs: DeleteNetworkSettingsRequestTypeDef = {  # (1)
    "networkSettingsArn": ...,
}

parent.delete_network_settings(**kwargs)
  1. See DeleteNetworkSettingsRequestTypeDef

delete_portal#

Deletes a web portal.

Type annotations and code completion for boto3.client("workspaces-web").delete_portal method. boto3 documentation

# delete_portal method definition

def delete_portal(
    self,
    *,
    portalArn: str,
) -> Dict[str, Any]:
    ...
# delete_portal method usage example with argument unpacking

kwargs: DeletePortalRequestTypeDef = {  # (1)
    "portalArn": ...,
}

parent.delete_portal(**kwargs)
  1. See DeletePortalRequestTypeDef

delete_trust_store#

Deletes the trust store.

Type annotations and code completion for boto3.client("workspaces-web").delete_trust_store method. boto3 documentation

# delete_trust_store method definition

def delete_trust_store(
    self,
    *,
    trustStoreArn: str,
) -> Dict[str, Any]:
    ...
# delete_trust_store method usage example with argument unpacking

kwargs: DeleteTrustStoreRequestTypeDef = {  # (1)
    "trustStoreArn": ...,
}

parent.delete_trust_store(**kwargs)
  1. See DeleteTrustStoreRequestTypeDef

delete_user_access_logging_settings#

Deletes user access logging settings.

Type annotations and code completion for boto3.client("workspaces-web").delete_user_access_logging_settings method. boto3 documentation

# delete_user_access_logging_settings method definition

def delete_user_access_logging_settings(
    self,
    *,
    userAccessLoggingSettingsArn: str,
) -> Dict[str, Any]:
    ...
# delete_user_access_logging_settings method usage example with argument unpacking

kwargs: DeleteUserAccessLoggingSettingsRequestTypeDef = {  # (1)
    "userAccessLoggingSettingsArn": ...,
}

parent.delete_user_access_logging_settings(**kwargs)
  1. See DeleteUserAccessLoggingSettingsRequestTypeDef

delete_user_settings#

Deletes user settings.

Type annotations and code completion for boto3.client("workspaces-web").delete_user_settings method. boto3 documentation

# delete_user_settings method definition

def delete_user_settings(
    self,
    *,
    userSettingsArn: str,
) -> Dict[str, Any]:
    ...
# delete_user_settings method usage example with argument unpacking

kwargs: DeleteUserSettingsRequestTypeDef = {  # (1)
    "userSettingsArn": ...,
}

parent.delete_user_settings(**kwargs)
  1. See DeleteUserSettingsRequestTypeDef

disassociate_browser_settings#

Disassociates browser settings from a web portal.

Type annotations and code completion for boto3.client("workspaces-web").disassociate_browser_settings method. boto3 documentation

# disassociate_browser_settings method definition

def disassociate_browser_settings(
    self,
    *,
    portalArn: str,
) -> Dict[str, Any]:
    ...
# disassociate_browser_settings method usage example with argument unpacking

kwargs: DisassociateBrowserSettingsRequestTypeDef = {  # (1)
    "portalArn": ...,
}

parent.disassociate_browser_settings(**kwargs)
  1. See DisassociateBrowserSettingsRequestTypeDef

disassociate_data_protection_settings#

Disassociates data protection settings from a web portal.

Type annotations and code completion for boto3.client("workspaces-web").disassociate_data_protection_settings method. boto3 documentation

# disassociate_data_protection_settings method definition

def disassociate_data_protection_settings(
    self,
    *,
    portalArn: str,
) -> Dict[str, Any]:
    ...
# disassociate_data_protection_settings method usage example with argument unpacking

kwargs: DisassociateDataProtectionSettingsRequestTypeDef = {  # (1)
    "portalArn": ...,
}

parent.disassociate_data_protection_settings(**kwargs)
  1. See DisassociateDataProtectionSettingsRequestTypeDef

disassociate_ip_access_settings#

Disassociates IP access settings from a web portal.

Type annotations and code completion for boto3.client("workspaces-web").disassociate_ip_access_settings method. boto3 documentation

# disassociate_ip_access_settings method definition

def disassociate_ip_access_settings(
    self,
    *,
    portalArn: str,
) -> Dict[str, Any]:
    ...
# disassociate_ip_access_settings method usage example with argument unpacking

kwargs: DisassociateIpAccessSettingsRequestTypeDef = {  # (1)
    "portalArn": ...,
}

parent.disassociate_ip_access_settings(**kwargs)
  1. See DisassociateIpAccessSettingsRequestTypeDef

disassociate_network_settings#

Disassociates network settings from a web portal.

Type annotations and code completion for boto3.client("workspaces-web").disassociate_network_settings method. boto3 documentation

# disassociate_network_settings method definition

def disassociate_network_settings(
    self,
    *,
    portalArn: str,
) -> Dict[str, Any]:
    ...
# disassociate_network_settings method usage example with argument unpacking

kwargs: DisassociateNetworkSettingsRequestTypeDef = {  # (1)
    "portalArn": ...,
}

parent.disassociate_network_settings(**kwargs)
  1. See DisassociateNetworkSettingsRequestTypeDef

disassociate_trust_store#

Disassociates a trust store from a web portal.

Type annotations and code completion for boto3.client("workspaces-web").disassociate_trust_store method. boto3 documentation

# disassociate_trust_store method definition

def disassociate_trust_store(
    self,
    *,
    portalArn: str,
) -> Dict[str, Any]:
    ...
# disassociate_trust_store method usage example with argument unpacking

kwargs: DisassociateTrustStoreRequestTypeDef = {  # (1)
    "portalArn": ...,
}

parent.disassociate_trust_store(**kwargs)
  1. See DisassociateTrustStoreRequestTypeDef

disassociate_user_access_logging_settings#

Disassociates user access logging settings from a web portal.

Type annotations and code completion for boto3.client("workspaces-web").disassociate_user_access_logging_settings method. boto3 documentation

# disassociate_user_access_logging_settings method definition

def disassociate_user_access_logging_settings(
    self,
    *,
    portalArn: str,
) -> Dict[str, Any]:
    ...
# disassociate_user_access_logging_settings method usage example with argument unpacking

kwargs: DisassociateUserAccessLoggingSettingsRequestTypeDef = {  # (1)
    "portalArn": ...,
}

parent.disassociate_user_access_logging_settings(**kwargs)
  1. See DisassociateUserAccessLoggingSettingsRequestTypeDef

disassociate_user_settings#

Disassociates user settings from a web portal.

Type annotations and code completion for boto3.client("workspaces-web").disassociate_user_settings method. boto3 documentation

# disassociate_user_settings method definition

def disassociate_user_settings(
    self,
    *,
    portalArn: str,
) -> Dict[str, Any]:
    ...
# disassociate_user_settings method usage example with argument unpacking

kwargs: DisassociateUserSettingsRequestTypeDef = {  # (1)
    "portalArn": ...,
}

parent.disassociate_user_settings(**kwargs)
  1. See DisassociateUserSettingsRequestTypeDef

expire_session#

Expires an active secure browser session.

Type annotations and code completion for boto3.client("workspaces-web").expire_session method. boto3 documentation

# expire_session method definition

def expire_session(
    self,
    *,
    portalId: str,
    sessionId: str,
) -> Dict[str, Any]:
    ...
# expire_session method usage example with argument unpacking

kwargs: ExpireSessionRequestTypeDef = {  # (1)
    "portalId": ...,
    "sessionId": ...,
}

parent.expire_session(**kwargs)
  1. See ExpireSessionRequestTypeDef

get_browser_settings#

Gets browser settings.

Type annotations and code completion for boto3.client("workspaces-web").get_browser_settings method. boto3 documentation

# get_browser_settings method definition

def get_browser_settings(
    self,
    *,
    browserSettingsArn: str,
) -> GetBrowserSettingsResponseTypeDef:  # (1)
    ...
  1. See GetBrowserSettingsResponseTypeDef 
# get_browser_settings method usage example with argument unpacking

kwargs: GetBrowserSettingsRequestTypeDef = {  # (1)
    "browserSettingsArn": ...,
}

parent.get_browser_settings(**kwargs)
  1. See GetBrowserSettingsRequestTypeDef

get_data_protection_settings#

Gets the data protection settings.

Type annotations and code completion for boto3.client("workspaces-web").get_data_protection_settings method. boto3 documentation

# get_data_protection_settings method definition

def get_data_protection_settings(
    self,
    *,
    dataProtectionSettingsArn: str,
) -> GetDataProtectionSettingsResponseTypeDef:  # (1)
    ...
  1. See GetDataProtectionSettingsResponseTypeDef 
# get_data_protection_settings method usage example with argument unpacking

kwargs: GetDataProtectionSettingsRequestTypeDef = {  # (1)
    "dataProtectionSettingsArn": ...,
}

parent.get_data_protection_settings(**kwargs)
  1. See GetDataProtectionSettingsRequestTypeDef

get_identity_provider#

Gets the identity provider.

Type annotations and code completion for boto3.client("workspaces-web").get_identity_provider method. boto3 documentation

# get_identity_provider method definition

def get_identity_provider(
    self,
    *,
    identityProviderArn: str,
) -> GetIdentityProviderResponseTypeDef:  # (1)
    ...
  1. See GetIdentityProviderResponseTypeDef 
# get_identity_provider method usage example with argument unpacking

kwargs: GetIdentityProviderRequestTypeDef = {  # (1)
    "identityProviderArn": ...,
}

parent.get_identity_provider(**kwargs)
  1. See GetIdentityProviderRequestTypeDef

get_ip_access_settings#

Gets the IP access settings.

Type annotations and code completion for boto3.client("workspaces-web").get_ip_access_settings method. boto3 documentation

# get_ip_access_settings method definition

def get_ip_access_settings(
    self,
    *,
    ipAccessSettingsArn: str,
) -> GetIpAccessSettingsResponseTypeDef:  # (1)
    ...
  1. See GetIpAccessSettingsResponseTypeDef 
# get_ip_access_settings method usage example with argument unpacking

kwargs: GetIpAccessSettingsRequestTypeDef = {  # (1)
    "ipAccessSettingsArn": ...,
}

parent.get_ip_access_settings(**kwargs)
  1. See GetIpAccessSettingsRequestTypeDef

get_network_settings#

Gets the network settings.

Type annotations and code completion for boto3.client("workspaces-web").get_network_settings method. boto3 documentation

# get_network_settings method definition

def get_network_settings(
    self,
    *,
    networkSettingsArn: str,
) -> GetNetworkSettingsResponseTypeDef:  # (1)
    ...
  1. See GetNetworkSettingsResponseTypeDef 
# get_network_settings method usage example with argument unpacking

kwargs: GetNetworkSettingsRequestTypeDef = {  # (1)
    "networkSettingsArn": ...,
}

parent.get_network_settings(**kwargs)
  1. See GetNetworkSettingsRequestTypeDef

get_portal#

Gets the web portal.

Type annotations and code completion for boto3.client("workspaces-web").get_portal method. boto3 documentation

# get_portal method definition

def get_portal(
    self,
    *,
    portalArn: str,
) -> GetPortalResponseTypeDef:  # (1)
    ...
  1. See GetPortalResponseTypeDef 
# get_portal method usage example with argument unpacking

kwargs: GetPortalRequestTypeDef = {  # (1)
    "portalArn": ...,
}

parent.get_portal(**kwargs)
  1. See GetPortalRequestTypeDef

get_portal_service_provider_metadata#

Gets the service provider metadata.

Type annotations and code completion for boto3.client("workspaces-web").get_portal_service_provider_metadata method. boto3 documentation

# get_portal_service_provider_metadata method definition

def get_portal_service_provider_metadata(
    self,
    *,
    portalArn: str,
) -> GetPortalServiceProviderMetadataResponseTypeDef:  # (1)
    ...
  1. See GetPortalServiceProviderMetadataResponseTypeDef 
# get_portal_service_provider_metadata method usage example with argument unpacking

kwargs: GetPortalServiceProviderMetadataRequestTypeDef = {  # (1)
    "portalArn": ...,
}

parent.get_portal_service_provider_metadata(**kwargs)
  1. See GetPortalServiceProviderMetadataRequestTypeDef

get_session#

Gets information for a secure browser session.

Type annotations and code completion for boto3.client("workspaces-web").get_session method. boto3 documentation

# get_session method definition

def get_session(
    self,
    *,
    portalId: str,
    sessionId: str,
) -> GetSessionResponseTypeDef:  # (1)
    ...
  1. See GetSessionResponseTypeDef 
# get_session method usage example with argument unpacking

kwargs: GetSessionRequestTypeDef = {  # (1)
    "portalId": ...,
    "sessionId": ...,
}

parent.get_session(**kwargs)
  1. See GetSessionRequestTypeDef

get_trust_store#

Gets the trust store.

Type annotations and code completion for boto3.client("workspaces-web").get_trust_store method. boto3 documentation

# get_trust_store method definition

def get_trust_store(
    self,
    *,
    trustStoreArn: str,
) -> GetTrustStoreResponseTypeDef:  # (1)
    ...
  1. See GetTrustStoreResponseTypeDef 
# get_trust_store method usage example with argument unpacking

kwargs: GetTrustStoreRequestTypeDef = {  # (1)
    "trustStoreArn": ...,
}

parent.get_trust_store(**kwargs)
  1. See GetTrustStoreRequestTypeDef

get_trust_store_certificate#

Gets the trust store certificate.

Type annotations and code completion for boto3.client("workspaces-web").get_trust_store_certificate method. boto3 documentation

# get_trust_store_certificate method definition

def get_trust_store_certificate(
    self,
    *,
    thumbprint: str,
    trustStoreArn: str,
) -> GetTrustStoreCertificateResponseTypeDef:  # (1)
    ...
  1. See GetTrustStoreCertificateResponseTypeDef 
# get_trust_store_certificate method usage example with argument unpacking

kwargs: GetTrustStoreCertificateRequestTypeDef = {  # (1)
    "thumbprint": ...,
    "trustStoreArn": ...,
}

parent.get_trust_store_certificate(**kwargs)
  1. See GetTrustStoreCertificateRequestTypeDef

get_user_access_logging_settings#

Gets user access logging settings.

Type annotations and code completion for boto3.client("workspaces-web").get_user_access_logging_settings method. boto3 documentation

# get_user_access_logging_settings method definition

def get_user_access_logging_settings(
    self,
    *,
    userAccessLoggingSettingsArn: str,
) -> GetUserAccessLoggingSettingsResponseTypeDef:  # (1)
    ...
  1. See GetUserAccessLoggingSettingsResponseTypeDef 
# get_user_access_logging_settings method usage example with argument unpacking

kwargs: GetUserAccessLoggingSettingsRequestTypeDef = {  # (1)
    "userAccessLoggingSettingsArn": ...,
}

parent.get_user_access_logging_settings(**kwargs)
  1. See GetUserAccessLoggingSettingsRequestTypeDef

get_user_settings#

Gets user settings.

Type annotations and code completion for boto3.client("workspaces-web").get_user_settings method. boto3 documentation

# get_user_settings method definition

def get_user_settings(
    self,
    *,
    userSettingsArn: str,
) -> GetUserSettingsResponseTypeDef:  # (1)
    ...
  1. See GetUserSettingsResponseTypeDef 
# get_user_settings method usage example with argument unpacking

kwargs: GetUserSettingsRequestTypeDef = {  # (1)
    "userSettingsArn": ...,
}

parent.get_user_settings(**kwargs)
  1. See GetUserSettingsRequestTypeDef

list_browser_settings#

Retrieves a list of browser settings.

Type annotations and code completion for boto3.client("workspaces-web").list_browser_settings method. boto3 documentation

# list_browser_settings method definition

def list_browser_settings(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBrowserSettingsResponseTypeDef:  # (1)
    ...
  1. See ListBrowserSettingsResponseTypeDef 
# list_browser_settings method usage example with argument unpacking

kwargs: ListBrowserSettingsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_browser_settings(**kwargs)
  1. See ListBrowserSettingsRequestTypeDef

list_data_protection_settings#

Retrieves a list of data protection settings.

Type annotations and code completion for boto3.client("workspaces-web").list_data_protection_settings method. boto3 documentation

# list_data_protection_settings method definition

def list_data_protection_settings(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDataProtectionSettingsResponseTypeDef:  # (1)
    ...
  1. See ListDataProtectionSettingsResponseTypeDef 
# list_data_protection_settings method usage example with argument unpacking

kwargs: ListDataProtectionSettingsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_data_protection_settings(**kwargs)
  1. See ListDataProtectionSettingsRequestTypeDef

list_identity_providers#

Retrieves a list of identity providers for a specific web portal.

Type annotations and code completion for boto3.client("workspaces-web").list_identity_providers method. boto3 documentation

# list_identity_providers method definition

def list_identity_providers(
    self,
    *,
    portalArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIdentityProvidersResponseTypeDef:  # (1)
    ...
  1. See ListIdentityProvidersResponseTypeDef 
# list_identity_providers method usage example with argument unpacking

kwargs: ListIdentityProvidersRequestTypeDef = {  # (1)
    "portalArn": ...,
}

parent.list_identity_providers(**kwargs)
  1. See ListIdentityProvidersRequestTypeDef

list_ip_access_settings#

Retrieves a list of IP access settings.

Type annotations and code completion for boto3.client("workspaces-web").list_ip_access_settings method. boto3 documentation

# list_ip_access_settings method definition

def list_ip_access_settings(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIpAccessSettingsResponseTypeDef:  # (1)
    ...
  1. See ListIpAccessSettingsResponseTypeDef 
# list_ip_access_settings method usage example with argument unpacking

kwargs: ListIpAccessSettingsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_ip_access_settings(**kwargs)
  1. See ListIpAccessSettingsRequestTypeDef

list_network_settings#

Retrieves a list of network settings.

Type annotations and code completion for boto3.client("workspaces-web").list_network_settings method. boto3 documentation

# list_network_settings method definition

def list_network_settings(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListNetworkSettingsResponseTypeDef:  # (1)
    ...
  1. See ListNetworkSettingsResponseTypeDef 
# list_network_settings method usage example with argument unpacking

kwargs: ListNetworkSettingsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_network_settings(**kwargs)
  1. See ListNetworkSettingsRequestTypeDef

list_portals#

Retrieves a list or web portals.

Type annotations and code completion for boto3.client("workspaces-web").list_portals method. boto3 documentation

# list_portals method definition

def list_portals(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListPortalsResponseTypeDef:  # (1)
    ...
  1. See ListPortalsResponseTypeDef 
# list_portals method usage example with argument unpacking

kwargs: ListPortalsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_portals(**kwargs)
  1. See ListPortalsRequestTypeDef

list_sessions#

Lists information for multiple secure browser sessions from a specific portal.

Type annotations and code completion for boto3.client("workspaces-web").list_sessions method. boto3 documentation

# list_sessions method definition

def list_sessions(
    self,
    *,
    portalId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    sessionId: str = ...,
    sortBy: SessionSortByType = ...,  # (1)
    status: SessionStatusType = ...,  # (2)
    username: str = ...,
) -> ListSessionsResponseTypeDef:  # (3)
    ...
  1. See SessionSortByType
  2. See SessionStatusType
  3. See ListSessionsResponseTypeDef 
# list_sessions method usage example with argument unpacking

kwargs: ListSessionsRequestTypeDef = {  # (1)
    "portalId": ...,
}

parent.list_sessions(**kwargs)
  1. See ListSessionsRequestTypeDef

list_tags_for_resource#

Retrieves a list of tags for a resource.

Type annotations and code completion for boto3.client("workspaces-web").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

list_trust_store_certificates#

Retrieves a list of trust store certificates.

Type annotations and code completion for boto3.client("workspaces-web").list_trust_store_certificates method. boto3 documentation

# list_trust_store_certificates method definition

def list_trust_store_certificates(
    self,
    *,
    trustStoreArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTrustStoreCertificatesResponseTypeDef:  # (1)
    ...
  1. See ListTrustStoreCertificatesResponseTypeDef 
# list_trust_store_certificates method usage example with argument unpacking

kwargs: ListTrustStoreCertificatesRequestTypeDef = {  # (1)
    "trustStoreArn": ...,
}

parent.list_trust_store_certificates(**kwargs)
  1. See ListTrustStoreCertificatesRequestTypeDef

list_trust_stores#

Retrieves a list of trust stores.

Type annotations and code completion for boto3.client("workspaces-web").list_trust_stores method. boto3 documentation

# list_trust_stores method definition

def list_trust_stores(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTrustStoresResponseTypeDef:  # (1)
    ...
  1. See ListTrustStoresResponseTypeDef 
# list_trust_stores method usage example with argument unpacking

kwargs: ListTrustStoresRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_trust_stores(**kwargs)
  1. See ListTrustStoresRequestTypeDef

list_user_access_logging_settings#

Retrieves a list of user access logging settings.

Type annotations and code completion for boto3.client("workspaces-web").list_user_access_logging_settings method. boto3 documentation

# list_user_access_logging_settings method definition

def list_user_access_logging_settings(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListUserAccessLoggingSettingsResponseTypeDef:  # (1)
    ...
  1. See ListUserAccessLoggingSettingsResponseTypeDef 
# list_user_access_logging_settings method usage example with argument unpacking

kwargs: ListUserAccessLoggingSettingsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_user_access_logging_settings(**kwargs)
  1. See ListUserAccessLoggingSettingsRequestTypeDef

list_user_settings#

Retrieves a list of user settings.

Type annotations and code completion for boto3.client("workspaces-web").list_user_settings method. boto3 documentation

# list_user_settings method definition

def list_user_settings(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListUserSettingsResponseTypeDef:  # (1)
    ...
  1. See ListUserSettingsResponseTypeDef 
# list_user_settings method usage example with argument unpacking

kwargs: ListUserSettingsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_user_settings(**kwargs)
  1. See ListUserSettingsRequestTypeDef

tag_resource#

Adds or overwrites one or more tags for the specified resource.

Type annotations and code completion for boto3.client("workspaces-web").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes one or more tags from the specified resource.

Type annotations and code completion for boto3.client("workspaces-web").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_browser_settings#

Updates browser settings.

Type annotations and code completion for boto3.client("workspaces-web").update_browser_settings method. boto3 documentation

# update_browser_settings method definition

def update_browser_settings(
    self,
    *,
    browserSettingsArn: str,
    browserPolicy: str = ...,
    clientToken: str = ...,
) -> UpdateBrowserSettingsResponseTypeDef:  # (1)
    ...
  1. See UpdateBrowserSettingsResponseTypeDef 
# update_browser_settings method usage example with argument unpacking

kwargs: UpdateBrowserSettingsRequestTypeDef = {  # (1)
    "browserSettingsArn": ...,
}

parent.update_browser_settings(**kwargs)
  1. See UpdateBrowserSettingsRequestTypeDef

update_data_protection_settings#

Updates data protection settings.

Type annotations and code completion for boto3.client("workspaces-web").update_data_protection_settings method. boto3 documentation

# update_data_protection_settings method definition

def update_data_protection_settings(
    self,
    *,
    dataProtectionSettingsArn: str,
    clientToken: str = ...,
    description: str = ...,
    displayName: str = ...,
    inlineRedactionConfiguration: InlineRedactionConfigurationUnionTypeDef = ...,  # (1)
) -> UpdateDataProtectionSettingsResponseTypeDef:  # (2)
    ...
  1. See InlineRedactionConfigurationTypeDef InlineRedactionConfigurationOutputTypeDef
  2. See UpdateDataProtectionSettingsResponseTypeDef 
# update_data_protection_settings method usage example with argument unpacking

kwargs: UpdateDataProtectionSettingsRequestTypeDef = {  # (1)
    "dataProtectionSettingsArn": ...,
}

parent.update_data_protection_settings(**kwargs)
  1. See UpdateDataProtectionSettingsRequestTypeDef

update_identity_provider#

Updates the identity provider.

Type annotations and code completion for boto3.client("workspaces-web").update_identity_provider method. boto3 documentation

# update_identity_provider method definition

def update_identity_provider(
    self,
    *,
    identityProviderArn: str,
    clientToken: str = ...,
    identityProviderDetails: Mapping[str, str] = ...,
    identityProviderName: str = ...,
    identityProviderType: IdentityProviderTypeType = ...,  # (1)
) -> UpdateIdentityProviderResponseTypeDef:  # (2)
    ...
  1. See IdentityProviderTypeType
  2. See UpdateIdentityProviderResponseTypeDef 
# update_identity_provider method usage example with argument unpacking

kwargs: UpdateIdentityProviderRequestTypeDef = {  # (1)
    "identityProviderArn": ...,
}

parent.update_identity_provider(**kwargs)
  1. See UpdateIdentityProviderRequestTypeDef

update_ip_access_settings#

Updates IP access settings.

Type annotations and code completion for boto3.client("workspaces-web").update_ip_access_settings method. boto3 documentation

# update_ip_access_settings method definition

def update_ip_access_settings(
    self,
    *,
    ipAccessSettingsArn: str,
    clientToken: str = ...,
    description: str = ...,
    displayName: str = ...,
    ipRules: Sequence[IpRuleTypeDef] = ...,  # (1)
) -> UpdateIpAccessSettingsResponseTypeDef:  # (2)
    ...
  1. See IpRuleTypeDef
  2. See UpdateIpAccessSettingsResponseTypeDef 
# update_ip_access_settings method usage example with argument unpacking

kwargs: UpdateIpAccessSettingsRequestTypeDef = {  # (1)
    "ipAccessSettingsArn": ...,
}

parent.update_ip_access_settings(**kwargs)
  1. See UpdateIpAccessSettingsRequestTypeDef

update_network_settings#

Updates network settings.

Type annotations and code completion for boto3.client("workspaces-web").update_network_settings method. boto3 documentation

# update_network_settings method definition

def update_network_settings(
    self,
    *,
    networkSettingsArn: str,
    clientToken: str = ...,
    securityGroupIds: Sequence[str] = ...,
    subnetIds: Sequence[str] = ...,
    vpcId: str = ...,
) -> UpdateNetworkSettingsResponseTypeDef:  # (1)
    ...
  1. See UpdateNetworkSettingsResponseTypeDef 
# update_network_settings method usage example with argument unpacking

kwargs: UpdateNetworkSettingsRequestTypeDef = {  # (1)
    "networkSettingsArn": ...,
}

parent.update_network_settings(**kwargs)
  1. See UpdateNetworkSettingsRequestTypeDef

update_portal#

Updates a web portal.

Type annotations and code completion for boto3.client("workspaces-web").update_portal method. boto3 documentation

# update_portal method definition

def update_portal(
    self,
    *,
    portalArn: str,
    authenticationType: AuthenticationTypeType = ...,  # (1)
    displayName: str = ...,
    instanceType: InstanceTypeType = ...,  # (2)
    maxConcurrentSessions: int = ...,
) -> UpdatePortalResponseTypeDef:  # (3)
    ...
  1. See AuthenticationTypeType
  2. See InstanceTypeType
  3. See UpdatePortalResponseTypeDef 
# update_portal method usage example with argument unpacking

kwargs: UpdatePortalRequestTypeDef = {  # (1)
    "portalArn": ...,
}

parent.update_portal(**kwargs)
  1. See UpdatePortalRequestTypeDef

update_trust_store#

Updates the trust store.

Type annotations and code completion for boto3.client("workspaces-web").update_trust_store method. boto3 documentation

# update_trust_store method definition

def update_trust_store(
    self,
    *,
    trustStoreArn: str,
    certificatesToAdd: Sequence[BlobTypeDef] = ...,
    certificatesToDelete: Sequence[str] = ...,
    clientToken: str = ...,
) -> UpdateTrustStoreResponseTypeDef:  # (1)
    ...
  1. See UpdateTrustStoreResponseTypeDef 
# update_trust_store method usage example with argument unpacking

kwargs: UpdateTrustStoreRequestTypeDef = {  # (1)
    "trustStoreArn": ...,
}

parent.update_trust_store(**kwargs)
  1. See UpdateTrustStoreRequestTypeDef

update_user_access_logging_settings#

Updates the user access logging settings.

Type annotations and code completion for boto3.client("workspaces-web").update_user_access_logging_settings method. boto3 documentation

# update_user_access_logging_settings method definition

def update_user_access_logging_settings(
    self,
    *,
    userAccessLoggingSettingsArn: str,
    clientToken: str = ...,
    kinesisStreamArn: str = ...,
) -> UpdateUserAccessLoggingSettingsResponseTypeDef:  # (1)
    ...
  1. See UpdateUserAccessLoggingSettingsResponseTypeDef 
# update_user_access_logging_settings method usage example with argument unpacking

kwargs: UpdateUserAccessLoggingSettingsRequestTypeDef = {  # (1)
    "userAccessLoggingSettingsArn": ...,
}

parent.update_user_access_logging_settings(**kwargs)
  1. See UpdateUserAccessLoggingSettingsRequestTypeDef

update_user_settings#

Updates the user settings.

Type annotations and code completion for boto3.client("workspaces-web").update_user_settings method. boto3 documentation

# update_user_settings method definition

def update_user_settings(
    self,
    *,
    userSettingsArn: str,
    clientToken: str = ...,
    cookieSynchronizationConfiguration: CookieSynchronizationConfigurationUnionTypeDef = ...,  # (1)
    copyAllowed: EnabledTypeType = ...,  # (2)
    deepLinkAllowed: EnabledTypeType = ...,  # (2)
    disconnectTimeoutInMinutes: int = ...,
    downloadAllowed: EnabledTypeType = ...,  # (2)
    idleDisconnectTimeoutInMinutes: int = ...,
    pasteAllowed: EnabledTypeType = ...,  # (2)
    printAllowed: EnabledTypeType = ...,  # (2)
    toolbarConfiguration: ToolbarConfigurationUnionTypeDef = ...,  # (7)
    uploadAllowed: EnabledTypeType = ...,  # (2)
) -> UpdateUserSettingsResponseTypeDef:  # (9)
    ...
  1. See CookieSynchronizationConfigurationTypeDef CookieSynchronizationConfigurationOutputTypeDef
  2. See EnabledTypeType
  3. See EnabledTypeType
  4. See EnabledTypeType
  5. See EnabledTypeType
  6. See EnabledTypeType
  7. See ToolbarConfigurationTypeDef ToolbarConfigurationOutputTypeDef
  8. See EnabledTypeType
  9. See UpdateUserSettingsResponseTypeDef 
# update_user_settings method usage example with argument unpacking

kwargs: UpdateUserSettingsRequestTypeDef = {  # (1)
    "userSettingsArn": ...,
}

parent.update_user_settings(**kwargs)
  1. See UpdateUserSettingsRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("workspaces-web").get_paginator method with overloads.