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#
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)
...
# associate_browser_settings method usage example with argument unpacking
kwargs: AssociateBrowserSettingsRequestRequestTypeDef = { # (1)
"browserSettingsArn": ...,
"portalArn": ...,
}
parent.associate_browser_settings(**kwargs)
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)
...
# associate_ip_access_settings method usage example with argument unpacking
kwargs: AssociateIpAccessSettingsRequestRequestTypeDef = { # (1)
"ipAccessSettingsArn": ...,
"portalArn": ...,
}
parent.associate_ip_access_settings(**kwargs)
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)
...
# associate_network_settings method usage example with argument unpacking
kwargs: AssociateNetworkSettingsRequestRequestTypeDef = { # (1)
"networkSettingsArn": ...,
"portalArn": ...,
}
parent.associate_network_settings(**kwargs)
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)
...
# associate_trust_store method usage example with argument unpacking
kwargs: AssociateTrustStoreRequestRequestTypeDef = { # (1)
"portalArn": ...,
"trustStoreArn": ...,
}
parent.associate_trust_store(**kwargs)
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)
...
# associate_user_access_logging_settings method usage example with argument unpacking
kwargs: AssociateUserAccessLoggingSettingsRequestRequestTypeDef = { # (1)
"portalArn": ...,
"userAccessLoggingSettingsArn": ...,
}
parent.associate_user_access_logging_settings(**kwargs)
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)
...
# associate_user_settings method usage example with argument unpacking
kwargs: AssociateUserSettingsRequestRequestTypeDef = { # (1)
"portalArn": ...,
"userSettingsArn": ...,
}
parent.associate_user_settings(**kwargs)
can_paginate#
Check if an operation can be paginated.
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:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("workspaces-web").close
method.
boto3 documentation
# close 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
# 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)
...
# create_browser_settings method usage example with argument unpacking
kwargs: CreateBrowserSettingsRequestRequestTypeDef = { # (1)
"browserPolicy": ...,
}
parent.create_browser_settings(**kwargs)
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 = ...,
) -> CreateIdentityProviderResponseTypeDef: # (2)
...
# create_identity_provider method usage example with argument unpacking
kwargs: CreateIdentityProviderRequestRequestTypeDef = { # (1)
"identityProviderDetails": ...,
"identityProviderName": ...,
"identityProviderType": ...,
"portalArn": ...,
}
parent.create_identity_provider(**kwargs)
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)
...
# create_ip_access_settings method usage example with argument unpacking
kwargs: CreateIpAccessSettingsRequestRequestTypeDef = { # (1)
"ipRules": ...,
}
parent.create_ip_access_settings(**kwargs)
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)
...
# create_network_settings method usage example with argument unpacking
kwargs: CreateNetworkSettingsRequestRequestTypeDef = { # (1)
"securityGroupIds": ...,
"subnetIds": ...,
"vpcId": ...,
}
parent.create_network_settings(**kwargs)
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 = ...,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreatePortalResponseTypeDef: # (3)
...
# create_portal method usage example with argument unpacking
kwargs: CreatePortalRequestRequestTypeDef = { # (1)
"additionalEncryptionContext": ...,
}
parent.create_portal(**kwargs)
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[Union[str, bytes, IO[Any], StreamingBody]],
clientToken: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateTrustStoreResponseTypeDef: # (2)
...
# create_trust_store method usage example with argument unpacking
kwargs: CreateTrustStoreRequestRequestTypeDef = { # (1)
"certificateList": ...,
}
parent.create_trust_store(**kwargs)
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)
...
# create_user_access_logging_settings method usage example with argument unpacking
kwargs: CreateUserAccessLoggingSettingsRequestRequestTypeDef = { # (1)
"kinesisStreamArn": ...,
}
parent.create_user_access_logging_settings(**kwargs)