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

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.

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

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.TooManyTagsException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_workspaces_web.client import Exceptions

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

Methods

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

Method definition
def associate_browser_settings(
    self,
    *,
    browserSettingsArn: str,
    portalArn: str,
) -> AssociateBrowserSettingsResponseTypeDef:  # (1)
    ...
  1. See AssociateBrowserSettingsResponseTypeDef
Usage example with kwargs
kwargs: AssociateBrowserSettingsRequestRequestTypeDef = {  # (1)
    "browserSettingsArn": ...,
    "portalArn": ...,
}

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

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

Method definition
def associate_network_settings(
    self,
    *,
    networkSettingsArn: str,
    portalArn: str,
) -> AssociateNetworkSettingsResponseTypeDef:  # (1)
    ...
  1. See AssociateNetworkSettingsResponseTypeDef
Usage example with kwargs
kwargs: AssociateNetworkSettingsRequestRequestTypeDef = {  # (1)
    "networkSettingsArn": ...,
    "portalArn": ...,
}

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

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

Method definition
def associate_trust_store(
    self,
    *,
    portalArn: str,
    trustStoreArn: str,
) -> AssociateTrustStoreResponseTypeDef:  # (1)
    ...
  1. See AssociateTrustStoreResponseTypeDef
Usage example with kwargs
kwargs: AssociateTrustStoreRequestRequestTypeDef = {  # (1)
    "portalArn": ...,
    "trustStoreArn": ...,
}

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

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

Method definition
def associate_user_settings(
    self,
    *,
    portalArn: str,
    userSettingsArn: str,
) -> AssociateUserSettingsResponseTypeDef:  # (1)
    ...
  1. See AssociateUserSettingsResponseTypeDef
Usage example with kwargs
kwargs: AssociateUserSettingsRequestRequestTypeDef = {  # (1)
    "portalArn": ...,
    "userSettingsArn": ...,
}

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

can_paginate

Check if an operation can be paginated.

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

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

close

Closes underlying endpoint connections.

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

Method definition
def close(
    self,
) -> None:
    ...

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

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
Usage example with kwargs
kwargs: CreateBrowserSettingsRequestRequestTypeDef = {  # (1)
    "browserPolicy": ...,
}

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

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

Method definition
def create_identity_provider(
    self,
    *,
    identityProviderDetails: Mapping[str, str],
    identityProviderName: str,
    identityProviderType: IdentityProviderTypeType,  # (1)
    portalArn: str,
    clientToken: str = ...,
) -> CreateIdentityProviderResponseTypeDef:  # (2)
    ...
  1. See IdentityProviderTypeType
  2. See CreateIdentityProviderResponseTypeDef
Usage example with kwargs
kwargs: CreateIdentityProviderRequestRequestTypeDef = {  # (1)
    "identityProviderDetails": ...,
    "identityProviderName": ...,
    "identityProviderType": ...,
    "portalArn": ...,
}

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

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

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
Usage example with kwargs
kwargs: CreateNetworkSettingsRequestRequestTypeDef = {  # (1)
    "securityGroupIds": ...,
    "subnetIds": ...,
    "vpcId": ...,
}

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

create_portal

Creates a web portal.

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

Method definition
def create_portal(
    self,
    *,
    additionalEncryptionContext: Mapping[str, str] = ...,
    clientToken: str = ...,
    customerManagedKey: str = ...,
    displayName: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreatePortalResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreatePortalResponseTypeDef
Usage example with kwargs
kwargs: CreatePortalRequestRequestTypeDef = {  # (1)
    "additionalEncryptionContext": ...,
}

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

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

Method definition
def create_trust_store(
    self,
    *,
    certificateList: Sequence[Union[str, bytes, IO[Any], StreamingBody]],
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateTrustStoreResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateTrustStoreResponseTypeDef
Usage example with kwargs
kwargs: CreateTrustStoreRequestRequestTypeDef = {  # (1)
    "certificateList": ...,
}

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

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

Method definition
def create_user_settings(
    self,
    *,
    copyAllowed: EnabledTypeType,  # (1)
    downloadAllowed: EnabledTypeType,  # (1)
    pasteAllowed: EnabledTypeType,  # (1)
    printAllowed: EnabledTypeType,  # (1)
    uploadAllowed: EnabledTypeType,  # (1)
    clientToken: str = ...,
    disconnectTimeoutInMinutes: int = ...,
    idleDisconnectTimeoutInMinutes: int = ...,
    tags: Sequence[TagTypeDef] = ...,  # (6)
) -> CreateUserSettingsResponseTypeDef:  # (7)
    ...
  1. See EnabledTypeType
  2. See EnabledTypeType
  3. See EnabledTypeType
  4. See EnabledTypeType
  5. See EnabledTypeType
  6. See TagTypeDef
  7. See CreateUserSettingsResponseTypeDef
Usage example with kwargs
kwargs: CreateUserSettingsRequestRequestTypeDef = {  # (1)
    "copyAllowed": ...,
    "downloadAllowed": ...,
    "pasteAllowed": ...,
    "printAllowed": ...,
    "uploadAllowed": ...,
}

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

delete_browser_settings

Deletes browser settings.

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

Method definition
def delete_browser_settings(
    self,
    *,
    browserSettingsArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteBrowserSettingsRequestRequestTypeDef = {  # (1)
    "browserSettingsArn": ...,
}

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

delete_identity_provider

Deletes the identity provider.

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

Method definition
def delete_identity_provider(
    self,
    *,
    identityProviderArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteIdentityProviderRequestRequestTypeDef = {  # (1)
    "identityProviderArn": ...,
}

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

delete_network_settings

Deletes network settings.

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

Method definition
def delete_network_settings(
    self,
    *,
    networkSettingsArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteNetworkSettingsRequestRequestTypeDef = {  # (1)
    "networkSettingsArn": ...,
}

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

delete_portal

Deletes a web portal.

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

Method definition
def delete_portal(
    self,
    *,
    portalArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeletePortalRequestRequestTypeDef = {  # (1)
    "portalArn": ...,
}

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

delete_trust_store

Deletes the trust store.

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

Method definition
def delete_trust_store(
    self,
    *,
    trustStoreArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteTrustStoreRequestRequestTypeDef = {  # (1)
    "trustStoreArn": ...,
}

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

delete_user_settings

Deletes user settings.

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

Method definition
def delete_user_settings(
    self,
    *,
    userSettingsArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteUserSettingsRequestRequestTypeDef = {  # (1)
    "userSettingsArn": ...,
}

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

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

Method definition
def disassociate_browser_settings(
    self,
    *,
    portalArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateBrowserSettingsRequestRequestTypeDef = {  # (1)
    "portalArn": ...,
}

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

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

Method definition
def disassociate_network_settings(
    self,
    *,
    portalArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateNetworkSettingsRequestRequestTypeDef = {  # (1)
    "portalArn": ...,
}

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

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

Method definition
def disassociate_trust_store(
    self,
    *,
    portalArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateTrustStoreRequestRequestTypeDef = {  # (1)
    "portalArn": ...,
}

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

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

Method definition
def disassociate_user_settings(
    self,
    *,
    portalArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateUserSettingsRequestRequestTypeDef = {  # (1)
    "portalArn": ...,
}

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

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

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

get_browser_settings

Gets browser settings.

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

Method definition
def get_browser_settings(
    self,
    *,
    browserSettingsArn: str,
) -> GetBrowserSettingsResponseTypeDef:  # (1)
    ...
  1. See GetBrowserSettingsResponseTypeDef
Usage example with kwargs
kwargs: GetBrowserSettingsRequestRequestTypeDef = {  # (1)
    "browserSettingsArn": ...,
}

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

get_identity_provider

Gets the identity provider.

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

Method definition
def get_identity_provider(
    self,
    *,
    identityProviderArn: str,
) -> GetIdentityProviderResponseTypeDef:  # (1)
    ...
  1. See GetIdentityProviderResponseTypeDef
Usage example with kwargs
kwargs: GetIdentityProviderRequestRequestTypeDef = {  # (1)
    "identityProviderArn": ...,
}

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

get_network_settings

Gets the network settings.

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

Method definition
def get_network_settings(
    self,
    *,
    networkSettingsArn: str,
) -> GetNetworkSettingsResponseTypeDef:  # (1)
    ...
  1. See GetNetworkSettingsResponseTypeDef
Usage example with kwargs
kwargs: GetNetworkSettingsRequestRequestTypeDef = {  # (1)
    "networkSettingsArn": ...,
}

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

get_portal

Gets the web portal.

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

Method definition
def get_portal(
    self,
    *,
    portalArn: str,
) -> GetPortalResponseTypeDef:  # (1)
    ...
  1. See GetPortalResponseTypeDef
Usage example with kwargs
kwargs: GetPortalRequestRequestTypeDef = {  # (1)
    "portalArn": ...,
}

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

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

Method definition
def get_portal_service_provider_metadata(
    self,
    *,
    portalArn: str,
) -> GetPortalServiceProviderMetadataResponseTypeDef:  # (1)
    ...
  1. See GetPortalServiceProviderMetadataResponseTypeDef
Usage example with kwargs
kwargs: GetPortalServiceProviderMetadataRequestRequestTypeDef = {  # (1)
    "portalArn": ...,
}

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

get_trust_store

Gets the trust store.

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

Method definition
def get_trust_store(
    self,
    *,
    trustStoreArn: str,
) -> GetTrustStoreResponseTypeDef:  # (1)
    ...
  1. See GetTrustStoreResponseTypeDef
Usage example with kwargs
kwargs: GetTrustStoreRequestRequestTypeDef = {  # (1)
    "trustStoreArn": ...,
}

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

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

Method definition
def get_trust_store_certificate(
    self,
    *,
    thumbprint: str,
    trustStoreArn: str,
) -> GetTrustStoreCertificateResponseTypeDef:  # (1)
    ...
  1. See GetTrustStoreCertificateResponseTypeDef
Usage example with kwargs
kwargs: GetTrustStoreCertificateRequestRequestTypeDef = {  # (1)
    "thumbprint": ...,
    "trustStoreArn": ...,
}

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

get_user_settings

Gets user settings.

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

Method definition
def get_user_settings(
    self,
    *,
    userSettingsArn: str,
) -> GetUserSettingsResponseTypeDef:  # (1)
    ...
  1. See GetUserSettingsResponseTypeDef
Usage example with kwargs
kwargs: GetUserSettingsRequestRequestTypeDef = {  # (1)
    "userSettingsArn": ...,
}

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

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

Method definition
def list_browser_settings(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBrowserSettingsResponseTypeDef:  # (1)
    ...
  1. See ListBrowserSettingsResponseTypeDef
Usage example with kwargs
kwargs: ListBrowserSettingsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

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

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

Method definition
def list_identity_providers(
    self,
    *,
    portalArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIdentityProvidersResponseTypeDef:  # (1)
    ...
  1. See ListIdentityProvidersResponseTypeDef
Usage example with kwargs
kwargs: ListIdentityProvidersRequestRequestTypeDef = {  # (1)
    "portalArn": ...,
}

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

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

Method definition
def list_network_settings(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListNetworkSettingsResponseTypeDef:  # (1)
    ...
  1. See ListNetworkSettingsResponseTypeDef
Usage example with kwargs
kwargs: ListNetworkSettingsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

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

list_portals

Retrieves a list or web portals.

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

Method definition
def list_portals(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListPortalsResponseTypeDef:  # (1)
    ...
  1. See ListPortalsResponseTypeDef
Usage example with kwargs
kwargs: ListPortalsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

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

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

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

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

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

Method definition
def list_trust_store_certificates(
    self,
    *,
    trustStoreArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTrustStoreCertificatesResponseTypeDef:  # (1)
    ...
  1. See ListTrustStoreCertificatesResponseTypeDef
Usage example with kwargs
kwargs: ListTrustStoreCertificatesRequestRequestTypeDef = {  # (1)
    "trustStoreArn": ...,
}

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

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

Method definition
def list_trust_stores(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTrustStoresResponseTypeDef:  # (1)
    ...
  1. See ListTrustStoresResponseTypeDef
Usage example with kwargs
kwargs: ListTrustStoresRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

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

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

Method definition
def list_user_settings(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListUserSettingsResponseTypeDef:  # (1)
    ...
  1. See ListUserSettingsResponseTypeDef
Usage example with kwargs
kwargs: ListUserSettingsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

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

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

Method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

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

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

Method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

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

update_browser_settings

Updates browser settings.

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

Method definition
def update_browser_settings(
    self,
    *,
    browserSettingsArn: str,
    browserPolicy: str = ...,
    clientToken: str = ...,
) -> UpdateBrowserSettingsResponseTypeDef:  # (1)
    ...
  1. See UpdateBrowserSettingsResponseTypeDef
Usage example with kwargs
kwargs: UpdateBrowserSettingsRequestRequestTypeDef = {  # (1)
    "browserSettingsArn": ...,
}

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

update_identity_provider

Updates the identity provider.

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

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
Usage example with kwargs
kwargs: UpdateIdentityProviderRequestRequestTypeDef = {  # (1)
    "identityProviderArn": ...,
}

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

update_network_settings

Updates network settings.

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

Method definition
def update_network_settings(
    self,
    *,
    networkSettingsArn: str,
    clientToken: str = ...,
    securityGroupIds: Sequence[str] = ...,
    subnetIds: Sequence[str] = ...,
    vpcId: str = ...,
) -> UpdateNetworkSettingsResponseTypeDef:  # (1)
    ...
  1. See UpdateNetworkSettingsResponseTypeDef
Usage example with kwargs
kwargs: UpdateNetworkSettingsRequestRequestTypeDef = {  # (1)
    "networkSettingsArn": ...,
}

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

update_portal

Updates a web portal.

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

Method definition
def update_portal(
    self,
    *,
    portalArn: str,
    displayName: str = ...,
) -> UpdatePortalResponseTypeDef:  # (1)
    ...
  1. See UpdatePortalResponseTypeDef
Usage example with kwargs
kwargs: UpdatePortalRequestRequestTypeDef = {  # (1)
    "portalArn": ...,
}

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

update_trust_store

Updates the trust store.

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

Method definition
def update_trust_store(
    self,
    *,
    trustStoreArn: str,
    certificatesToAdd: Sequence[Union[str, bytes, IO[Any], StreamingBody]] = ...,
    certificatesToDelete: Sequence[str] = ...,
    clientToken: str = ...,
) -> UpdateTrustStoreResponseTypeDef:  # (1)
    ...
  1. See UpdateTrustStoreResponseTypeDef
Usage example with kwargs
kwargs: UpdateTrustStoreRequestRequestTypeDef = {  # (1)
    "trustStoreArn": ...,
}

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

update_user_settings

Updates the user settings.

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

Method definition
def update_user_settings(
    self,
    *,
    userSettingsArn: str,
    clientToken: str = ...,
    copyAllowed: EnabledTypeType = ...,  # (1)
    disconnectTimeoutInMinutes: int = ...,
    downloadAllowed: EnabledTypeType = ...,  # (1)
    idleDisconnectTimeoutInMinutes: int = ...,
    pasteAllowed: EnabledTypeType = ...,  # (1)
    printAllowed: EnabledTypeType = ...,  # (1)
    uploadAllowed: EnabledTypeType = ...,  # (1)
) -> UpdateUserSettingsResponseTypeDef:  # (6)
    ...
  1. See EnabledTypeType
  2. See EnabledTypeType
  3. See EnabledTypeType
  4. See EnabledTypeType
  5. See EnabledTypeType
  6. See UpdateUserSettingsResponseTypeDef
Usage example with kwargs
kwargs: UpdateUserSettingsRequestRequestTypeDef = {  # (1)
    "userSettingsArn": ...,
}

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