Type definitions#
Index > WorkSpacesWeb > Type definitions
Auto-generated documentation for WorkSpacesWeb type annotations stubs module mypy-boto3-workspaces-web.
BlobTypeDef#
# BlobTypeDef Union usage example
from mypy_boto3_workspaces_web.type_defs import BlobTypeDef
def get_value() -> BlobTypeDef:
return ...
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
botocore.response.StreamingBody,
]ToolbarConfigurationUnionTypeDef#
# ToolbarConfigurationUnionTypeDef Union usage example
from mypy_boto3_workspaces_web.type_defs import ToolbarConfigurationUnionTypeDef
def get_value() -> ToolbarConfigurationUnionTypeDef:
return ...
# ToolbarConfigurationUnionTypeDef definition
ToolbarConfigurationUnionTypeDef = Union[
ToolbarConfigurationTypeDef, # (1)
ToolbarConfigurationOutputTypeDef, # (2)
]CookieSynchronizationConfigurationUnionTypeDef#
# CookieSynchronizationConfigurationUnionTypeDef Union usage example
from mypy_boto3_workspaces_web.type_defs import CookieSynchronizationConfigurationUnionTypeDef
def get_value() -> CookieSynchronizationConfigurationUnionTypeDef:
return ...
# CookieSynchronizationConfigurationUnionTypeDef definition
CookieSynchronizationConfigurationUnionTypeDef = Union[
CookieSynchronizationConfigurationTypeDef, # (1)
CookieSynchronizationConfigurationOutputTypeDef, # (2)
]InlineRedactionConfigurationUnionTypeDef#
# InlineRedactionConfigurationUnionTypeDef Union usage example
from mypy_boto3_workspaces_web.type_defs import InlineRedactionConfigurationUnionTypeDef
def get_value() -> InlineRedactionConfigurationUnionTypeDef:
return ...
# InlineRedactionConfigurationUnionTypeDef definition
InlineRedactionConfigurationUnionTypeDef = Union[
InlineRedactionConfigurationTypeDef, # (1)
InlineRedactionConfigurationOutputTypeDef, # (2)
]AssociateBrowserSettingsRequestTypeDef#
# AssociateBrowserSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import AssociateBrowserSettingsRequestTypeDef
def get_value() -> AssociateBrowserSettingsRequestTypeDef:
return {
"browserSettingsArn": ...,
}
# AssociateBrowserSettingsRequestTypeDef definition
class AssociateBrowserSettingsRequestTypeDef(TypedDict):
browserSettingsArn: str,
portalArn: str,ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],AssociateDataProtectionSettingsRequestTypeDef#
# AssociateDataProtectionSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import AssociateDataProtectionSettingsRequestTypeDef
def get_value() -> AssociateDataProtectionSettingsRequestTypeDef:
return {
"dataProtectionSettingsArn": ...,
}
# AssociateDataProtectionSettingsRequestTypeDef definition
class AssociateDataProtectionSettingsRequestTypeDef(TypedDict):
dataProtectionSettingsArn: str,
portalArn: str,AssociateIpAccessSettingsRequestTypeDef#
# AssociateIpAccessSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import AssociateIpAccessSettingsRequestTypeDef
def get_value() -> AssociateIpAccessSettingsRequestTypeDef:
return {
"ipAccessSettingsArn": ...,
}
# AssociateIpAccessSettingsRequestTypeDef definition
class AssociateIpAccessSettingsRequestTypeDef(TypedDict):
ipAccessSettingsArn: str,
portalArn: str,AssociateNetworkSettingsRequestTypeDef#
# AssociateNetworkSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import AssociateNetworkSettingsRequestTypeDef
def get_value() -> AssociateNetworkSettingsRequestTypeDef:
return {
"networkSettingsArn": ...,
}
# AssociateNetworkSettingsRequestTypeDef definition
class AssociateNetworkSettingsRequestTypeDef(TypedDict):
networkSettingsArn: str,
portalArn: str,AssociateTrustStoreRequestTypeDef#
# AssociateTrustStoreRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import AssociateTrustStoreRequestTypeDef
def get_value() -> AssociateTrustStoreRequestTypeDef:
return {
"portalArn": ...,
}
# AssociateTrustStoreRequestTypeDef definition
class AssociateTrustStoreRequestTypeDef(TypedDict):
portalArn: str,
trustStoreArn: str,AssociateUserAccessLoggingSettingsRequestTypeDef#
# AssociateUserAccessLoggingSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import AssociateUserAccessLoggingSettingsRequestTypeDef
def get_value() -> AssociateUserAccessLoggingSettingsRequestTypeDef:
return {
"portalArn": ...,
}
# AssociateUserAccessLoggingSettingsRequestTypeDef definition
class AssociateUserAccessLoggingSettingsRequestTypeDef(TypedDict):
portalArn: str,
userAccessLoggingSettingsArn: str,AssociateUserSettingsRequestTypeDef#
# AssociateUserSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import AssociateUserSettingsRequestTypeDef
def get_value() -> AssociateUserSettingsRequestTypeDef:
return {
"portalArn": ...,
}
# AssociateUserSettingsRequestTypeDef definition
class AssociateUserSettingsRequestTypeDef(TypedDict):
portalArn: str,
userSettingsArn: str,BrowserSettingsSummaryTypeDef#
# BrowserSettingsSummaryTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import BrowserSettingsSummaryTypeDef
def get_value() -> BrowserSettingsSummaryTypeDef:
return {
"browserSettingsArn": ...,
}
# BrowserSettingsSummaryTypeDef definition
class BrowserSettingsSummaryTypeDef(TypedDict):
browserSettingsArn: str,BrowserSettingsTypeDef#
# BrowserSettingsTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import BrowserSettingsTypeDef
def get_value() -> BrowserSettingsTypeDef:
return {
"additionalEncryptionContext": ...,
}
# BrowserSettingsTypeDef definition
class BrowserSettingsTypeDef(TypedDict):
browserSettingsArn: str,
additionalEncryptionContext: NotRequired[Dict[str, str]],
associatedPortalArns: NotRequired[List[str]],
browserPolicy: NotRequired[str],
customerManagedKey: NotRequired[str],CertificateSummaryTypeDef#
# CertificateSummaryTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CertificateSummaryTypeDef
def get_value() -> CertificateSummaryTypeDef:
return {
"issuer": ...,
}
# CertificateSummaryTypeDef definition
class CertificateSummaryTypeDef(TypedDict):
issuer: NotRequired[str],
notValidAfter: NotRequired[datetime.datetime],
notValidBefore: NotRequired[datetime.datetime],
subject: NotRequired[str],
thumbprint: NotRequired[str],CertificateTypeDef#
# CertificateTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CertificateTypeDef
def get_value() -> CertificateTypeDef:
return {
"body": ...,
}
# CertificateTypeDef definition
class CertificateTypeDef(TypedDict):
body: NotRequired[bytes],
issuer: NotRequired[str],
notValidAfter: NotRequired[datetime.datetime],
notValidBefore: NotRequired[datetime.datetime],
subject: NotRequired[str],
thumbprint: NotRequired[str],CookieSpecificationTypeDef#
# CookieSpecificationTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CookieSpecificationTypeDef
def get_value() -> CookieSpecificationTypeDef:
return {
"domain": ...,
}
# CookieSpecificationTypeDef definition
class CookieSpecificationTypeDef(TypedDict):
domain: str,
name: NotRequired[str],
path: NotRequired[str],TagTypeDef#
# TagTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,IpRuleTypeDef#
# IpRuleTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import IpRuleTypeDef
def get_value() -> IpRuleTypeDef:
return {
"description": ...,
}
# IpRuleTypeDef definition
class IpRuleTypeDef(TypedDict):
ipRange: str,
description: NotRequired[str],CustomPatternTypeDef#
# CustomPatternTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CustomPatternTypeDef
def get_value() -> CustomPatternTypeDef:
return {
"keywordRegex": ...,
}
# CustomPatternTypeDef definition
class CustomPatternTypeDef(TypedDict):
patternName: str,
patternRegex: str,
keywordRegex: NotRequired[str],
patternDescription: NotRequired[str],DataProtectionSettingsSummaryTypeDef#
# DataProtectionSettingsSummaryTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DataProtectionSettingsSummaryTypeDef
def get_value() -> DataProtectionSettingsSummaryTypeDef:
return {
"creationDate": ...,
}
# DataProtectionSettingsSummaryTypeDef definition
class DataProtectionSettingsSummaryTypeDef(TypedDict):
dataProtectionSettingsArn: str,
creationDate: NotRequired[datetime.datetime],
description: NotRequired[str],
displayName: NotRequired[str],DeleteBrowserSettingsRequestTypeDef#
# DeleteBrowserSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DeleteBrowserSettingsRequestTypeDef
def get_value() -> DeleteBrowserSettingsRequestTypeDef:
return {
"browserSettingsArn": ...,
}
# DeleteBrowserSettingsRequestTypeDef definition
class DeleteBrowserSettingsRequestTypeDef(TypedDict):
browserSettingsArn: str,DeleteDataProtectionSettingsRequestTypeDef#
# DeleteDataProtectionSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DeleteDataProtectionSettingsRequestTypeDef
def get_value() -> DeleteDataProtectionSettingsRequestTypeDef:
return {
"dataProtectionSettingsArn": ...,
}
# DeleteDataProtectionSettingsRequestTypeDef definition
class DeleteDataProtectionSettingsRequestTypeDef(TypedDict):
dataProtectionSettingsArn: str,DeleteIdentityProviderRequestTypeDef#
# DeleteIdentityProviderRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DeleteIdentityProviderRequestTypeDef
def get_value() -> DeleteIdentityProviderRequestTypeDef:
return {
"identityProviderArn": ...,
}
# DeleteIdentityProviderRequestTypeDef definition
class DeleteIdentityProviderRequestTypeDef(TypedDict):
identityProviderArn: str,DeleteIpAccessSettingsRequestTypeDef#
# DeleteIpAccessSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DeleteIpAccessSettingsRequestTypeDef
def get_value() -> DeleteIpAccessSettingsRequestTypeDef:
return {
"ipAccessSettingsArn": ...,
}
# DeleteIpAccessSettingsRequestTypeDef definition
class DeleteIpAccessSettingsRequestTypeDef(TypedDict):
ipAccessSettingsArn: str,DeleteNetworkSettingsRequestTypeDef#
# DeleteNetworkSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DeleteNetworkSettingsRequestTypeDef
def get_value() -> DeleteNetworkSettingsRequestTypeDef:
return {
"networkSettingsArn": ...,
}
# DeleteNetworkSettingsRequestTypeDef definition
class DeleteNetworkSettingsRequestTypeDef(TypedDict):
networkSettingsArn: str,DeletePortalRequestTypeDef#
# DeletePortalRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DeletePortalRequestTypeDef
def get_value() -> DeletePortalRequestTypeDef:
return {
"portalArn": ...,
}
# DeletePortalRequestTypeDef definition
class DeletePortalRequestTypeDef(TypedDict):
portalArn: str,DeleteTrustStoreRequestTypeDef#
# DeleteTrustStoreRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DeleteTrustStoreRequestTypeDef
def get_value() -> DeleteTrustStoreRequestTypeDef:
return {
"trustStoreArn": ...,
}
# DeleteTrustStoreRequestTypeDef definition
class DeleteTrustStoreRequestTypeDef(TypedDict):
trustStoreArn: str,DeleteUserAccessLoggingSettingsRequestTypeDef#
# DeleteUserAccessLoggingSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DeleteUserAccessLoggingSettingsRequestTypeDef
def get_value() -> DeleteUserAccessLoggingSettingsRequestTypeDef:
return {
"userAccessLoggingSettingsArn": ...,
}
# DeleteUserAccessLoggingSettingsRequestTypeDef definition
class DeleteUserAccessLoggingSettingsRequestTypeDef(TypedDict):
userAccessLoggingSettingsArn: str,DeleteUserSettingsRequestTypeDef#
# DeleteUserSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DeleteUserSettingsRequestTypeDef
def get_value() -> DeleteUserSettingsRequestTypeDef:
return {
"userSettingsArn": ...,
}
# DeleteUserSettingsRequestTypeDef definition
class DeleteUserSettingsRequestTypeDef(TypedDict):
userSettingsArn: str,DisassociateBrowserSettingsRequestTypeDef#
# DisassociateBrowserSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DisassociateBrowserSettingsRequestTypeDef
def get_value() -> DisassociateBrowserSettingsRequestTypeDef:
return {
"portalArn": ...,
}
# DisassociateBrowserSettingsRequestTypeDef definition
class DisassociateBrowserSettingsRequestTypeDef(TypedDict):
portalArn: str,DisassociateDataProtectionSettingsRequestTypeDef#
# DisassociateDataProtectionSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DisassociateDataProtectionSettingsRequestTypeDef
def get_value() -> DisassociateDataProtectionSettingsRequestTypeDef:
return {
"portalArn": ...,
}
# DisassociateDataProtectionSettingsRequestTypeDef definition
class DisassociateDataProtectionSettingsRequestTypeDef(TypedDict):
portalArn: str,DisassociateIpAccessSettingsRequestTypeDef#
# DisassociateIpAccessSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DisassociateIpAccessSettingsRequestTypeDef
def get_value() -> DisassociateIpAccessSettingsRequestTypeDef:
return {
"portalArn": ...,
}
# DisassociateIpAccessSettingsRequestTypeDef definition
class DisassociateIpAccessSettingsRequestTypeDef(TypedDict):
portalArn: str,DisassociateNetworkSettingsRequestTypeDef#
# DisassociateNetworkSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DisassociateNetworkSettingsRequestTypeDef
def get_value() -> DisassociateNetworkSettingsRequestTypeDef:
return {
"portalArn": ...,
}
# DisassociateNetworkSettingsRequestTypeDef definition
class DisassociateNetworkSettingsRequestTypeDef(TypedDict):
portalArn: str,DisassociateTrustStoreRequestTypeDef#
# DisassociateTrustStoreRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DisassociateTrustStoreRequestTypeDef
def get_value() -> DisassociateTrustStoreRequestTypeDef:
return {
"portalArn": ...,
}
# DisassociateTrustStoreRequestTypeDef definition
class DisassociateTrustStoreRequestTypeDef(TypedDict):
portalArn: str,DisassociateUserAccessLoggingSettingsRequestTypeDef#
# DisassociateUserAccessLoggingSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DisassociateUserAccessLoggingSettingsRequestTypeDef
def get_value() -> DisassociateUserAccessLoggingSettingsRequestTypeDef:
return {
"portalArn": ...,
}
# DisassociateUserAccessLoggingSettingsRequestTypeDef definition
class DisassociateUserAccessLoggingSettingsRequestTypeDef(TypedDict):
portalArn: str,DisassociateUserSettingsRequestTypeDef#
# DisassociateUserSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DisassociateUserSettingsRequestTypeDef
def get_value() -> DisassociateUserSettingsRequestTypeDef:
return {
"portalArn": ...,
}
# DisassociateUserSettingsRequestTypeDef definition
class DisassociateUserSettingsRequestTypeDef(TypedDict):
portalArn: str,ExpireSessionRequestTypeDef#
# ExpireSessionRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ExpireSessionRequestTypeDef
def get_value() -> ExpireSessionRequestTypeDef:
return {
"portalId": ...,
}
# ExpireSessionRequestTypeDef definition
class ExpireSessionRequestTypeDef(TypedDict):
portalId: str,
sessionId: str,GetBrowserSettingsRequestTypeDef#
# GetBrowserSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetBrowserSettingsRequestTypeDef
def get_value() -> GetBrowserSettingsRequestTypeDef:
return {
"browserSettingsArn": ...,
}
# GetBrowserSettingsRequestTypeDef definition
class GetBrowserSettingsRequestTypeDef(TypedDict):
browserSettingsArn: str,GetDataProtectionSettingsRequestTypeDef#
# GetDataProtectionSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetDataProtectionSettingsRequestTypeDef
def get_value() -> GetDataProtectionSettingsRequestTypeDef:
return {
"dataProtectionSettingsArn": ...,
}
# GetDataProtectionSettingsRequestTypeDef definition
class GetDataProtectionSettingsRequestTypeDef(TypedDict):
dataProtectionSettingsArn: str,GetIdentityProviderRequestTypeDef#
# GetIdentityProviderRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetIdentityProviderRequestTypeDef
def get_value() -> GetIdentityProviderRequestTypeDef:
return {
"identityProviderArn": ...,
}
# GetIdentityProviderRequestTypeDef definition
class GetIdentityProviderRequestTypeDef(TypedDict):
identityProviderArn: str,IdentityProviderTypeDef#
# IdentityProviderTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import IdentityProviderTypeDef
def get_value() -> IdentityProviderTypeDef:
return {
"identityProviderArn": ...,
}
# IdentityProviderTypeDef definition
class IdentityProviderTypeDef(TypedDict):
identityProviderArn: str,
identityProviderDetails: NotRequired[Dict[str, str]],
identityProviderName: NotRequired[str],
identityProviderType: NotRequired[IdentityProviderTypeType], # (1)GetIpAccessSettingsRequestTypeDef#
# GetIpAccessSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetIpAccessSettingsRequestTypeDef
def get_value() -> GetIpAccessSettingsRequestTypeDef:
return {
"ipAccessSettingsArn": ...,
}
# GetIpAccessSettingsRequestTypeDef definition
class GetIpAccessSettingsRequestTypeDef(TypedDict):
ipAccessSettingsArn: str,GetNetworkSettingsRequestTypeDef#
# GetNetworkSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetNetworkSettingsRequestTypeDef
def get_value() -> GetNetworkSettingsRequestTypeDef:
return {
"networkSettingsArn": ...,
}
# GetNetworkSettingsRequestTypeDef definition
class GetNetworkSettingsRequestTypeDef(TypedDict):
networkSettingsArn: str,NetworkSettingsTypeDef#
# NetworkSettingsTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import NetworkSettingsTypeDef
def get_value() -> NetworkSettingsTypeDef:
return {
"associatedPortalArns": ...,
}
# NetworkSettingsTypeDef definition
class NetworkSettingsTypeDef(TypedDict):
networkSettingsArn: str,
associatedPortalArns: NotRequired[List[str]],
securityGroupIds: NotRequired[List[str]],
subnetIds: NotRequired[List[str]],
vpcId: NotRequired[str],GetPortalRequestTypeDef#
# GetPortalRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetPortalRequestTypeDef
def get_value() -> GetPortalRequestTypeDef:
return {
"portalArn": ...,
}
# GetPortalRequestTypeDef definition
class GetPortalRequestTypeDef(TypedDict):
portalArn: str,PortalTypeDef#
# PortalTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import PortalTypeDef
def get_value() -> PortalTypeDef:
return {
"additionalEncryptionContext": ...,
}
# PortalTypeDef definition
class PortalTypeDef(TypedDict):
portalArn: str,
additionalEncryptionContext: NotRequired[Dict[str, str]],
authenticationType: NotRequired[AuthenticationTypeType], # (1)
browserSettingsArn: NotRequired[str],
browserType: NotRequired[BrowserTypeType], # (2)
creationDate: NotRequired[datetime.datetime],
customerManagedKey: NotRequired[str],
dataProtectionSettingsArn: NotRequired[str],
displayName: NotRequired[str],
instanceType: NotRequired[InstanceTypeType], # (3)
ipAccessSettingsArn: NotRequired[str],
maxConcurrentSessions: NotRequired[int],
networkSettingsArn: NotRequired[str],
portalEndpoint: NotRequired[str],
portalStatus: NotRequired[PortalStatusType], # (4)
rendererType: NotRequired[RendererTypeType], # (5)
statusReason: NotRequired[str],
trustStoreArn: NotRequired[str],
userAccessLoggingSettingsArn: NotRequired[str],
userSettingsArn: NotRequired[str],- See AuthenticationTypeType
- See BrowserTypeType
- See InstanceTypeType
- See PortalStatusType
- See RendererTypeType
GetPortalServiceProviderMetadataRequestTypeDef#
# GetPortalServiceProviderMetadataRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetPortalServiceProviderMetadataRequestTypeDef
def get_value() -> GetPortalServiceProviderMetadataRequestTypeDef:
return {
"portalArn": ...,
}
# GetPortalServiceProviderMetadataRequestTypeDef definition
class GetPortalServiceProviderMetadataRequestTypeDef(TypedDict):
portalArn: str,GetSessionRequestTypeDef#
# GetSessionRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetSessionRequestTypeDef
def get_value() -> GetSessionRequestTypeDef:
return {
"portalId": ...,
}
# GetSessionRequestTypeDef definition
class GetSessionRequestTypeDef(TypedDict):
portalId: str,
sessionId: str,SessionTypeDef#
# SessionTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import SessionTypeDef
def get_value() -> SessionTypeDef:
return {
"clientIpAddresses": ...,
}
# SessionTypeDef definition
class SessionTypeDef(TypedDict):
clientIpAddresses: NotRequired[List[str]],
endTime: NotRequired[datetime.datetime],
portalArn: NotRequired[str],
sessionId: NotRequired[str],
startTime: NotRequired[datetime.datetime],
status: NotRequired[SessionStatusType], # (1)
username: NotRequired[str],GetTrustStoreCertificateRequestTypeDef#
# GetTrustStoreCertificateRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetTrustStoreCertificateRequestTypeDef
def get_value() -> GetTrustStoreCertificateRequestTypeDef:
return {
"thumbprint": ...,
}
# GetTrustStoreCertificateRequestTypeDef definition
class GetTrustStoreCertificateRequestTypeDef(TypedDict):
thumbprint: str,
trustStoreArn: str,GetTrustStoreRequestTypeDef#
# GetTrustStoreRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetTrustStoreRequestTypeDef
def get_value() -> GetTrustStoreRequestTypeDef:
return {
"trustStoreArn": ...,
}
# GetTrustStoreRequestTypeDef definition
class GetTrustStoreRequestTypeDef(TypedDict):
trustStoreArn: str,TrustStoreTypeDef#
# TrustStoreTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import TrustStoreTypeDef
def get_value() -> TrustStoreTypeDef:
return {
"associatedPortalArns": ...,
}
# TrustStoreTypeDef definition
class TrustStoreTypeDef(TypedDict):
trustStoreArn: str,
associatedPortalArns: NotRequired[List[str]],GetUserAccessLoggingSettingsRequestTypeDef#
# GetUserAccessLoggingSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetUserAccessLoggingSettingsRequestTypeDef
def get_value() -> GetUserAccessLoggingSettingsRequestTypeDef:
return {
"userAccessLoggingSettingsArn": ...,
}
# GetUserAccessLoggingSettingsRequestTypeDef definition
class GetUserAccessLoggingSettingsRequestTypeDef(TypedDict):
userAccessLoggingSettingsArn: str,UserAccessLoggingSettingsTypeDef#
# UserAccessLoggingSettingsTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UserAccessLoggingSettingsTypeDef
def get_value() -> UserAccessLoggingSettingsTypeDef:
return {
"associatedPortalArns": ...,
}
# UserAccessLoggingSettingsTypeDef definition
class UserAccessLoggingSettingsTypeDef(TypedDict):
userAccessLoggingSettingsArn: str,
associatedPortalArns: NotRequired[List[str]],
kinesisStreamArn: NotRequired[str],GetUserSettingsRequestTypeDef#
# GetUserSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetUserSettingsRequestTypeDef
def get_value() -> GetUserSettingsRequestTypeDef:
return {
"userSettingsArn": ...,
}
# GetUserSettingsRequestTypeDef definition
class GetUserSettingsRequestTypeDef(TypedDict):
userSettingsArn: str,IdentityProviderSummaryTypeDef#
# IdentityProviderSummaryTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import IdentityProviderSummaryTypeDef
def get_value() -> IdentityProviderSummaryTypeDef:
return {
"identityProviderArn": ...,
}
# IdentityProviderSummaryTypeDef definition
class IdentityProviderSummaryTypeDef(TypedDict):
identityProviderArn: str,
identityProviderName: NotRequired[str],
identityProviderType: NotRequired[IdentityProviderTypeType], # (1)RedactionPlaceHolderTypeDef#
# RedactionPlaceHolderTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import RedactionPlaceHolderTypeDef
def get_value() -> RedactionPlaceHolderTypeDef:
return {
"redactionPlaceHolderText": ...,
}
# RedactionPlaceHolderTypeDef definition
class RedactionPlaceHolderTypeDef(TypedDict):
redactionPlaceHolderType: RedactionPlaceHolderTypeType, # (1)
redactionPlaceHolderText: NotRequired[str],IpAccessSettingsSummaryTypeDef#
# IpAccessSettingsSummaryTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import IpAccessSettingsSummaryTypeDef
def get_value() -> IpAccessSettingsSummaryTypeDef:
return {
"creationDate": ...,
}
# IpAccessSettingsSummaryTypeDef definition
class IpAccessSettingsSummaryTypeDef(TypedDict):
ipAccessSettingsArn: str,
creationDate: NotRequired[datetime.datetime],
description: NotRequired[str],
displayName: NotRequired[str],ListBrowserSettingsRequestTypeDef#
# ListBrowserSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListBrowserSettingsRequestTypeDef
def get_value() -> ListBrowserSettingsRequestTypeDef:
return {
"maxResults": ...,
}
# ListBrowserSettingsRequestTypeDef definition
class ListBrowserSettingsRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],ListDataProtectionSettingsRequestTypeDef#
# ListDataProtectionSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListDataProtectionSettingsRequestTypeDef
def get_value() -> ListDataProtectionSettingsRequestTypeDef:
return {
"maxResults": ...,
}
# ListDataProtectionSettingsRequestTypeDef definition
class ListDataProtectionSettingsRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListIdentityProvidersRequestTypeDef#
# ListIdentityProvidersRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListIdentityProvidersRequestTypeDef
def get_value() -> ListIdentityProvidersRequestTypeDef:
return {
"portalArn": ...,
}
# ListIdentityProvidersRequestTypeDef definition
class ListIdentityProvidersRequestTypeDef(TypedDict):
portalArn: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListIpAccessSettingsRequestTypeDef#
# ListIpAccessSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListIpAccessSettingsRequestTypeDef
def get_value() -> ListIpAccessSettingsRequestTypeDef:
return {
"maxResults": ...,
}
# ListIpAccessSettingsRequestTypeDef definition
class ListIpAccessSettingsRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListNetworkSettingsRequestTypeDef#
# ListNetworkSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListNetworkSettingsRequestTypeDef
def get_value() -> ListNetworkSettingsRequestTypeDef:
return {
"maxResults": ...,
}
# ListNetworkSettingsRequestTypeDef definition
class ListNetworkSettingsRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],NetworkSettingsSummaryTypeDef#
# NetworkSettingsSummaryTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import NetworkSettingsSummaryTypeDef
def get_value() -> NetworkSettingsSummaryTypeDef:
return {
"networkSettingsArn": ...,
}
# NetworkSettingsSummaryTypeDef definition
class NetworkSettingsSummaryTypeDef(TypedDict):
networkSettingsArn: str,
vpcId: NotRequired[str],ListPortalsRequestTypeDef#
# ListPortalsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListPortalsRequestTypeDef
def get_value() -> ListPortalsRequestTypeDef:
return {
"maxResults": ...,
}
# ListPortalsRequestTypeDef definition
class ListPortalsRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],PortalSummaryTypeDef#
# PortalSummaryTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import PortalSummaryTypeDef
def get_value() -> PortalSummaryTypeDef:
return {
"authenticationType": ...,
}
# PortalSummaryTypeDef definition
class PortalSummaryTypeDef(TypedDict):
portalArn: str,
authenticationType: NotRequired[AuthenticationTypeType], # (1)
browserSettingsArn: NotRequired[str],
browserType: NotRequired[BrowserTypeType], # (2)
creationDate: NotRequired[datetime.datetime],
dataProtectionSettingsArn: NotRequired[str],
displayName: NotRequired[str],
instanceType: NotRequired[InstanceTypeType], # (3)
ipAccessSettingsArn: NotRequired[str],
maxConcurrentSessions: NotRequired[int],
networkSettingsArn: NotRequired[str],
portalEndpoint: NotRequired[str],
portalStatus: NotRequired[PortalStatusType], # (4)
rendererType: NotRequired[RendererTypeType], # (5)
trustStoreArn: NotRequired[str],
userAccessLoggingSettingsArn: NotRequired[str],
userSettingsArn: NotRequired[str],- See AuthenticationTypeType
- See BrowserTypeType
- See InstanceTypeType
- See PortalStatusType
- See RendererTypeType
ListSessionsRequestTypeDef#
# ListSessionsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListSessionsRequestTypeDef
def get_value() -> ListSessionsRequestTypeDef:
return {
"portalId": ...,
}
# ListSessionsRequestTypeDef definition
class ListSessionsRequestTypeDef(TypedDict):
portalId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sessionId: NotRequired[str],
sortBy: NotRequired[SessionSortByType], # (1)
status: NotRequired[SessionStatusType], # (2)
username: NotRequired[str],- See SessionSortByType
- See SessionStatusType
SessionSummaryTypeDef#
# SessionSummaryTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import SessionSummaryTypeDef
def get_value() -> SessionSummaryTypeDef:
return {
"endTime": ...,
}
# SessionSummaryTypeDef definition
class SessionSummaryTypeDef(TypedDict):
endTime: NotRequired[datetime.datetime],
portalArn: NotRequired[str],
sessionId: NotRequired[str],
startTime: NotRequired[datetime.datetime],
status: NotRequired[SessionStatusType], # (1)
username: NotRequired[str],ListTagsForResourceRequestTypeDef#
# ListTagsForResourceRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListTagsForResourceRequestTypeDef
def get_value() -> ListTagsForResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# ListTagsForResourceRequestTypeDef definition
class ListTagsForResourceRequestTypeDef(TypedDict):
resourceArn: str,ListTrustStoreCertificatesRequestTypeDef#
# ListTrustStoreCertificatesRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListTrustStoreCertificatesRequestTypeDef
def get_value() -> ListTrustStoreCertificatesRequestTypeDef:
return {
"trustStoreArn": ...,
}
# ListTrustStoreCertificatesRequestTypeDef definition
class ListTrustStoreCertificatesRequestTypeDef(TypedDict):
trustStoreArn: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListTrustStoresRequestTypeDef#
# ListTrustStoresRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListTrustStoresRequestTypeDef
def get_value() -> ListTrustStoresRequestTypeDef:
return {
"maxResults": ...,
}
# ListTrustStoresRequestTypeDef definition
class ListTrustStoresRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],TrustStoreSummaryTypeDef#
# TrustStoreSummaryTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import TrustStoreSummaryTypeDef
def get_value() -> TrustStoreSummaryTypeDef:
return {
"trustStoreArn": ...,
}
# TrustStoreSummaryTypeDef definition
class TrustStoreSummaryTypeDef(TypedDict):
trustStoreArn: NotRequired[str],ListUserAccessLoggingSettingsRequestTypeDef#
# ListUserAccessLoggingSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListUserAccessLoggingSettingsRequestTypeDef
def get_value() -> ListUserAccessLoggingSettingsRequestTypeDef:
return {
"maxResults": ...,
}
# ListUserAccessLoggingSettingsRequestTypeDef definition
class ListUserAccessLoggingSettingsRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],UserAccessLoggingSettingsSummaryTypeDef#
# UserAccessLoggingSettingsSummaryTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UserAccessLoggingSettingsSummaryTypeDef
def get_value() -> UserAccessLoggingSettingsSummaryTypeDef:
return {
"kinesisStreamArn": ...,
}
# UserAccessLoggingSettingsSummaryTypeDef definition
class UserAccessLoggingSettingsSummaryTypeDef(TypedDict):
userAccessLoggingSettingsArn: str,
kinesisStreamArn: NotRequired[str],ListUserSettingsRequestTypeDef#
# ListUserSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListUserSettingsRequestTypeDef
def get_value() -> ListUserSettingsRequestTypeDef:
return {
"maxResults": ...,
}
# ListUserSettingsRequestTypeDef definition
class ListUserSettingsRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],ToolbarConfigurationOutputTypeDef#
# ToolbarConfigurationOutputTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ToolbarConfigurationOutputTypeDef
def get_value() -> ToolbarConfigurationOutputTypeDef:
return {
"hiddenToolbarItems": ...,
}
# ToolbarConfigurationOutputTypeDef definition
class ToolbarConfigurationOutputTypeDef(TypedDict):
hiddenToolbarItems: NotRequired[List[ToolbarItemType]], # (1)
maxDisplayResolution: NotRequired[MaxDisplayResolutionType], # (2)
toolbarType: NotRequired[ToolbarTypeType], # (3)
visualMode: NotRequired[VisualModeType], # (4)- See
List[ToolbarItemType] - See MaxDisplayResolutionType
- See ToolbarTypeType
- See VisualModeType
ToolbarConfigurationTypeDef#
# ToolbarConfigurationTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ToolbarConfigurationTypeDef
def get_value() -> ToolbarConfigurationTypeDef:
return {
"hiddenToolbarItems": ...,
}
# ToolbarConfigurationTypeDef definition
class ToolbarConfigurationTypeDef(TypedDict):
hiddenToolbarItems: NotRequired[Sequence[ToolbarItemType]], # (1)
maxDisplayResolution: NotRequired[MaxDisplayResolutionType], # (2)
toolbarType: NotRequired[ToolbarTypeType], # (3)
visualMode: NotRequired[VisualModeType], # (4)- See
Sequence[ToolbarItemType] - See MaxDisplayResolutionType
- See ToolbarTypeType
- See VisualModeType
UntagResourceRequestTypeDef#
# UntagResourceRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UntagResourceRequestTypeDef
def get_value() -> UntagResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# UntagResourceRequestTypeDef definition
class UntagResourceRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],UpdateBrowserSettingsRequestTypeDef#
# UpdateBrowserSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateBrowserSettingsRequestTypeDef
def get_value() -> UpdateBrowserSettingsRequestTypeDef:
return {
"browserSettingsArn": ...,
}
# UpdateBrowserSettingsRequestTypeDef definition
class UpdateBrowserSettingsRequestTypeDef(TypedDict):
browserSettingsArn: str,
browserPolicy: NotRequired[str],
clientToken: NotRequired[str],UpdateIdentityProviderRequestTypeDef#
# UpdateIdentityProviderRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateIdentityProviderRequestTypeDef
def get_value() -> UpdateIdentityProviderRequestTypeDef:
return {
"identityProviderArn": ...,
}
# UpdateIdentityProviderRequestTypeDef definition
class UpdateIdentityProviderRequestTypeDef(TypedDict):
identityProviderArn: str,
clientToken: NotRequired[str],
identityProviderDetails: NotRequired[Mapping[str, str]],
identityProviderName: NotRequired[str],
identityProviderType: NotRequired[IdentityProviderTypeType], # (1)UpdateNetworkSettingsRequestTypeDef#
# UpdateNetworkSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateNetworkSettingsRequestTypeDef
def get_value() -> UpdateNetworkSettingsRequestTypeDef:
return {
"networkSettingsArn": ...,
}
# UpdateNetworkSettingsRequestTypeDef definition
class UpdateNetworkSettingsRequestTypeDef(TypedDict):
networkSettingsArn: str,
clientToken: NotRequired[str],
securityGroupIds: NotRequired[Sequence[str]],
subnetIds: NotRequired[Sequence[str]],
vpcId: NotRequired[str],UpdatePortalRequestTypeDef#
# UpdatePortalRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdatePortalRequestTypeDef
def get_value() -> UpdatePortalRequestTypeDef:
return {
"portalArn": ...,
}
# UpdatePortalRequestTypeDef definition
class UpdatePortalRequestTypeDef(TypedDict):
portalArn: str,
authenticationType: NotRequired[AuthenticationTypeType], # (1)
displayName: NotRequired[str],
instanceType: NotRequired[InstanceTypeType], # (2)
maxConcurrentSessions: NotRequired[int],UpdateUserAccessLoggingSettingsRequestTypeDef#
# UpdateUserAccessLoggingSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateUserAccessLoggingSettingsRequestTypeDef
def get_value() -> UpdateUserAccessLoggingSettingsRequestTypeDef:
return {
"userAccessLoggingSettingsArn": ...,
}
# UpdateUserAccessLoggingSettingsRequestTypeDef definition
class UpdateUserAccessLoggingSettingsRequestTypeDef(TypedDict):
userAccessLoggingSettingsArn: str,
clientToken: NotRequired[str],
kinesisStreamArn: NotRequired[str],AssociateBrowserSettingsResponseTypeDef#
# AssociateBrowserSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import AssociateBrowserSettingsResponseTypeDef
def get_value() -> AssociateBrowserSettingsResponseTypeDef:
return {
"browserSettingsArn": ...,
}
# AssociateBrowserSettingsResponseTypeDef definition
class AssociateBrowserSettingsResponseTypeDef(TypedDict):
browserSettingsArn: str,
portalArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AssociateDataProtectionSettingsResponseTypeDef#
# AssociateDataProtectionSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import AssociateDataProtectionSettingsResponseTypeDef
def get_value() -> AssociateDataProtectionSettingsResponseTypeDef:
return {
"dataProtectionSettingsArn": ...,
}
# AssociateDataProtectionSettingsResponseTypeDef definition
class AssociateDataProtectionSettingsResponseTypeDef(TypedDict):
dataProtectionSettingsArn: str,
portalArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AssociateIpAccessSettingsResponseTypeDef#
# AssociateIpAccessSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import AssociateIpAccessSettingsResponseTypeDef
def get_value() -> AssociateIpAccessSettingsResponseTypeDef:
return {
"ipAccessSettingsArn": ...,
}
# AssociateIpAccessSettingsResponseTypeDef definition
class AssociateIpAccessSettingsResponseTypeDef(TypedDict):
ipAccessSettingsArn: str,
portalArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AssociateNetworkSettingsResponseTypeDef#
# AssociateNetworkSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import AssociateNetworkSettingsResponseTypeDef
def get_value() -> AssociateNetworkSettingsResponseTypeDef:
return {
"networkSettingsArn": ...,
}
# AssociateNetworkSettingsResponseTypeDef definition
class AssociateNetworkSettingsResponseTypeDef(TypedDict):
networkSettingsArn: str,
portalArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AssociateTrustStoreResponseTypeDef#
# AssociateTrustStoreResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import AssociateTrustStoreResponseTypeDef
def get_value() -> AssociateTrustStoreResponseTypeDef:
return {
"portalArn": ...,
}
# AssociateTrustStoreResponseTypeDef definition
class AssociateTrustStoreResponseTypeDef(TypedDict):
portalArn: str,
trustStoreArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AssociateUserAccessLoggingSettingsResponseTypeDef#
# AssociateUserAccessLoggingSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import AssociateUserAccessLoggingSettingsResponseTypeDef
def get_value() -> AssociateUserAccessLoggingSettingsResponseTypeDef:
return {
"portalArn": ...,
}
# AssociateUserAccessLoggingSettingsResponseTypeDef definition
class AssociateUserAccessLoggingSettingsResponseTypeDef(TypedDict):
portalArn: str,
userAccessLoggingSettingsArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AssociateUserSettingsResponseTypeDef#
# AssociateUserSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import AssociateUserSettingsResponseTypeDef
def get_value() -> AssociateUserSettingsResponseTypeDef:
return {
"portalArn": ...,
}
# AssociateUserSettingsResponseTypeDef definition
class AssociateUserSettingsResponseTypeDef(TypedDict):
portalArn: str,
userSettingsArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateBrowserSettingsResponseTypeDef#
# CreateBrowserSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateBrowserSettingsResponseTypeDef
def get_value() -> CreateBrowserSettingsResponseTypeDef:
return {
"browserSettingsArn": ...,
}
# CreateBrowserSettingsResponseTypeDef definition
class CreateBrowserSettingsResponseTypeDef(TypedDict):
browserSettingsArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateDataProtectionSettingsResponseTypeDef#
# CreateDataProtectionSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateDataProtectionSettingsResponseTypeDef
def get_value() -> CreateDataProtectionSettingsResponseTypeDef:
return {
"dataProtectionSettingsArn": ...,
}
# CreateDataProtectionSettingsResponseTypeDef definition
class CreateDataProtectionSettingsResponseTypeDef(TypedDict):
dataProtectionSettingsArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateIdentityProviderResponseTypeDef#
# CreateIdentityProviderResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateIdentityProviderResponseTypeDef
def get_value() -> CreateIdentityProviderResponseTypeDef:
return {
"identityProviderArn": ...,
}
# CreateIdentityProviderResponseTypeDef definition
class CreateIdentityProviderResponseTypeDef(TypedDict):
identityProviderArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateIpAccessSettingsResponseTypeDef#
# CreateIpAccessSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateIpAccessSettingsResponseTypeDef
def get_value() -> CreateIpAccessSettingsResponseTypeDef:
return {
"ipAccessSettingsArn": ...,
}
# CreateIpAccessSettingsResponseTypeDef definition
class CreateIpAccessSettingsResponseTypeDef(TypedDict):
ipAccessSettingsArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateNetworkSettingsResponseTypeDef#
# CreateNetworkSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateNetworkSettingsResponseTypeDef
def get_value() -> CreateNetworkSettingsResponseTypeDef:
return {
"networkSettingsArn": ...,
}
# CreateNetworkSettingsResponseTypeDef definition
class CreateNetworkSettingsResponseTypeDef(TypedDict):
networkSettingsArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreatePortalResponseTypeDef#
# CreatePortalResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreatePortalResponseTypeDef
def get_value() -> CreatePortalResponseTypeDef:
return {
"portalArn": ...,
}
# CreatePortalResponseTypeDef definition
class CreatePortalResponseTypeDef(TypedDict):
portalArn: str,
portalEndpoint: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateTrustStoreResponseTypeDef#
# CreateTrustStoreResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateTrustStoreResponseTypeDef
def get_value() -> CreateTrustStoreResponseTypeDef:
return {
"trustStoreArn": ...,
}
# CreateTrustStoreResponseTypeDef definition
class CreateTrustStoreResponseTypeDef(TypedDict):
trustStoreArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateUserAccessLoggingSettingsResponseTypeDef#
# CreateUserAccessLoggingSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateUserAccessLoggingSettingsResponseTypeDef
def get_value() -> CreateUserAccessLoggingSettingsResponseTypeDef:
return {
"userAccessLoggingSettingsArn": ...,
}
# CreateUserAccessLoggingSettingsResponseTypeDef definition
class CreateUserAccessLoggingSettingsResponseTypeDef(TypedDict):
userAccessLoggingSettingsArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateUserSettingsResponseTypeDef#
# CreateUserSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateUserSettingsResponseTypeDef
def get_value() -> CreateUserSettingsResponseTypeDef:
return {
"userSettingsArn": ...,
}
# CreateUserSettingsResponseTypeDef definition
class CreateUserSettingsResponseTypeDef(TypedDict):
userSettingsArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetPortalServiceProviderMetadataResponseTypeDef#
# GetPortalServiceProviderMetadataResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetPortalServiceProviderMetadataResponseTypeDef
def get_value() -> GetPortalServiceProviderMetadataResponseTypeDef:
return {
"portalArn": ...,
}
# GetPortalServiceProviderMetadataResponseTypeDef definition
class GetPortalServiceProviderMetadataResponseTypeDef(TypedDict):
portalArn: str,
serviceProviderSamlMetadata: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateTrustStoreResponseTypeDef#
# UpdateTrustStoreResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateTrustStoreResponseTypeDef
def get_value() -> UpdateTrustStoreResponseTypeDef:
return {
"trustStoreArn": ...,
}
# UpdateTrustStoreResponseTypeDef definition
class UpdateTrustStoreResponseTypeDef(TypedDict):
trustStoreArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateTrustStoreRequestTypeDef#
# UpdateTrustStoreRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateTrustStoreRequestTypeDef
def get_value() -> UpdateTrustStoreRequestTypeDef:
return {
"trustStoreArn": ...,
}
# UpdateTrustStoreRequestTypeDef definition
class UpdateTrustStoreRequestTypeDef(TypedDict):
trustStoreArn: str,
certificatesToAdd: NotRequired[Sequence[BlobTypeDef]],
certificatesToDelete: NotRequired[Sequence[str]],
clientToken: NotRequired[str],ListBrowserSettingsResponseTypeDef#
# ListBrowserSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListBrowserSettingsResponseTypeDef
def get_value() -> ListBrowserSettingsResponseTypeDef:
return {
"browserSettings": ...,
}
# ListBrowserSettingsResponseTypeDef definition
class ListBrowserSettingsResponseTypeDef(TypedDict):
browserSettings: List[BrowserSettingsSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[BrowserSettingsSummaryTypeDef] - See ResponseMetadataTypeDef
GetBrowserSettingsResponseTypeDef#
# GetBrowserSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetBrowserSettingsResponseTypeDef
def get_value() -> GetBrowserSettingsResponseTypeDef:
return {
"browserSettings": ...,
}
# GetBrowserSettingsResponseTypeDef definition
class GetBrowserSettingsResponseTypeDef(TypedDict):
browserSettings: BrowserSettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateBrowserSettingsResponseTypeDef#
# UpdateBrowserSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateBrowserSettingsResponseTypeDef
def get_value() -> UpdateBrowserSettingsResponseTypeDef:
return {
"browserSettings": ...,
}
# UpdateBrowserSettingsResponseTypeDef definition
class UpdateBrowserSettingsResponseTypeDef(TypedDict):
browserSettings: BrowserSettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListTrustStoreCertificatesResponseTypeDef#
# ListTrustStoreCertificatesResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListTrustStoreCertificatesResponseTypeDef
def get_value() -> ListTrustStoreCertificatesResponseTypeDef:
return {
"certificateList": ...,
}
# ListTrustStoreCertificatesResponseTypeDef definition
class ListTrustStoreCertificatesResponseTypeDef(TypedDict):
certificateList: List[CertificateSummaryTypeDef], # (1)
trustStoreArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[CertificateSummaryTypeDef] - See ResponseMetadataTypeDef
GetTrustStoreCertificateResponseTypeDef#
# GetTrustStoreCertificateResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetTrustStoreCertificateResponseTypeDef
def get_value() -> GetTrustStoreCertificateResponseTypeDef:
return {
"certificate": ...,
}
# GetTrustStoreCertificateResponseTypeDef definition
class GetTrustStoreCertificateResponseTypeDef(TypedDict):
certificate: CertificateTypeDef, # (1)
trustStoreArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)CookieSynchronizationConfigurationOutputTypeDef#
# CookieSynchronizationConfigurationOutputTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CookieSynchronizationConfigurationOutputTypeDef
def get_value() -> CookieSynchronizationConfigurationOutputTypeDef:
return {
"allowlist": ...,
}
# CookieSynchronizationConfigurationOutputTypeDef definition
class CookieSynchronizationConfigurationOutputTypeDef(TypedDict):
allowlist: List[CookieSpecificationTypeDef], # (1)
blocklist: NotRequired[List[CookieSpecificationTypeDef]], # (1)- See
List[CookieSpecificationTypeDef] - See
List[CookieSpecificationTypeDef]
CookieSynchronizationConfigurationTypeDef#
# CookieSynchronizationConfigurationTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CookieSynchronizationConfigurationTypeDef
def get_value() -> CookieSynchronizationConfigurationTypeDef:
return {
"allowlist": ...,
}
# CookieSynchronizationConfigurationTypeDef definition
class CookieSynchronizationConfigurationTypeDef(TypedDict):
allowlist: Sequence[CookieSpecificationTypeDef], # (1)
blocklist: NotRequired[Sequence[CookieSpecificationTypeDef]], # (1)- See
Sequence[CookieSpecificationTypeDef] - See
Sequence[CookieSpecificationTypeDef]
CreateBrowserSettingsRequestTypeDef#
# CreateBrowserSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateBrowserSettingsRequestTypeDef
def get_value() -> CreateBrowserSettingsRequestTypeDef:
return {
"browserPolicy": ...,
}
# CreateBrowserSettingsRequestTypeDef definition
class CreateBrowserSettingsRequestTypeDef(TypedDict):
browserPolicy: str,
additionalEncryptionContext: NotRequired[Mapping[str, str]],
clientToken: NotRequired[str],
customerManagedKey: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (1)- See
Sequence[TagTypeDef]
CreateIdentityProviderRequestTypeDef#
# CreateIdentityProviderRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateIdentityProviderRequestTypeDef
def get_value() -> CreateIdentityProviderRequestTypeDef:
return {
"identityProviderDetails": ...,
}
# CreateIdentityProviderRequestTypeDef definition
class CreateIdentityProviderRequestTypeDef(TypedDict):
identityProviderDetails: Mapping[str, str],
identityProviderName: str,
identityProviderType: IdentityProviderTypeType, # (1)
portalArn: str,
clientToken: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)- See IdentityProviderTypeType
- See
Sequence[TagTypeDef]
CreateNetworkSettingsRequestTypeDef#
# CreateNetworkSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateNetworkSettingsRequestTypeDef
def get_value() -> CreateNetworkSettingsRequestTypeDef:
return {
"securityGroupIds": ...,
}
# CreateNetworkSettingsRequestTypeDef definition
class CreateNetworkSettingsRequestTypeDef(TypedDict):
securityGroupIds: Sequence[str],
subnetIds: Sequence[str],
vpcId: str,
clientToken: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (1)- See
Sequence[TagTypeDef]
CreatePortalRequestTypeDef#
# CreatePortalRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreatePortalRequestTypeDef
def get_value() -> CreatePortalRequestTypeDef:
return {
"additionalEncryptionContext": ...,
}
# CreatePortalRequestTypeDef definition
class CreatePortalRequestTypeDef(TypedDict):
additionalEncryptionContext: NotRequired[Mapping[str, str]],
authenticationType: NotRequired[AuthenticationTypeType], # (1)
clientToken: NotRequired[str],
customerManagedKey: NotRequired[str],
displayName: NotRequired[str],
instanceType: NotRequired[InstanceTypeType], # (2)
maxConcurrentSessions: NotRequired[int],
tags: NotRequired[Sequence[TagTypeDef]], # (3)- See AuthenticationTypeType
- See InstanceTypeType
- See
Sequence[TagTypeDef]
CreateTrustStoreRequestTypeDef#
# CreateTrustStoreRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateTrustStoreRequestTypeDef
def get_value() -> CreateTrustStoreRequestTypeDef:
return {
"certificateList": ...,
}
# CreateTrustStoreRequestTypeDef definition
class CreateTrustStoreRequestTypeDef(TypedDict):
certificateList: Sequence[BlobTypeDef],
clientToken: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (1)- See
Sequence[TagTypeDef]
CreateUserAccessLoggingSettingsRequestTypeDef#
# CreateUserAccessLoggingSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateUserAccessLoggingSettingsRequestTypeDef
def get_value() -> CreateUserAccessLoggingSettingsRequestTypeDef:
return {
"kinesisStreamArn": ...,
}
# CreateUserAccessLoggingSettingsRequestTypeDef definition
class CreateUserAccessLoggingSettingsRequestTypeDef(TypedDict):
kinesisStreamArn: str,
clientToken: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (1)- See
Sequence[TagTypeDef]
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[TagTypeDef] - See ResponseMetadataTypeDef
TagResourceRequestTypeDef#
# TagResourceRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import TagResourceRequestTypeDef
def get_value() -> TagResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# TagResourceRequestTypeDef definition
class TagResourceRequestTypeDef(TypedDict):
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
clientToken: NotRequired[str],- See
Sequence[TagTypeDef]
CreateIpAccessSettingsRequestTypeDef#
# CreateIpAccessSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateIpAccessSettingsRequestTypeDef
def get_value() -> CreateIpAccessSettingsRequestTypeDef:
return {
"ipRules": ...,
}
# CreateIpAccessSettingsRequestTypeDef definition
class CreateIpAccessSettingsRequestTypeDef(TypedDict):
ipRules: Sequence[IpRuleTypeDef], # (1)
additionalEncryptionContext: NotRequired[Mapping[str, str]],
clientToken: NotRequired[str],
customerManagedKey: NotRequired[str],
description: NotRequired[str],
displayName: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)- See
Sequence[IpRuleTypeDef] - See
Sequence[TagTypeDef]
IpAccessSettingsTypeDef#
# IpAccessSettingsTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import IpAccessSettingsTypeDef
def get_value() -> IpAccessSettingsTypeDef:
return {
"additionalEncryptionContext": ...,
}
# IpAccessSettingsTypeDef definition
class IpAccessSettingsTypeDef(TypedDict):
ipAccessSettingsArn: str,
additionalEncryptionContext: NotRequired[Dict[str, str]],
associatedPortalArns: NotRequired[List[str]],
creationDate: NotRequired[datetime.datetime],
customerManagedKey: NotRequired[str],
description: NotRequired[str],
displayName: NotRequired[str],
ipRules: NotRequired[List[IpRuleTypeDef]], # (1)- See
List[IpRuleTypeDef]
UpdateIpAccessSettingsRequestTypeDef#
# UpdateIpAccessSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateIpAccessSettingsRequestTypeDef
def get_value() -> UpdateIpAccessSettingsRequestTypeDef:
return {
"ipAccessSettingsArn": ...,
}
# UpdateIpAccessSettingsRequestTypeDef definition
class UpdateIpAccessSettingsRequestTypeDef(TypedDict):
ipAccessSettingsArn: str,
clientToken: NotRequired[str],
description: NotRequired[str],
displayName: NotRequired[str],
ipRules: NotRequired[Sequence[IpRuleTypeDef]], # (1)- See
Sequence[IpRuleTypeDef]
ListDataProtectionSettingsResponseTypeDef#
# ListDataProtectionSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListDataProtectionSettingsResponseTypeDef
def get_value() -> ListDataProtectionSettingsResponseTypeDef:
return {
"dataProtectionSettings": ...,
}
# ListDataProtectionSettingsResponseTypeDef definition
class ListDataProtectionSettingsResponseTypeDef(TypedDict):
dataProtectionSettings: List[DataProtectionSettingsSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[DataProtectionSettingsSummaryTypeDef] - See ResponseMetadataTypeDef
GetIdentityProviderResponseTypeDef#
# GetIdentityProviderResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetIdentityProviderResponseTypeDef
def get_value() -> GetIdentityProviderResponseTypeDef:
return {
"identityProvider": ...,
}
# GetIdentityProviderResponseTypeDef definition
class GetIdentityProviderResponseTypeDef(TypedDict):
identityProvider: IdentityProviderTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateIdentityProviderResponseTypeDef#
# UpdateIdentityProviderResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateIdentityProviderResponseTypeDef
def get_value() -> UpdateIdentityProviderResponseTypeDef:
return {
"identityProvider": ...,
}
# UpdateIdentityProviderResponseTypeDef definition
class UpdateIdentityProviderResponseTypeDef(TypedDict):
identityProvider: IdentityProviderTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetNetworkSettingsResponseTypeDef#
# GetNetworkSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetNetworkSettingsResponseTypeDef
def get_value() -> GetNetworkSettingsResponseTypeDef:
return {
"networkSettings": ...,
}
# GetNetworkSettingsResponseTypeDef definition
class GetNetworkSettingsResponseTypeDef(TypedDict):
networkSettings: NetworkSettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateNetworkSettingsResponseTypeDef#
# UpdateNetworkSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateNetworkSettingsResponseTypeDef
def get_value() -> UpdateNetworkSettingsResponseTypeDef:
return {
"networkSettings": ...,
}
# UpdateNetworkSettingsResponseTypeDef definition
class UpdateNetworkSettingsResponseTypeDef(TypedDict):
networkSettings: NetworkSettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetPortalResponseTypeDef#
# GetPortalResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetPortalResponseTypeDef
def get_value() -> GetPortalResponseTypeDef:
return {
"portal": ...,
}
# GetPortalResponseTypeDef definition
class GetPortalResponseTypeDef(TypedDict):
portal: PortalTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See PortalTypeDef
- See ResponseMetadataTypeDef
UpdatePortalResponseTypeDef#
# UpdatePortalResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdatePortalResponseTypeDef
def get_value() -> UpdatePortalResponseTypeDef:
return {
"portal": ...,
}
# UpdatePortalResponseTypeDef definition
class UpdatePortalResponseTypeDef(TypedDict):
portal: PortalTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See PortalTypeDef
- See ResponseMetadataTypeDef
GetSessionResponseTypeDef#
# GetSessionResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetSessionResponseTypeDef
def get_value() -> GetSessionResponseTypeDef:
return {
"session": ...,
}
# GetSessionResponseTypeDef definition
class GetSessionResponseTypeDef(TypedDict):
session: SessionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetTrustStoreResponseTypeDef#
# GetTrustStoreResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetTrustStoreResponseTypeDef
def get_value() -> GetTrustStoreResponseTypeDef:
return {
"trustStore": ...,
}
# GetTrustStoreResponseTypeDef definition
class GetTrustStoreResponseTypeDef(TypedDict):
trustStore: TrustStoreTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetUserAccessLoggingSettingsResponseTypeDef#
# GetUserAccessLoggingSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetUserAccessLoggingSettingsResponseTypeDef
def get_value() -> GetUserAccessLoggingSettingsResponseTypeDef:
return {
"userAccessLoggingSettings": ...,
}
# GetUserAccessLoggingSettingsResponseTypeDef definition
class GetUserAccessLoggingSettingsResponseTypeDef(TypedDict):
userAccessLoggingSettings: UserAccessLoggingSettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateUserAccessLoggingSettingsResponseTypeDef#
# UpdateUserAccessLoggingSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateUserAccessLoggingSettingsResponseTypeDef
def get_value() -> UpdateUserAccessLoggingSettingsResponseTypeDef:
return {
"userAccessLoggingSettings": ...,
}
# UpdateUserAccessLoggingSettingsResponseTypeDef definition
class UpdateUserAccessLoggingSettingsResponseTypeDef(TypedDict):
userAccessLoggingSettings: UserAccessLoggingSettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListIdentityProvidersResponseTypeDef#
# ListIdentityProvidersResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListIdentityProvidersResponseTypeDef
def get_value() -> ListIdentityProvidersResponseTypeDef:
return {
"identityProviders": ...,
}
# ListIdentityProvidersResponseTypeDef definition
class ListIdentityProvidersResponseTypeDef(TypedDict):
identityProviders: List[IdentityProviderSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[IdentityProviderSummaryTypeDef] - See ResponseMetadataTypeDef
InlineRedactionPatternOutputTypeDef#
# InlineRedactionPatternOutputTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import InlineRedactionPatternOutputTypeDef
def get_value() -> InlineRedactionPatternOutputTypeDef:
return {
"builtInPatternId": ...,
}
# InlineRedactionPatternOutputTypeDef definition
class InlineRedactionPatternOutputTypeDef(TypedDict):
redactionPlaceHolder: RedactionPlaceHolderTypeDef, # (2)
builtInPatternId: NotRequired[str],
confidenceLevel: NotRequired[int],
customPattern: NotRequired[CustomPatternTypeDef], # (1)
enforcedUrls: NotRequired[List[str]],
exemptUrls: NotRequired[List[str]],InlineRedactionPatternTypeDef#
# InlineRedactionPatternTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import InlineRedactionPatternTypeDef
def get_value() -> InlineRedactionPatternTypeDef:
return {
"builtInPatternId": ...,
}
# InlineRedactionPatternTypeDef definition
class InlineRedactionPatternTypeDef(TypedDict):
redactionPlaceHolder: RedactionPlaceHolderTypeDef, # (2)
builtInPatternId: NotRequired[str],
confidenceLevel: NotRequired[int],
customPattern: NotRequired[CustomPatternTypeDef], # (1)
enforcedUrls: NotRequired[Sequence[str]],
exemptUrls: NotRequired[Sequence[str]],ListIpAccessSettingsResponseTypeDef#
# ListIpAccessSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListIpAccessSettingsResponseTypeDef
def get_value() -> ListIpAccessSettingsResponseTypeDef:
return {
"ipAccessSettings": ...,
}
# ListIpAccessSettingsResponseTypeDef definition
class ListIpAccessSettingsResponseTypeDef(TypedDict):
ipAccessSettings: List[IpAccessSettingsSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[IpAccessSettingsSummaryTypeDef] - See ResponseMetadataTypeDef
ListDataProtectionSettingsRequestPaginateTypeDef#
# ListDataProtectionSettingsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListDataProtectionSettingsRequestPaginateTypeDef
def get_value() -> ListDataProtectionSettingsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListDataProtectionSettingsRequestPaginateTypeDef definition
class ListDataProtectionSettingsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListSessionsRequestPaginateTypeDef#
# ListSessionsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListSessionsRequestPaginateTypeDef
def get_value() -> ListSessionsRequestPaginateTypeDef:
return {
"portalId": ...,
}
# ListSessionsRequestPaginateTypeDef definition
class ListSessionsRequestPaginateTypeDef(TypedDict):
portalId: str,
sessionId: NotRequired[str],
sortBy: NotRequired[SessionSortByType], # (1)
status: NotRequired[SessionStatusType], # (2)
username: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See SessionSortByType
- See SessionStatusType
- See PaginatorConfigTypeDef
ListNetworkSettingsResponseTypeDef#
# ListNetworkSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListNetworkSettingsResponseTypeDef
def get_value() -> ListNetworkSettingsResponseTypeDef:
return {
"networkSettings": ...,
}
# ListNetworkSettingsResponseTypeDef definition
class ListNetworkSettingsResponseTypeDef(TypedDict):
networkSettings: List[NetworkSettingsSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[NetworkSettingsSummaryTypeDef] - See ResponseMetadataTypeDef
ListPortalsResponseTypeDef#
# ListPortalsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListPortalsResponseTypeDef
def get_value() -> ListPortalsResponseTypeDef:
return {
"nextToken": ...,
}
# ListPortalsResponseTypeDef definition
class ListPortalsResponseTypeDef(TypedDict):
portals: List[PortalSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[PortalSummaryTypeDef] - See ResponseMetadataTypeDef
ListSessionsResponseTypeDef#
# ListSessionsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListSessionsResponseTypeDef
def get_value() -> ListSessionsResponseTypeDef:
return {
"nextToken": ...,
}
# ListSessionsResponseTypeDef definition
class ListSessionsResponseTypeDef(TypedDict):
sessions: List[SessionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[SessionSummaryTypeDef] - See ResponseMetadataTypeDef
ListTrustStoresResponseTypeDef#
# ListTrustStoresResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListTrustStoresResponseTypeDef
def get_value() -> ListTrustStoresResponseTypeDef:
return {
"nextToken": ...,
}
# ListTrustStoresResponseTypeDef definition
class ListTrustStoresResponseTypeDef(TypedDict):
trustStores: List[TrustStoreSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[TrustStoreSummaryTypeDef] - See ResponseMetadataTypeDef
ListUserAccessLoggingSettingsResponseTypeDef#
# ListUserAccessLoggingSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListUserAccessLoggingSettingsResponseTypeDef
def get_value() -> ListUserAccessLoggingSettingsResponseTypeDef:
return {
"nextToken": ...,
}
# ListUserAccessLoggingSettingsResponseTypeDef definition
class ListUserAccessLoggingSettingsResponseTypeDef(TypedDict):
userAccessLoggingSettings: List[UserAccessLoggingSettingsSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[UserAccessLoggingSettingsSummaryTypeDef] - See ResponseMetadataTypeDef
UserSettingsSummaryTypeDef#
# UserSettingsSummaryTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UserSettingsSummaryTypeDef
def get_value() -> UserSettingsSummaryTypeDef:
return {
"cookieSynchronizationConfiguration": ...,
}
# UserSettingsSummaryTypeDef definition
class UserSettingsSummaryTypeDef(TypedDict):
userSettingsArn: str,
cookieSynchronizationConfiguration: NotRequired[CookieSynchronizationConfigurationOutputTypeDef], # (1)
copyAllowed: NotRequired[EnabledTypeType], # (2)
deepLinkAllowed: NotRequired[EnabledTypeType], # (2)
disconnectTimeoutInMinutes: NotRequired[int],
downloadAllowed: NotRequired[EnabledTypeType], # (2)
idleDisconnectTimeoutInMinutes: NotRequired[int],
pasteAllowed: NotRequired[EnabledTypeType], # (2)
printAllowed: NotRequired[EnabledTypeType], # (2)
toolbarConfiguration: NotRequired[ToolbarConfigurationOutputTypeDef], # (7)
uploadAllowed: NotRequired[EnabledTypeType], # (2)- See CookieSynchronizationConfigurationOutputTypeDef
- See EnabledTypeType
- See EnabledTypeType
- See EnabledTypeType
- See EnabledTypeType
- See EnabledTypeType
- See ToolbarConfigurationOutputTypeDef
- See EnabledTypeType
UserSettingsTypeDef#
# UserSettingsTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UserSettingsTypeDef
def get_value() -> UserSettingsTypeDef:
return {
"additionalEncryptionContext": ...,
}
# UserSettingsTypeDef definition
class UserSettingsTypeDef(TypedDict):
userSettingsArn: str,
additionalEncryptionContext: NotRequired[Dict[str, str]],
associatedPortalArns: NotRequired[List[str]],
cookieSynchronizationConfiguration: NotRequired[CookieSynchronizationConfigurationOutputTypeDef], # (1)
copyAllowed: NotRequired[EnabledTypeType], # (2)
customerManagedKey: NotRequired[str],
deepLinkAllowed: NotRequired[EnabledTypeType], # (2)
disconnectTimeoutInMinutes: NotRequired[int],
downloadAllowed: NotRequired[EnabledTypeType], # (2)
idleDisconnectTimeoutInMinutes: NotRequired[int],
pasteAllowed: NotRequired[EnabledTypeType], # (2)
printAllowed: NotRequired[EnabledTypeType], # (2)
toolbarConfiguration: NotRequired[ToolbarConfigurationOutputTypeDef], # (7)
uploadAllowed: NotRequired[EnabledTypeType], # (2)- See CookieSynchronizationConfigurationOutputTypeDef
- See EnabledTypeType
- See EnabledTypeType
- See EnabledTypeType
- See EnabledTypeType
- See EnabledTypeType
- See ToolbarConfigurationOutputTypeDef
- See EnabledTypeType
GetIpAccessSettingsResponseTypeDef#
# GetIpAccessSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetIpAccessSettingsResponseTypeDef
def get_value() -> GetIpAccessSettingsResponseTypeDef:
return {
"ipAccessSettings": ...,
}
# GetIpAccessSettingsResponseTypeDef definition
class GetIpAccessSettingsResponseTypeDef(TypedDict):
ipAccessSettings: IpAccessSettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateIpAccessSettingsResponseTypeDef#
# UpdateIpAccessSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateIpAccessSettingsResponseTypeDef
def get_value() -> UpdateIpAccessSettingsResponseTypeDef:
return {
"ipAccessSettings": ...,
}
# UpdateIpAccessSettingsResponseTypeDef definition
class UpdateIpAccessSettingsResponseTypeDef(TypedDict):
ipAccessSettings: IpAccessSettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)InlineRedactionConfigurationOutputTypeDef#
# InlineRedactionConfigurationOutputTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import InlineRedactionConfigurationOutputTypeDef
def get_value() -> InlineRedactionConfigurationOutputTypeDef:
return {
"globalConfidenceLevel": ...,
}
# InlineRedactionConfigurationOutputTypeDef definition
class InlineRedactionConfigurationOutputTypeDef(TypedDict):
inlineRedactionPatterns: List[InlineRedactionPatternOutputTypeDef], # (1)
globalConfidenceLevel: NotRequired[int],
globalEnforcedUrls: NotRequired[List[str]],
globalExemptUrls: NotRequired[List[str]],- See
List[InlineRedactionPatternOutputTypeDef]
InlineRedactionConfigurationTypeDef#
# InlineRedactionConfigurationTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import InlineRedactionConfigurationTypeDef
def get_value() -> InlineRedactionConfigurationTypeDef:
return {
"globalConfidenceLevel": ...,
}
# InlineRedactionConfigurationTypeDef definition
class InlineRedactionConfigurationTypeDef(TypedDict):
inlineRedactionPatterns: Sequence[InlineRedactionPatternTypeDef], # (1)
globalConfidenceLevel: NotRequired[int],
globalEnforcedUrls: NotRequired[Sequence[str]],
globalExemptUrls: NotRequired[Sequence[str]],- See
Sequence[InlineRedactionPatternTypeDef]
ListUserSettingsResponseTypeDef#
# ListUserSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import ListUserSettingsResponseTypeDef
def get_value() -> ListUserSettingsResponseTypeDef:
return {
"nextToken": ...,
}
# ListUserSettingsResponseTypeDef definition
class ListUserSettingsResponseTypeDef(TypedDict):
userSettings: List[UserSettingsSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See
List[UserSettingsSummaryTypeDef] - See ResponseMetadataTypeDef
GetUserSettingsResponseTypeDef#
# GetUserSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetUserSettingsResponseTypeDef
def get_value() -> GetUserSettingsResponseTypeDef:
return {
"userSettings": ...,
}
# GetUserSettingsResponseTypeDef definition
class GetUserSettingsResponseTypeDef(TypedDict):
userSettings: UserSettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateUserSettingsResponseTypeDef#
# UpdateUserSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateUserSettingsResponseTypeDef
def get_value() -> UpdateUserSettingsResponseTypeDef:
return {
"userSettings": ...,
}
# UpdateUserSettingsResponseTypeDef definition
class UpdateUserSettingsResponseTypeDef(TypedDict):
userSettings: UserSettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateUserSettingsRequestTypeDef#
# CreateUserSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateUserSettingsRequestTypeDef
def get_value() -> CreateUserSettingsRequestTypeDef:
return {
"copyAllowed": ...,
}
# CreateUserSettingsRequestTypeDef definition
class CreateUserSettingsRequestTypeDef(TypedDict):
copyAllowed: EnabledTypeType, # (1)
downloadAllowed: EnabledTypeType, # (1)
pasteAllowed: EnabledTypeType, # (1)
printAllowed: EnabledTypeType, # (1)
uploadAllowed: EnabledTypeType, # (1)
additionalEncryptionContext: NotRequired[Mapping[str, str]],
clientToken: NotRequired[str],
cookieSynchronizationConfiguration: NotRequired[CookieSynchronizationConfigurationUnionTypeDef], # (6)
customerManagedKey: NotRequired[str],
deepLinkAllowed: NotRequired[EnabledTypeType], # (1)
disconnectTimeoutInMinutes: NotRequired[int],
idleDisconnectTimeoutInMinutes: NotRequired[int],
tags: NotRequired[Sequence[TagTypeDef]], # (8)
toolbarConfiguration: NotRequired[ToolbarConfigurationUnionTypeDef], # (9)- See EnabledTypeType
- See EnabledTypeType
- See EnabledTypeType
- See EnabledTypeType
- See EnabledTypeType
- See CookieSynchronizationConfigurationUnionTypeDef
- See EnabledTypeType
- See
Sequence[TagTypeDef] - See ToolbarConfigurationUnionTypeDef
UpdateUserSettingsRequestTypeDef#
# UpdateUserSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateUserSettingsRequestTypeDef
def get_value() -> UpdateUserSettingsRequestTypeDef:
return {
"userSettingsArn": ...,
}
# UpdateUserSettingsRequestTypeDef definition
class UpdateUserSettingsRequestTypeDef(TypedDict):
userSettingsArn: str,
clientToken: NotRequired[str],
cookieSynchronizationConfiguration: NotRequired[CookieSynchronizationConfigurationUnionTypeDef], # (1)
copyAllowed: NotRequired[EnabledTypeType], # (2)
deepLinkAllowed: NotRequired[EnabledTypeType], # (2)
disconnectTimeoutInMinutes: NotRequired[int],
downloadAllowed: NotRequired[EnabledTypeType], # (2)
idleDisconnectTimeoutInMinutes: NotRequired[int],
pasteAllowed: NotRequired[EnabledTypeType], # (2)
printAllowed: NotRequired[EnabledTypeType], # (2)
toolbarConfiguration: NotRequired[ToolbarConfigurationUnionTypeDef], # (7)
uploadAllowed: NotRequired[EnabledTypeType], # (2)- See CookieSynchronizationConfigurationUnionTypeDef
- See EnabledTypeType
- See EnabledTypeType
- See EnabledTypeType
- See EnabledTypeType
- See EnabledTypeType
- See ToolbarConfigurationUnionTypeDef
- See EnabledTypeType
DataProtectionSettingsTypeDef#
# DataProtectionSettingsTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import DataProtectionSettingsTypeDef
def get_value() -> DataProtectionSettingsTypeDef:
return {
"additionalEncryptionContext": ...,
}
# DataProtectionSettingsTypeDef definition
class DataProtectionSettingsTypeDef(TypedDict):
dataProtectionSettingsArn: str,
additionalEncryptionContext: NotRequired[Dict[str, str]],
associatedPortalArns: NotRequired[List[str]],
creationDate: NotRequired[datetime.datetime],
customerManagedKey: NotRequired[str],
description: NotRequired[str],
displayName: NotRequired[str],
inlineRedactionConfiguration: NotRequired[InlineRedactionConfigurationOutputTypeDef], # (1)GetDataProtectionSettingsResponseTypeDef#
# GetDataProtectionSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import GetDataProtectionSettingsResponseTypeDef
def get_value() -> GetDataProtectionSettingsResponseTypeDef:
return {
"dataProtectionSettings": ...,
}
# GetDataProtectionSettingsResponseTypeDef definition
class GetDataProtectionSettingsResponseTypeDef(TypedDict):
dataProtectionSettings: DataProtectionSettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateDataProtectionSettingsResponseTypeDef#
# UpdateDataProtectionSettingsResponseTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateDataProtectionSettingsResponseTypeDef
def get_value() -> UpdateDataProtectionSettingsResponseTypeDef:
return {
"dataProtectionSettings": ...,
}
# UpdateDataProtectionSettingsResponseTypeDef definition
class UpdateDataProtectionSettingsResponseTypeDef(TypedDict):
dataProtectionSettings: DataProtectionSettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateDataProtectionSettingsRequestTypeDef#
# CreateDataProtectionSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import CreateDataProtectionSettingsRequestTypeDef
def get_value() -> CreateDataProtectionSettingsRequestTypeDef:
return {
"additionalEncryptionContext": ...,
}
# CreateDataProtectionSettingsRequestTypeDef definition
class CreateDataProtectionSettingsRequestTypeDef(TypedDict):
additionalEncryptionContext: NotRequired[Mapping[str, str]],
clientToken: NotRequired[str],
customerManagedKey: NotRequired[str],
description: NotRequired[str],
displayName: NotRequired[str],
inlineRedactionConfiguration: NotRequired[InlineRedactionConfigurationUnionTypeDef], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)- See InlineRedactionConfigurationUnionTypeDef
- See
Sequence[TagTypeDef]
UpdateDataProtectionSettingsRequestTypeDef#
# UpdateDataProtectionSettingsRequestTypeDef TypedDict usage example
from mypy_boto3_workspaces_web.type_defs import UpdateDataProtectionSettingsRequestTypeDef
def get_value() -> UpdateDataProtectionSettingsRequestTypeDef:
return {
"dataProtectionSettingsArn": ...,
}
# UpdateDataProtectionSettingsRequestTypeDef definition
class UpdateDataProtectionSettingsRequestTypeDef(TypedDict):
dataProtectionSettingsArn: str,
clientToken: NotRequired[str],
description: NotRequired[str],
displayName: NotRequired[str],
inlineRedactionConfiguration: NotRequired[InlineRedactionConfigurationUnionTypeDef], # (1)