Skip to content

Type definitions#

Index > WorkSpacesWeb > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

AssociateBrowserSettingsRequestRequestTypeDef#

# AssociateBrowserSettingsRequestRequestTypeDef definition

class AssociateBrowserSettingsRequestRequestTypeDef(TypedDict):
    browserSettingsArn: str,
    portalArn: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

AssociateIpAccessSettingsRequestRequestTypeDef#

# AssociateIpAccessSettingsRequestRequestTypeDef definition

class AssociateIpAccessSettingsRequestRequestTypeDef(TypedDict):
    ipAccessSettingsArn: str,
    portalArn: str,

AssociateNetworkSettingsRequestRequestTypeDef#

# AssociateNetworkSettingsRequestRequestTypeDef definition

class AssociateNetworkSettingsRequestRequestTypeDef(TypedDict):
    networkSettingsArn: str,
    portalArn: str,

AssociateTrustStoreRequestRequestTypeDef#

# AssociateTrustStoreRequestRequestTypeDef definition

class AssociateTrustStoreRequestRequestTypeDef(TypedDict):
    portalArn: str,
    trustStoreArn: str,

AssociateUserAccessLoggingSettingsRequestRequestTypeDef#

# AssociateUserAccessLoggingSettingsRequestRequestTypeDef definition

class AssociateUserAccessLoggingSettingsRequestRequestTypeDef(TypedDict):
    portalArn: str,
    userAccessLoggingSettingsArn: str,

AssociateUserSettingsRequestRequestTypeDef#

# AssociateUserSettingsRequestRequestTypeDef definition

class AssociateUserSettingsRequestRequestTypeDef(TypedDict):
    portalArn: str,
    userSettingsArn: str,

BrowserSettingsSummaryTypeDef#

# BrowserSettingsSummaryTypeDef definition

class BrowserSettingsSummaryTypeDef(TypedDict):
    browserSettingsArn: str,

BrowserSettingsTypeDef#

# BrowserSettingsTypeDef definition

class BrowserSettingsTypeDef(TypedDict):
    browserSettingsArn: str,
    associatedPortalArns: NotRequired[List[str]],
    browserPolicy: NotRequired[str],

CertificateSummaryTypeDef#

# CertificateSummaryTypeDef definition

class CertificateSummaryTypeDef(TypedDict):
    issuer: NotRequired[str],
    notValidAfter: NotRequired[datetime],
    notValidBefore: NotRequired[datetime],
    subject: NotRequired[str],
    thumbprint: NotRequired[str],

CertificateTypeDef#

# CertificateTypeDef definition

class CertificateTypeDef(TypedDict):
    body: NotRequired[bytes],
    issuer: NotRequired[str],
    notValidAfter: NotRequired[datetime],
    notValidBefore: NotRequired[datetime],
    subject: NotRequired[str],
    thumbprint: NotRequired[str],

CookieSpecificationTypeDef#

# CookieSpecificationTypeDef definition

class CookieSpecificationTypeDef(TypedDict):
    domain: str,
    name: NotRequired[str],
    path: NotRequired[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

CreateIdentityProviderRequestRequestTypeDef#

# CreateIdentityProviderRequestRequestTypeDef definition

class CreateIdentityProviderRequestRequestTypeDef(TypedDict):
    identityProviderDetails: Mapping[str, str],
    identityProviderName: str,
    identityProviderType: IdentityProviderTypeType,  # (1)
    portalArn: str,
    clientToken: NotRequired[str],
  1. See IdentityProviderTypeType

IpRuleTypeDef#

# IpRuleTypeDef definition

class IpRuleTypeDef(TypedDict):
    ipRange: str,
    description: NotRequired[str],

DeleteBrowserSettingsRequestRequestTypeDef#

# DeleteBrowserSettingsRequestRequestTypeDef definition

class DeleteBrowserSettingsRequestRequestTypeDef(TypedDict):
    browserSettingsArn: str,

DeleteIdentityProviderRequestRequestTypeDef#

# DeleteIdentityProviderRequestRequestTypeDef definition

class DeleteIdentityProviderRequestRequestTypeDef(TypedDict):
    identityProviderArn: str,

DeleteIpAccessSettingsRequestRequestTypeDef#

# DeleteIpAccessSettingsRequestRequestTypeDef definition

class DeleteIpAccessSettingsRequestRequestTypeDef(TypedDict):
    ipAccessSettingsArn: str,

DeleteNetworkSettingsRequestRequestTypeDef#

# DeleteNetworkSettingsRequestRequestTypeDef definition

class DeleteNetworkSettingsRequestRequestTypeDef(TypedDict):
    networkSettingsArn: str,

DeletePortalRequestRequestTypeDef#

# DeletePortalRequestRequestTypeDef definition

class DeletePortalRequestRequestTypeDef(TypedDict):
    portalArn: str,

DeleteTrustStoreRequestRequestTypeDef#

# DeleteTrustStoreRequestRequestTypeDef definition

class DeleteTrustStoreRequestRequestTypeDef(TypedDict):
    trustStoreArn: str,

DeleteUserAccessLoggingSettingsRequestRequestTypeDef#

# DeleteUserAccessLoggingSettingsRequestRequestTypeDef definition

class DeleteUserAccessLoggingSettingsRequestRequestTypeDef(TypedDict):
    userAccessLoggingSettingsArn: str,

DeleteUserSettingsRequestRequestTypeDef#

# DeleteUserSettingsRequestRequestTypeDef definition

class DeleteUserSettingsRequestRequestTypeDef(TypedDict):
    userSettingsArn: str,

DisassociateBrowserSettingsRequestRequestTypeDef#

# DisassociateBrowserSettingsRequestRequestTypeDef definition

class DisassociateBrowserSettingsRequestRequestTypeDef(TypedDict):
    portalArn: str,

DisassociateIpAccessSettingsRequestRequestTypeDef#

# DisassociateIpAccessSettingsRequestRequestTypeDef definition

class DisassociateIpAccessSettingsRequestRequestTypeDef(TypedDict):
    portalArn: str,

DisassociateNetworkSettingsRequestRequestTypeDef#

# DisassociateNetworkSettingsRequestRequestTypeDef definition

class DisassociateNetworkSettingsRequestRequestTypeDef(TypedDict):
    portalArn: str,

DisassociateTrustStoreRequestRequestTypeDef#

# DisassociateTrustStoreRequestRequestTypeDef definition

class DisassociateTrustStoreRequestRequestTypeDef(TypedDict):
    portalArn: str,

DisassociateUserAccessLoggingSettingsRequestRequestTypeDef#

# DisassociateUserAccessLoggingSettingsRequestRequestTypeDef definition

class DisassociateUserAccessLoggingSettingsRequestRequestTypeDef(TypedDict):
    portalArn: str,

DisassociateUserSettingsRequestRequestTypeDef#

# DisassociateUserSettingsRequestRequestTypeDef definition

class DisassociateUserSettingsRequestRequestTypeDef(TypedDict):
    portalArn: str,

GetBrowserSettingsRequestRequestTypeDef#

# GetBrowserSettingsRequestRequestTypeDef definition

class GetBrowserSettingsRequestRequestTypeDef(TypedDict):
    browserSettingsArn: str,

GetIdentityProviderRequestRequestTypeDef#

# GetIdentityProviderRequestRequestTypeDef definition

class GetIdentityProviderRequestRequestTypeDef(TypedDict):
    identityProviderArn: str,

IdentityProviderTypeDef#

# IdentityProviderTypeDef definition

class IdentityProviderTypeDef(TypedDict):
    identityProviderArn: str,
    identityProviderDetails: NotRequired[Dict[str, str]],
    identityProviderName: NotRequired[str],
    identityProviderType: NotRequired[IdentityProviderTypeType],  # (1)
  1. See IdentityProviderTypeType

GetIpAccessSettingsRequestRequestTypeDef#

# GetIpAccessSettingsRequestRequestTypeDef definition

class GetIpAccessSettingsRequestRequestTypeDef(TypedDict):
    ipAccessSettingsArn: str,

GetNetworkSettingsRequestRequestTypeDef#

# GetNetworkSettingsRequestRequestTypeDef definition

class GetNetworkSettingsRequestRequestTypeDef(TypedDict):
    networkSettingsArn: str,

NetworkSettingsTypeDef#

# NetworkSettingsTypeDef definition

class NetworkSettingsTypeDef(TypedDict):
    networkSettingsArn: str,
    associatedPortalArns: NotRequired[List[str]],
    securityGroupIds: NotRequired[List[str]],
    subnetIds: NotRequired[List[str]],
    vpcId: NotRequired[str],

GetPortalRequestRequestTypeDef#

# GetPortalRequestRequestTypeDef definition

class GetPortalRequestRequestTypeDef(TypedDict):
    portalArn: str,

PortalTypeDef#

# PortalTypeDef definition

class PortalTypeDef(TypedDict):
    portalArn: str,
    authenticationType: NotRequired[AuthenticationTypeType],  # (1)
    browserSettingsArn: NotRequired[str],
    browserType: NotRequired[BrowserTypeType],  # (2)
    creationDate: NotRequired[datetime],
    displayName: NotRequired[str],
    ipAccessSettingsArn: NotRequired[str],
    networkSettingsArn: NotRequired[str],
    portalEndpoint: NotRequired[str],
    portalStatus: NotRequired[PortalStatusType],  # (3)
    rendererType: NotRequired[RendererTypeType],  # (4)
    statusReason: NotRequired[str],
    trustStoreArn: NotRequired[str],
    userAccessLoggingSettingsArn: NotRequired[str],
    userSettingsArn: NotRequired[str],
  1. See AuthenticationTypeType
  2. See BrowserTypeType
  3. See PortalStatusType
  4. See RendererTypeType

GetPortalServiceProviderMetadataRequestRequestTypeDef#

# GetPortalServiceProviderMetadataRequestRequestTypeDef definition

class GetPortalServiceProviderMetadataRequestRequestTypeDef(TypedDict):
    portalArn: str,

GetTrustStoreCertificateRequestRequestTypeDef#

# GetTrustStoreCertificateRequestRequestTypeDef definition

class GetTrustStoreCertificateRequestRequestTypeDef(TypedDict):
    thumbprint: str,
    trustStoreArn: str,

GetTrustStoreRequestRequestTypeDef#

# GetTrustStoreRequestRequestTypeDef definition

class GetTrustStoreRequestRequestTypeDef(TypedDict):
    trustStoreArn: str,

TrustStoreTypeDef#

# TrustStoreTypeDef definition

class TrustStoreTypeDef(TypedDict):
    trustStoreArn: str,
    associatedPortalArns: NotRequired[List[str]],

GetUserAccessLoggingSettingsRequestRequestTypeDef#

# GetUserAccessLoggingSettingsRequestRequestTypeDef definition

class GetUserAccessLoggingSettingsRequestRequestTypeDef(TypedDict):
    userAccessLoggingSettingsArn: str,

UserAccessLoggingSettingsTypeDef#

# UserAccessLoggingSettingsTypeDef definition

class UserAccessLoggingSettingsTypeDef(TypedDict):
    userAccessLoggingSettingsArn: str,
    associatedPortalArns: NotRequired[List[str]],
    kinesisStreamArn: NotRequired[str],

GetUserSettingsRequestRequestTypeDef#

# GetUserSettingsRequestRequestTypeDef definition

class GetUserSettingsRequestRequestTypeDef(TypedDict):
    userSettingsArn: str,

IdentityProviderSummaryTypeDef#

# IdentityProviderSummaryTypeDef definition

class IdentityProviderSummaryTypeDef(TypedDict):
    identityProviderArn: str,
    identityProviderName: NotRequired[str],
    identityProviderType: NotRequired[IdentityProviderTypeType],  # (1)
  1. See IdentityProviderTypeType

IpAccessSettingsSummaryTypeDef#

# IpAccessSettingsSummaryTypeDef definition

class IpAccessSettingsSummaryTypeDef(TypedDict):
    ipAccessSettingsArn: str,
    creationDate: NotRequired[datetime],
    description: NotRequired[str],
    displayName: NotRequired[str],

ListBrowserSettingsRequestRequestTypeDef#

# ListBrowserSettingsRequestRequestTypeDef definition

class ListBrowserSettingsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListIdentityProvidersRequestRequestTypeDef#

# ListIdentityProvidersRequestRequestTypeDef definition

class ListIdentityProvidersRequestRequestTypeDef(TypedDict):
    portalArn: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListIpAccessSettingsRequestRequestTypeDef#

# ListIpAccessSettingsRequestRequestTypeDef definition

class ListIpAccessSettingsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListNetworkSettingsRequestRequestTypeDef#

# ListNetworkSettingsRequestRequestTypeDef definition

class ListNetworkSettingsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

NetworkSettingsSummaryTypeDef#

# NetworkSettingsSummaryTypeDef definition

class NetworkSettingsSummaryTypeDef(TypedDict):
    networkSettingsArn: str,
    vpcId: NotRequired[str],

ListPortalsRequestRequestTypeDef#

# ListPortalsRequestRequestTypeDef de