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,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

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 definition

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

PortalSummaryTypeDef#

# PortalSummaryTypeDef definition

class PortalSummaryTypeDef(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)
    trustStoreArn: NotRequired[str],
    userAccessLoggingSettingsArn: NotRequired[str],
    userSettingsArn: NotRequired[str],
  1. See AuthenticationTypeType
  2. See BrowserTypeType
  3. See PortalStatusType
  4. See RendererTypeType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListTrustStoreCertificatesRequestRequestTypeDef#

# ListTrustStoreCertificatesRequestRequestTypeDef definition

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

ListTrustStoresRequestRequestTypeDef#

# ListTrustStoresRequestRequestTypeDef definition

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

TrustStoreSummaryTypeDef#

# TrustStoreSummaryTypeDef definition

class TrustStoreSummaryTypeDef(TypedDict):
    trustStoreArn: NotRequired[str],

ListUserAccessLoggingSettingsRequestRequestTypeDef#

# ListUserAccessLoggingSettingsRequestRequestTypeDef definition

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

UserAccessLoggingSettingsSummaryTypeDef#

# UserAccessLoggingSettingsSummaryTypeDef definition

class UserAccessLoggingSettingsSummaryTypeDef(TypedDict):
    userAccessLoggingSettingsArn: str,
    kinesisStreamArn: NotRequired[str],

ListUserSettingsRequestRequestTypeDef#

# ListUserSettingsRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateBrowserSettingsRequestRequestTypeDef#

# UpdateBrowserSettingsRequestRequestTypeDef definition

class UpdateBrowserSettingsRequestRequestTypeDef(TypedDict):
    browserSettingsArn: str,
    browserPolicy: NotRequired[str],
    clientToken: NotRequired[str],

UpdateIdentityProviderRequestRequestTypeDef#

# UpdateIdentityProviderRequestRequestTypeDef definition

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

UpdateNetworkSettingsRequestRequestTypeDef#

# UpdateNetworkSettingsRequestRequestTypeDef definition

class UpdateNetworkSettingsRequestRequestTypeDef(TypedDict):
    networkSettingsArn: str,
    clientToken: NotRequired[str],
    securityGroupIds: NotRequired[Sequence[str]],
    subnetIds: NotRequired[Sequence[str]],
    vpcId: NotRequired[str],

UpdatePortalRequestRequestTypeDef#

# UpdatePortalRequestRequestTypeDef definition

class UpdatePortalRequestRequestTypeDef(TypedDict):
    portalArn: str,
    authenticationType: NotRequired[AuthenticationTypeType],  # (1)
    displayName: NotRequired[str],
  1. See AuthenticationTypeType

UpdateUserAccessLoggingSettingsRequestRequestTypeDef#

# UpdateUserAccessLoggingSettingsRequestRequestTypeDef definition

class UpdateUserAccessLoggingSettingsRequestRequestTypeDef(TypedDict):
    userAccessLoggingSettingsArn: str,
    clientToken: NotRequired[str],
    kinesisStreamArn: NotRequired[str],

AssociateBrowserSettingsResponseTypeDef#

# AssociateBrowserSettingsResponseTypeDef definition

class AssociateBrowserSettingsResponseTypeDef(TypedDict):
    browserSettingsArn: str,
    portalArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AssociateIpAccessSettingsResponseTypeDef#

# AssociateIpAccessSettingsResponseTypeDef definition

class AssociateIpAccessSettingsResponseTypeDef(TypedDict):
    ipAccessSettingsArn: str,
    portalArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AssociateNetworkSettingsResponseTypeDef#

# AssociateNetworkSettingsResponseTypeDef definition

class AssociateNetworkSettingsResponseTypeDef(TypedDict):
    networkSettingsArn: str,
    portalArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AssociateTrustStoreResponseTypeDef#

# AssociateTrustStoreResponseTypeDef definition

class AssociateTrustStoreResponseTypeDef(TypedDict):
    portalArn: str,
    trustStoreArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AssociateUserAccessLoggingSettingsResponseTypeDef#

# AssociateUserAccessLoggingSettingsResponseTypeDef definition

class AssociateUserAccessLoggingSettingsResponseTypeDef(TypedDict):
    portalArn: str,
    userAccessLoggingSettingsArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AssociateUserSettingsResponseTypeDef#

# AssociateUserSettingsResponseTypeDef definition

class AssociateUserSettingsResponseTypeDef(TypedDict):
    portalArn: str,
    userSettingsArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBrowserSettingsResponseTypeDef#

# CreateBrowserSettingsResponseTypeDef definition

class CreateBrowserSettingsResponseTypeDef(TypedDict):
    browserSettingsArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateIdentityProviderResponseTypeDef#

# CreateIdentityProviderResponseTypeDef definition

class CreateIdentityProviderResponseTypeDef(TypedDict):
    identityProviderArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateIpAccessSettingsResponseTypeDef#

# CreateIpAccessSettingsResponseTypeDef definition

class CreateIpAccessSettingsResponseTypeDef(TypedDict):
    ipAccessSettingsArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateNetworkSettingsResponseTypeDef#

# CreateNetworkSettingsResponseTypeDef definition

class CreateNetworkSettingsResponseTypeDef(TypedDict):
    networkSettingsArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePortalResponseTypeDef#

# CreatePortalResponseTypeDef definition

class CreatePortalResponseTypeDef(TypedDict):
    portalArn: str,
    portalEndpoint: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTrustStoreResponseTypeDef#

# CreateTrustStoreResponseTypeDef definition

class CreateTrustStoreResponseTypeDef(TypedDict):
    trustStoreArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateUserAccessLoggingSettingsResponseTypeDef#

# CreateUserAccessLoggingSettingsResponseTypeDef definition

class CreateUserAccessLoggingSettingsResponseTypeDef(TypedDict):
    userAccessLoggingSettingsArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateUserSettingsResponseTypeDef#

# CreateUserSettingsResponseTypeDef definition

class CreateUserSettingsResponseTypeDef(TypedDict):
    userSettingsArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetPortalServiceProviderMetadataResponseTypeDef#

# GetPortalServiceProviderMetadataResponseTypeDef definition

class GetPortalServiceProviderMetadataResponseTypeDef(TypedDict):
    portalArn: str,
    serviceProviderSamlMetadata: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateTrustStoreResponseTypeDef#

# UpdateTrustStoreResponseTypeDef definition

class UpdateTrustStoreResponseTypeDef(TypedDict):
    trustStoreArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateTrustStoreRequestRequestTypeDef#

# UpdateTrustStoreRequestRequestTypeDef definition

class UpdateTrustStoreRequestRequestTypeDef(TypedDict):
    trustStoreArn: str,
    certificatesToAdd: NotRequired[Sequence[Union[str, bytes, IO[Any], StreamingBody]]],
    certificatesToDelete: NotRequired[Sequence[str]],
    clientToken: NotRequired[str],

ListBrowserSettingsResponseTypeDef#

# ListBrowserSettingsResponseTypeDef definition

class ListBrowserSettingsResponseTypeDef(TypedDict):
    browserSettings: List[BrowserSettingsSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BrowserSettingsSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetBrowserSettingsResponseTypeDef#

# GetBrowserSettingsResponseTypeDef definition

class GetBrowserSettingsResponseTypeDef(TypedDict):
    browserSettings: BrowserSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BrowserSettingsTypeDef
  2. See ResponseMetadataTypeDef

UpdateBrowserSettingsResponseTypeDef#

# UpdateBrowserSettingsResponseTypeDef definition

class UpdateBrowserSettingsResponseTypeDef(TypedDict):
    browserSettings: BrowserSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BrowserSettingsTypeDef
  2. See ResponseMetadataTypeDef

ListTrustStoreCertificatesResponseTypeDef#

# ListTrustStoreCertificatesResponseTypeDef definition

class ListTrustStoreCertificatesResponseTypeDef(TypedDict):
    certificateList: List[CertificateSummaryTypeDef],  # (1)
    nextToken: str,
    trustStoreArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CertificateSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetTrustStoreCertificateResponseTypeDef#

# GetTrustStoreCertificateResponseTypeDef definition

class GetTrustStoreCertificateResponseTypeDef(TypedDict):
    certificate: CertificateTypeDef,  # (1)
    trustStoreArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CertificateTypeDef
  2. See ResponseMetadataTypeDef

CookieSynchronizationConfigurationTypeDef#

# CookieSynchronizationConfigurationTypeDef definition

class CookieSynchronizationConfigurationTypeDef(TypedDict):
    allowlist: Sequence[CookieSpecificationTypeDef],  # (1)
    blocklist: NotRequired[Sequence[CookieSpecificationTypeDef]],  # (1)
  1. See CookieSpecificationTypeDef
  2. See CookieSpecificationTypeDef

CreateBrowserSettingsRequestRequestTypeDef#

# CreateBrowserSettingsRequestRequestTypeDef definition

class CreateBrowserSettingsRequestRequestTypeDef(TypedDict):
    browserPolicy: str,
    additionalEncryptionContext: NotRequired[Mapping[str, str]],
    clientToken: NotRequired[str],
    customerManagedKey: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateNetworkSettingsRequestRequestTypeDef#

# CreateNetworkSettingsRequestRequestTypeDef definition

class CreateNetworkSettingsRequestRequestTypeDef(TypedDict):
    securityGroupIds: Sequence[str],
    subnetIds: Sequence[str],
    vpcId: str,
    clientToken: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreatePortalRequestRequestTypeDef#

# CreatePortalRequestRequestTypeDef definition

class CreatePortalRequestRequestTypeDef(TypedDict):
    additionalEncryptionContext: NotRequired[Mapping[str, str]],
    authenticationType: NotRequired[AuthenticationTypeType],  # (1)
    clientToken: NotRequired[str],
    customerManagedKey: NotRequired[str],
    displayName: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See AuthenticationTypeType
  2. See TagTypeDef

CreateTrustStoreRequestRequestTypeDef#

# CreateTrustStoreRequestRequestTypeDef definition

class CreateTrustStoreRequestRequestTypeDef(TypedDict):
    certificateList: Sequence[Union[str, bytes, IO[Any], StreamingBody]],
    clientToken: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateUserAccessLoggingSettingsRequestRequestTypeDef#

# CreateUserAccessLoggingSettingsRequestRequestTypeDef definition

class CreateUserAccessLoggingSettingsRequestRequestTypeDef(TypedDict):
    kinesisStreamArn: str,
    clientToken: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
    clientToken: NotRequired[str],
  1. See TagTypeDef

CreateIpAccessSettingsRequestRequestTypeDef#

# CreateIpAccessSettingsRequestRequestTypeDef definition

class CreateIpAccessSettingsRequestRequestTypeDef(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)
  1. See IpRuleTypeDef
  2. See TagTypeDef

IpAccessSettingsTypeDef#

# IpAccessSettingsTypeDef definition

class IpAccessSettingsTypeDef(TypedDict):
    ipAccessSettingsArn: str,
    associatedPortalArns: NotRequired[List[str]],
    creationDate: NotRequired[datetime],
    description: NotRequired[str],
    displayName: NotRequired[str],
    ipRules: NotRequired[List[IpRuleTypeDef]],  # (1)
  1. See IpRuleTypeDef

UpdateIpAccessSettingsRequestRequestTypeDef#

# UpdateIpAccessSettingsRequestRequestTypeDef definition

class UpdateIpAccessSettingsRequestRequestTypeDef(TypedDict):
    ipAccessSettingsArn: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],
    displayName: NotRequired[str],
    ipRules: NotRequired[Sequence[IpRuleTypeDef]],  # (1)
  1. See IpRuleTypeDef

GetIdentityProviderResponseTypeDef#

# GetIdentityProviderResponseTypeDef definition

class GetIdentityProviderResponseTypeDef(TypedDict):
    identityProvider: IdentityProviderTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IdentityProviderTypeDef
  2. See ResponseMetadataTypeDef

UpdateIdentityProviderResponseTypeDef#

# UpdateIdentityProviderResponseTypeDef definition

class UpdateIdentityProviderResponseTypeDef(TypedDict):
    identityProvider: IdentityProviderTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IdentityProviderTypeDef
  2. See ResponseMetadataTypeDef

GetNetworkSettingsResponseTypeDef#

# GetNetworkSettingsResponseTypeDef definition

class GetNetworkSettingsResponseTypeDef(TypedDict):
    networkSettings: NetworkSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NetworkSettingsTypeDef
  2. See ResponseMetadataTypeDef

UpdateNetworkSettingsResponseTypeDef#

# UpdateNetworkSettingsResponseTypeDef definition

class UpdateNetworkSettingsResponseTypeDef(TypedDict):
    networkSettings: NetworkSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NetworkSettingsTypeDef
  2. See ResponseMetadataTypeDef

GetPortalResponseTypeDef#

# GetPortalResponseTypeDef definition

class GetPortalResponseTypeDef(TypedDict):
    portal: PortalTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PortalTypeDef
  2. See ResponseMetadataTypeDef

UpdatePortalResponseTypeDef#

# UpdatePortalResponseTypeDef definition

class UpdatePortalResponseTypeDef(TypedDict):
    portal: PortalTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PortalTypeDef
  2. See ResponseMetadataTypeDef

GetTrustStoreResponseTypeDef#

# GetTrustStoreResponseTypeDef definition

class GetTrustStoreResponseTypeDef(TypedDict):
    trustStore: TrustStoreTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TrustStoreTypeDef
  2. See ResponseMetadataTypeDef

GetUserAccessLoggingSettingsResponseTypeDef#

# GetUserAccessLoggingSettingsResponseTypeDef definition

class GetUserAccessLoggingSettingsResponseTypeDef(TypedDict):
    userAccessLoggingSettings: UserAccessLoggingSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserAccessLoggingSettingsTypeDef
  2. See ResponseMetadataTypeDef

UpdateUserAccessLoggingSettingsResponseTypeDef#

# UpdateUserAccessLoggingSettingsResponseTypeDef definition

class UpdateUserAccessLoggingSettingsResponseTypeDef(TypedDict):
    userAccessLoggingSettings: UserAccessLoggingSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserAccessLoggingSettingsTypeDef
  2. See ResponseMetadataTypeDef

ListIdentityProvidersResponseTypeDef#

# ListIdentityProvidersResponseTypeDef definition

class ListIdentityProvidersResponseTypeDef(TypedDict):
    identityProviders: List[IdentityProviderSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IdentityProviderSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListIpAccessSettingsResponseTypeDef#

# ListIpAccessSettingsResponseTypeDef definition

class ListIpAccessSettingsResponseTypeDef(TypedDict):
    ipAccessSettings: List[IpAccessSettingsSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IpAccessSettingsSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListNetworkSettingsResponseTypeDef#

# ListNetworkSettingsResponseTypeDef definition

class ListNetworkSettingsResponseTypeDef(TypedDict):
    networkSettings: List[NetworkSettingsSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NetworkSettingsSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListPortalsResponseTypeDef#

# ListPortalsResponseTypeDef definition

class ListPortalsResponseTypeDef(TypedDict):
    nextToken: str,
    portals: List[PortalSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PortalSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTrustStoresResponseTypeDef#

# ListTrustStoresResponseTypeDef definition

class ListTrustStoresResponseTypeDef(TypedDict):
    nextToken: str,
    trustStores: List[TrustStoreSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TrustStoreSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListUserAccessLoggingSettingsResponseTypeDef#

# ListUserAccessLoggingSettingsResponseTypeDef definition

class ListUserAccessLoggingSettingsResponseTypeDef(TypedDict):
    nextToken: str,
    userAccessLoggingSettings: List[UserAccessLoggingSettingsSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserAccessLoggingSettingsSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateUserSettingsRequestRequestTypeDef#

# CreateUserSettingsRequestRequestTypeDef definition

class CreateUserSettingsRequestRequestTypeDef(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[CookieSynchronizationConfigurationTypeDef],  # (6)
    customerManagedKey: NotRequired[str],
    disconnectTimeoutInMinutes: NotRequired[int],
    idleDisconnectTimeoutInMinutes: NotRequired[int],
    tags: NotRequired[Sequence[TagTypeDef]],  # (7)
  1. See EnabledTypeType
  2. See EnabledTypeType
  3. See EnabledTypeType
  4. See EnabledTypeType
  5. See EnabledTypeType
  6. See CookieSynchronizationConfigurationTypeDef
  7. See TagTypeDef

UpdateUserSettingsRequestRequestTypeDef#

# UpdateUserSettingsRequestRequestTypeDef definition

class UpdateUserSettingsRequestRequestTypeDef(TypedDict):
    userSettingsArn: str,
    clientToken: NotRequired[str],
    cookieSynchronizationConfiguration: NotRequired[CookieSynchronizationConfigurationTypeDef],  # (1)
    copyAllowed: NotRequired[EnabledTypeType],  # (2)
    disconnectTimeoutInMinutes: NotRequired[int],
    downloadAllowed: NotRequired[EnabledTypeType],  # (2)
    idleDisconnectTimeoutInMinutes: NotRequired[int],
    pasteAllowed: NotRequired[EnabledTypeType],  # (2)
    printAllowed: NotRequired[EnabledTypeType],  # (2)
    uploadAllowed: NotRequired[EnabledTypeType],  # (2)
  1. See CookieSynchronizationConfigurationTypeDef
  2. See EnabledTypeType
  3. See EnabledTypeType
  4. See EnabledTypeType
  5. See EnabledTypeType
  6. See EnabledTypeType

UserSettingsSummaryTypeDef#

# UserSettingsSummaryTypeDef definition

class UserSettingsSummaryTypeDef(TypedDict):
    userSettingsArn: str,
    cookieSynchronizationConfiguration: NotRequired[CookieSynchronizationConfigurationTypeDef],  # (1)
    copyAllowed: NotRequired[EnabledTypeType],  # (2)
    disconnectTimeoutInMinutes: NotRequired[int],
    downloadAllowed: NotRequired[EnabledTypeType],  # (2)
    idleDisconnectTimeoutInMinutes: NotRequired[int],
    pasteAllowed: NotRequired[EnabledTypeType],  # (2)
    printAllowed: NotRequired[EnabledTypeType],  # (2)
    uploadAllowed: NotRequired[EnabledTypeType],  # (2)
  1. See CookieSynchronizationConfigurationTypeDef
  2. See EnabledTypeType
  3. See EnabledTypeType
  4. See EnabledTypeType
  5. See EnabledTypeType
  6. See EnabledTypeType

UserSettingsTypeDef#

# UserSettingsTypeDef definition

class UserSettingsTypeDef(TypedDict):
    userSettingsArn: str,
    associatedPortalArns: NotRequired[List[str]],
    cookieSynchronizationConfiguration: NotRequired[CookieSynchronizationConfigurationTypeDef],  # (1)
    copyAllowed: NotRequired[EnabledTypeType],  # (2)
    disconnectTimeoutInMinutes: NotRequired[int],
    downloadAllowed: NotRequired[EnabledTypeType],  # (2)
    idleDisconnectTimeoutInMinutes: NotRequired[int],
    pasteAllowed: NotRequired[EnabledTypeType],  # (2)
    printAllowed: NotRequired[EnabledTypeType],  # (2)
    uploadAllowed: NotRequired[EnabledTypeType],  # (2)
  1. See CookieSynchronizationConfigurationTypeDef
  2. See EnabledTypeType
  3. See EnabledTypeType
  4. See EnabledTypeType
  5. See EnabledTypeType
  6. See EnabledTypeType

GetIpAccessSettingsResponseTypeDef#

# GetIpAccessSettingsResponseTypeDef definition

class GetIpAccessSettingsResponseTypeDef(TypedDict):
    ipAccessSettings: IpAccessSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IpAccessSettingsTypeDef
  2. See ResponseMetadataTypeDef

UpdateIpAccessSettingsResponseTypeDef#

# UpdateIpAccessSettingsResponseTypeDef definition

class UpdateIpAccessSettingsResponseTypeDef(TypedDict):
    ipAccessSettings: IpAccessSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IpAccessSettingsTypeDef
  2. See ResponseMetadataTypeDef

ListUserSettingsResponseTypeDef#

# ListUserSettingsResponseTypeDef definition

class ListUserSettingsResponseTypeDef(TypedDict):
    nextToken: str,
    userSettings: List[UserSettingsSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserSettingsSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetUserSettingsResponseTypeDef#

# GetUserSettingsResponseTypeDef definition

class GetUserSettingsResponseTypeDef(TypedDict):
    userSettings: UserSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserSettingsTypeDef
  2. See ResponseMetadataTypeDef

UpdateUserSettingsResponseTypeDef#

# UpdateUserSettingsResponseTypeDef definition

class UpdateUserSettingsResponseTypeDef(TypedDict):
    userSettings: UserSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserSettingsTypeDef
  2. See ResponseMetadataTypeDef