Skip to content

Workspaces Web Classes

AssociateBrowserSettingsRequest

browserSettingsArn

  • Type:
  • Required: Yes

portalArn

  • Type:
  • Required: Yes

AssociateBrowserSettingsResponse

browserSettingsArn

  • Type:
  • Required: Yes

portalArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AssociateDataProtectionSettingsRequest

dataProtectionSettingsArn

  • Type:
  • Required: Yes

portalArn

  • Type:
  • Required: Yes

AssociateDataProtectionSettingsResponse

dataProtectionSettingsArn

  • Type:
  • Required: Yes

portalArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AssociateIpAccessSettingsRequest

ipAccessSettingsArn

  • Type:
  • Required: Yes

portalArn

  • Type:
  • Required: Yes

AssociateIpAccessSettingsResponse

ipAccessSettingsArn

  • Type:
  • Required: Yes

portalArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AssociateNetworkSettingsRequest

networkSettingsArn

  • Type:
  • Required: Yes

portalArn

  • Type:
  • Required: Yes

AssociateNetworkSettingsResponse

networkSettingsArn

  • Type:
  • Required: Yes

portalArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AssociateTrustStoreRequest

portalArn

  • Type:
  • Required: Yes

trustStoreArn

  • Type:
  • Required: Yes

AssociateTrustStoreResponse

portalArn

  • Type:
  • Required: Yes

trustStoreArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AssociateUserAccessLoggingSettingsRequest

portalArn

  • Type:
  • Required: Yes

userAccessLoggingSettingsArn

  • Type:
  • Required: Yes

AssociateUserAccessLoggingSettingsResponse

portalArn

  • Type:
  • Required: Yes

userAccessLoggingSettingsArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AssociateUserSettingsRequest

portalArn

  • Type:
  • Required: Yes

userSettingsArn

  • Type:
  • Required: Yes

AssociateUserSettingsResponse

portalArn

  • Type:
  • Required: Yes

userSettingsArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BrowserSettings

browserSettingsArn

  • Type:
  • Required: Yes

additionalEncryptionContext

  • Type: typing.Optional[typing.Dict[str, str]]

associatedPortalArns

  • Type: typing.Optional[typing.List[str]]

browserPolicy

  • Type: typing.Optional[str]

customerManagedKey

  • Type: typing.Optional[str]

BrowserSettingsSummary

browserSettingsArn

  • Type:
  • Required: Yes

Certificate

body

  • Type: typing.Optional[bytes]

issuer

  • Type: typing.Optional[str]

notValidAfter

  • Type: typing.Optional[datetime.datetime]

notValidBefore

  • Type: typing.Optional[datetime.datetime]

subject

  • Type: typing.Optional[str]

thumbprint

  • Type: typing.Optional[str]

CertificateSummary

issuer

  • Type: typing.Optional[str]

notValidAfter

  • Type: typing.Optional[datetime.datetime]

notValidBefore

  • Type: typing.Optional[datetime.datetime]

subject

  • Type: typing.Optional[str]

thumbprint

  • Type: typing.Optional[str]

CookieSpecification

domain

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

path

  • Type: typing.Optional[str]

CookieSynchronizationConfiguration

allowlist

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.CookieSpecification]
  • Required: Yes

blocklist

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.CookieSpecification]]

CookieSynchronizationConfigurationOutput

allowlist

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.CookieSpecification]
  • Required: Yes

blocklist

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.CookieSpecification]]

CreateBrowserSettingsRequest

browserPolicy

  • Type:
  • Required: Yes

additionalEncryptionContext

  • Type: typing.Optional[typing.Dict[str, str]]

clientToken

  • Type: typing.Optional[str]

customerManagedKey

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.Tag]]

CreateBrowserSettingsResponse

browserSettingsArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDataProtectionSettingsRequest

additionalEncryptionContext

  • Type: typing.Optional[typing.Dict[str, str]]

clientToken

  • Type: typing.Optional[str]

customerManagedKey

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

inlineRedactionConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.InlineRedactionConfiguration, aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.InlineRedactionConfigurationOutput, NoneType]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.Tag]]

CreateDataProtectionSettingsResponse

dataProtectionSettingsArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateIdentityProviderRequest

identityProviderDetails

  • Type: typing.Dict[str, str]
  • Required: Yes

identityProviderName

  • Type:
  • Required: Yes

identityProviderType

  • Type: typing.Literal['Facebook', 'Google', 'LoginWithAmazon', 'OIDC', 'SAML', 'SignInWithApple']
  • Required: Yes

portalArn

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.Tag]]

CreateIdentityProviderResponse

identityProviderArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateIpAccessSettingsRequest

ipRules

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.IpRule]
  • Required: Yes

additionalEncryptionContext

  • Type: typing.Optional[typing.Dict[str, str]]

clientToken

  • Type: typing.Optional[str]

customerManagedKey

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.Tag]]

CreateIpAccessSettingsResponse

ipAccessSettingsArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateNetworkSettingsRequest

securityGroupIds

  • Type: typing.List[str]
  • Required: Yes

subnetIds

  • Type: typing.List[str]
  • Required: Yes

vpcId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.Tag]]

CreateNetworkSettingsResponse

networkSettingsArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreatePortalRequest

additionalEncryptionContext

  • Type: typing.Optional[typing.Dict[str, str]]

authenticationType

  • Type: typing.Optional[typing.Literal['IAM_Identity_Center', 'Standard']]

clientToken

  • Type: typing.Optional[str]

customerManagedKey

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

instanceType

  • Type: typing.Optional[typing.Literal['standard.large', 'standard.regular', 'standard.xlarge']]

maxConcurrentSessions

  • Type: typing.Optional[int]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.Tag]]

CreatePortalResponse

portalArn

  • Type:
  • Required: Yes

portalEndpoint

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateTrustStoreRequest

certificateList

  • Type: typing.List[typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody]]
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.Tag]]

CreateTrustStoreResponse

trustStoreArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateUserAccessLoggingSettingsRequest

kinesisStreamArn

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.Tag]]

CreateUserAccessLoggingSettingsResponse

userAccessLoggingSettingsArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateUserSettingsRequest

copyAllowed

  • Type: typing.Literal['Disabled', 'Enabled']
  • Required: Yes

downloadAllowed

  • Type: typing.Literal['Disabled', 'Enabled']
  • Required: Yes

pasteAllowed

  • Type: typing.Literal['Disabled', 'Enabled']
  • Required: Yes

printAllowed

  • Type: typing.Literal['Disabled', 'Enabled']
  • Required: Yes

uploadAllowed

  • Type: typing.Literal['Disabled', 'Enabled']
  • Required: Yes

additionalEncryptionContext

  • Type: typing.Optional[typing.Dict[str, str]]

clientToken

  • Type: typing.Optional[str]

cookieSynchronizationConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.CookieSynchronizationConfiguration, aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.CookieSynchronizationConfigurationOutput, NoneType]

customerManagedKey

  • Type: typing.Optional[str]

deepLinkAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

disconnectTimeoutInMinutes

  • Type: typing.Optional[int]

idleDisconnectTimeoutInMinutes

  • Type: typing.Optional[int]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.Tag]]

toolbarConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.ToolbarConfiguration, aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.ToolbarConfigurationOutput, NoneType]

CreateUserSettingsResponse

userSettingsArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CustomPattern

patternName

  • Type:
  • Required: Yes

patternRegex

  • Type:
  • Required: Yes

keywordRegex

  • Type: typing.Optional[str]

patternDescription

  • Type: typing.Optional[str]

DataProtectionSettings

dataProtectionSettingsArn

  • Type:
  • Required: Yes

additionalEncryptionContext

  • Type: typing.Optional[typing.Dict[str, str]]

associatedPortalArns

  • Type: typing.Optional[typing.List[str]]

creationDate

  • Type: typing.Optional[datetime.datetime]

customerManagedKey

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

inlineRedactionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.InlineRedactionConfigurationOutput]

DataProtectionSettingsSummary

dataProtectionSettingsArn

  • Type:
  • Required: Yes

creationDate

  • Type: typing.Optional[datetime.datetime]

description

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

DeleteBrowserSettingsRequest

browserSettingsArn

  • Type:
  • Required: Yes

DeleteDataProtectionSettingsRequest

dataProtectionSettingsArn

  • Type:
  • Required: Yes

DeleteIdentityProviderRequest

identityProviderArn

  • Type:
  • Required: Yes

DeleteIpAccessSettingsRequest

ipAccessSettingsArn

  • Type:
  • Required: Yes

DeleteNetworkSettingsRequest

networkSettingsArn

  • Type:
  • Required: Yes

DeletePortalRequest

portalArn

  • Type:
  • Required: Yes

DeleteTrustStoreRequest

trustStoreArn

  • Type:
  • Required: Yes

DeleteUserAccessLoggingSettingsRequest

userAccessLoggingSettingsArn

  • Type:
  • Required: Yes

DeleteUserSettingsRequest

userSettingsArn

  • Type:
  • Required: Yes

DisassociateBrowserSettingsRequest

portalArn

  • Type:
  • Required: Yes

DisassociateDataProtectionSettingsRequest

portalArn

  • Type:
  • Required: Yes

DisassociateIpAccessSettingsRequest

portalArn

  • Type:
  • Required: Yes

DisassociateNetworkSettingsRequest

portalArn

  • Type:
  • Required: Yes

DisassociateTrustStoreRequest

portalArn

  • Type:
  • Required: Yes

DisassociateUserAccessLoggingSettingsRequest

portalArn

  • Type:
  • Required: Yes

DisassociateUserSettingsRequest

portalArn

  • Type:
  • Required: Yes

ExpireSessionRequest

portalId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

GetBrowserSettingsRequest

browserSettingsArn

  • Type:
  • Required: Yes

GetBrowserSettingsResponse

browserSettings

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDataProtectionSettingsRequest

dataProtectionSettingsArn

  • Type:
  • Required: Yes

GetDataProtectionSettingsResponse

dataProtectionSettings

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetIdentityProviderRequest

identityProviderArn

  • Type:
  • Required: Yes

GetIdentityProviderResponse

identityProvider

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetIpAccessSettingsRequest

ipAccessSettingsArn

  • Type:
  • Required: Yes

GetIpAccessSettingsResponse

ipAccessSettings

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetNetworkSettingsRequest

networkSettingsArn

  • Type:
  • Required: Yes

GetNetworkSettingsResponse

networkSettings

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetPortalRequest

portalArn

  • Type:
  • Required: Yes

GetPortalResponse

portal

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetPortalServiceProviderMetadataRequest

portalArn

  • Type:
  • Required: Yes

GetPortalServiceProviderMetadataResponse

portalArn

  • Type:
  • Required: Yes

serviceProviderSamlMetadata

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSessionRequest

portalId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

GetSessionResponse

session

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetTrustStoreCertificateRequest

thumbprint

  • Type:
  • Required: Yes

trustStoreArn

  • Type:
  • Required: Yes

GetTrustStoreCertificateResponse

certificate

  • Type:
  • Required: Yes

trustStoreArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetTrustStoreRequest

trustStoreArn

  • Type:
  • Required: Yes

GetTrustStoreResponse

trustStore

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetUserAccessLoggingSettingsRequest

userAccessLoggingSettingsArn

  • Type:
  • Required: Yes

GetUserAccessLoggingSettingsResponse

userAccessLoggingSettings

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetUserSettingsRequest

userSettingsArn

  • Type:
  • Required: Yes

GetUserSettingsResponse

userSettings

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

IdentityProvider

identityProviderArn

  • Type:
  • Required: Yes

identityProviderDetails

  • Type: typing.Optional[typing.Dict[str, str]]

identityProviderName

  • Type: typing.Optional[str]

identityProviderType

  • Type: typing.Optional[typing.Literal['Facebook', 'Google', 'LoginWithAmazon', 'OIDC', 'SAML', 'SignInWithApple']]

IdentityProviderSummary

identityProviderArn

  • Type:
  • Required: Yes

identityProviderName

  • Type: typing.Optional[str]

identityProviderType

  • Type: typing.Optional[typing.Literal['Facebook', 'Google', 'LoginWithAmazon', 'OIDC', 'SAML', 'SignInWithApple']]

InlineRedactionConfiguration

inlineRedactionPatterns

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.InlineRedactionPattern]
  • Required: Yes

globalConfidenceLevel

  • Type: typing.Optional[int]

globalEnforcedUrls

  • Type: typing.Optional[typing.List[str]]

globalExemptUrls

  • Type: typing.Optional[typing.List[str]]

InlineRedactionConfigurationOutput

inlineRedactionPatterns

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.InlineRedactionPatternOutput]
  • Required: Yes

globalConfidenceLevel

  • Type: typing.Optional[int]

globalEnforcedUrls

  • Type: typing.Optional[typing.List[str]]

globalExemptUrls

  • Type: typing.Optional[typing.List[str]]

InlineRedactionPattern

redactionPlaceHolder

  • Type:
  • Required: Yes

builtInPatternId

  • Type: typing.Optional[str]

confidenceLevel

  • Type: typing.Optional[int]

customPattern

  • Type: typing.Optional[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.CustomPattern]

enforcedUrls

  • Type: typing.Optional[typing.List[str]]

exemptUrls

  • Type: typing.Optional[typing.List[str]]

InlineRedactionPatternOutput

redactionPlaceHolder

  • Type:
  • Required: Yes

builtInPatternId

  • Type: typing.Optional[str]

confidenceLevel

  • Type: typing.Optional[int]

customPattern

  • Type: typing.Optional[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.CustomPattern]

enforcedUrls

  • Type: typing.Optional[typing.List[str]]

exemptUrls

  • Type: typing.Optional[typing.List[str]]

IpAccessSettings

ipAccessSettingsArn

  • Type:
  • Required: Yes

additionalEncryptionContext

  • Type: typing.Optional[typing.Dict[str, str]]

associatedPortalArns

  • Type: typing.Optional[typing.List[str]]

creationDate

  • Type: typing.Optional[datetime.datetime]

customerManagedKey

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

ipRules

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.IpRule]]

IpAccessSettingsSummary

ipAccessSettingsArn

  • Type:
  • Required: Yes

creationDate

  • Type: typing.Optional[datetime.datetime]

description

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

IpRule

ipRange

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

ListBrowserSettingsRequest

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListBrowserSettingsResponse

browserSettings

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.BrowserSettingsSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDataProtectionSettingsRequest

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListDataProtectionSettingsRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.PaginatorConfig]

ListDataProtectionSettingsResponse

dataProtectionSettings

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.DataProtectionSettingsSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListIdentityProvidersRequest

portalArn

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListIdentityProvidersResponse

identityProviders

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.IdentityProviderSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListIpAccessSettingsRequest

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListIpAccessSettingsResponse

ipAccessSettings

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.IpAccessSettingsSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListNetworkSettingsRequest

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListNetworkSettingsResponse

networkSettings

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.NetworkSettingsSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListPortalsRequest

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListPortalsResponse

portals

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.PortalSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListSessionsRequest

portalId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

sessionId

  • Type: typing.Optional[str]

sortBy

  • Type: typing.Optional[typing.Literal['StartTimeAscending', 'StartTimeDescending']]

status

  • Type: typing.Optional[typing.Literal['Active', 'Terminated']]

username

  • Type: typing.Optional[str]

ListSessionsRequestPaginate

portalId

  • Type:
  • Required: Yes

sessionId

  • Type: typing.Optional[str]

sortBy

  • Type: typing.Optional[typing.Literal['StartTimeAscending', 'StartTimeDescending']]

status

  • Type: typing.Optional[typing.Literal['Active', 'Terminated']]

username

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.PaginatorConfig]

ListSessionsResponse

sessions

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.SessionSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

tags

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.Tag]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTrustStoreCertificatesRequest

trustStoreArn

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListTrustStoreCertificatesResponse

certificateList

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.CertificateSummary]
  • Required: Yes

trustStoreArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTrustStoresRequest

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListTrustStoresResponse

trustStores

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.TrustStoreSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListUserAccessLoggingSettingsRequest

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListUserAccessLoggingSettingsResponse

userAccessLoggingSettings

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.UserAccessLoggingSettingsSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListUserSettingsRequest

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListUserSettingsResponse

userSettings

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.UserSettingsSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

NetworkSettings

networkSettingsArn

  • Type:
  • Required: Yes

associatedPortalArns

  • Type: typing.Optional[typing.List[str]]

securityGroupIds

  • Type: typing.Optional[typing.List[str]]

subnetIds

  • Type: typing.Optional[typing.List[str]]

vpcId

  • Type: typing.Optional[str]

NetworkSettingsSummary

networkSettingsArn

  • Type:
  • Required: Yes

vpcId

  • Type: typing.Optional[str]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

Portal

portalArn

  • Type:
  • Required: Yes

additionalEncryptionContext

  • Type: typing.Optional[typing.Dict[str, str]]

authenticationType

  • Type: typing.Optional[typing.Literal['IAM_Identity_Center', 'Standard']]

browserSettingsArn

  • Type: typing.Optional[str]

browserType

  • Type: typing.Optional[typing.Literal['Chrome']]

creationDate

  • Type: typing.Optional[datetime.datetime]

customerManagedKey

  • Type: typing.Optional[str]

dataProtectionSettingsArn

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

instanceType

  • Type: typing.Optional[typing.Literal['standard.large', 'standard.regular', 'standard.xlarge']]

ipAccessSettingsArn

  • Type: typing.Optional[str]

maxConcurrentSessions

  • Type: typing.Optional[int]

networkSettingsArn

  • Type: typing.Optional[str]

portalEndpoint

  • Type: typing.Optional[str]

portalStatus

  • Type: typing.Optional[typing.Literal['Active', 'Incomplete', 'Pending']]

rendererType

  • Type: typing.Optional[typing.Literal['AppStream']]

statusReason

  • Type: typing.Optional[str]

trustStoreArn

  • Type: typing.Optional[str]

userAccessLoggingSettingsArn

  • Type: typing.Optional[str]

userSettingsArn

  • Type: typing.Optional[str]

PortalSummary

portalArn

  • Type:
  • Required: Yes

authenticationType

  • Type: typing.Optional[typing.Literal['IAM_Identity_Center', 'Standard']]

browserSettingsArn

  • Type: typing.Optional[str]

browserType

  • Type: typing.Optional[typing.Literal['Chrome']]

creationDate

  • Type: typing.Optional[datetime.datetime]

dataProtectionSettingsArn

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

instanceType

  • Type: typing.Optional[typing.Literal['standard.large', 'standard.regular', 'standard.xlarge']]

ipAccessSettingsArn

  • Type: typing.Optional[str]

maxConcurrentSessions

  • Type: typing.Optional[int]

networkSettingsArn

  • Type: typing.Optional[str]

portalEndpoint

  • Type: typing.Optional[str]

portalStatus

  • Type: typing.Optional[typing.Literal['Active', 'Incomplete', 'Pending']]

rendererType

  • Type: typing.Optional[typing.Literal['AppStream']]

trustStoreArn

  • Type: typing.Optional[str]

userAccessLoggingSettingsArn

  • Type: typing.Optional[str]

userSettingsArn

  • Type: typing.Optional[str]

RedactionPlaceHolder

redactionPlaceHolderType

  • Type: typing.Literal['CustomText']
  • Required: Yes

redactionPlaceHolderText

  • Type: typing.Optional[str]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

Session

clientIpAddresses

  • Type: typing.Optional[typing.List[str]]

endTime

  • Type: typing.Optional[datetime.datetime]

portalArn

  • Type: typing.Optional[str]

sessionId

  • Type: typing.Optional[str]

startTime

  • Type: typing.Optional[datetime.datetime]

status

  • Type: typing.Optional[typing.Literal['Active', 'Terminated']]

username

  • Type: typing.Optional[str]

SessionSummary

endTime

  • Type: typing.Optional[datetime.datetime]

portalArn

  • Type: typing.Optional[str]

sessionId

  • Type: typing.Optional[str]

startTime

  • Type: typing.Optional[datetime.datetime]

status

  • Type: typing.Optional[typing.Literal['Active', 'Terminated']]

username

  • Type: typing.Optional[str]

Tag

Key

  • Type:
  • Required: Yes

Value

  • Type:
  • Required: Yes

TagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.Tag]
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

ToolbarConfiguration

hiddenToolbarItems

  • Type: typing.Optional[typing.List[typing.Literal['DualMonitor', 'FullScreen', 'Microphone', 'Webcam', 'Windows']]]

maxDisplayResolution

  • Type: typing.Optional[typing.Literal['size1024X768', 'size1280X720', 'size1920X1080', 'size2560X1440', 'size3440X1440', 'size3840X2160', 'size4096X2160', 'size800X600']]

toolbarType

  • Type: typing.Optional[typing.Literal['Docked', 'Floating']]

visualMode

  • Type: typing.Optional[typing.Literal['Dark', 'Light']]

ToolbarConfigurationOutput

hiddenToolbarItems

  • Type: typing.Optional[typing.List[typing.Literal['DualMonitor', 'FullScreen', 'Microphone', 'Webcam', 'Windows']]]

maxDisplayResolution

  • Type: typing.Optional[typing.Literal['size1024X768', 'size1280X720', 'size1920X1080', 'size2560X1440', 'size3440X1440', 'size3840X2160', 'size4096X2160', 'size800X600']]

toolbarType

  • Type: typing.Optional[typing.Literal['Docked', 'Floating']]

visualMode

  • Type: typing.Optional[typing.Literal['Dark', 'Light']]

TrustStore

trustStoreArn

  • Type:
  • Required: Yes

associatedPortalArns

  • Type: typing.Optional[typing.List[str]]

TrustStoreSummary

trustStoreArn

  • Type: typing.Optional[str]

UntagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateBrowserSettingsRequest

browserSettingsArn

  • Type:
  • Required: Yes

browserPolicy

  • Type: typing.Optional[str]

clientToken

  • Type: typing.Optional[str]

UpdateBrowserSettingsResponse

browserSettings

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateDataProtectionSettingsRequest

dataProtectionSettingsArn

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

inlineRedactionConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.InlineRedactionConfiguration, aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.InlineRedactionConfigurationOutput, NoneType]

UpdateDataProtectionSettingsResponse

dataProtectionSettings

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateIdentityProviderRequest

identityProviderArn

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

identityProviderDetails

  • Type: typing.Optional[typing.Dict[str, str]]

identityProviderName

  • Type: typing.Optional[str]

identityProviderType

  • Type: typing.Optional[typing.Literal['Facebook', 'Google', 'LoginWithAmazon', 'OIDC', 'SAML', 'SignInWithApple']]

UpdateIdentityProviderResponse

identityProvider

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateIpAccessSettingsRequest

ipAccessSettingsArn

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

ipRules

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.IpRule]]

UpdateIpAccessSettingsResponse

ipAccessSettings

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateNetworkSettingsRequest

networkSettingsArn

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

securityGroupIds

  • Type: typing.Optional[typing.List[str]]

subnetIds

  • Type: typing.Optional[typing.List[str]]

vpcId

  • Type: typing.Optional[str]

UpdateNetworkSettingsResponse

networkSettings

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdatePortalRequest

portalArn

  • Type:
  • Required: Yes

authenticationType

  • Type: typing.Optional[typing.Literal['IAM_Identity_Center', 'Standard']]

displayName

  • Type: typing.Optional[str]

instanceType

  • Type: typing.Optional[typing.Literal['standard.large', 'standard.regular', 'standard.xlarge']]

maxConcurrentSessions

  • Type: typing.Optional[int]

UpdatePortalResponse

portal

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateTrustStoreRequest

trustStoreArn

  • Type:
  • Required: Yes

certificatesToAdd

  • Type: typing.Optional[typing.List[typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody]]]

certificatesToDelete

  • Type: typing.Optional[typing.List[str]]

clientToken

  • Type: typing.Optional[str]

UpdateTrustStoreResponse

trustStoreArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateUserAccessLoggingSettingsRequest

userAccessLoggingSettingsArn

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

kinesisStreamArn

  • Type: typing.Optional[str]

UpdateUserAccessLoggingSettingsResponse

userAccessLoggingSettings

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateUserSettingsRequest

userSettingsArn

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

cookieSynchronizationConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.CookieSynchronizationConfiguration, aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.CookieSynchronizationConfigurationOutput, NoneType]

copyAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

deepLinkAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

disconnectTimeoutInMinutes

  • Type: typing.Optional[int]

downloadAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

idleDisconnectTimeoutInMinutes

  • Type: typing.Optional[int]

pasteAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

printAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

toolbarConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.ToolbarConfiguration, aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.ToolbarConfigurationOutput, NoneType]

uploadAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

UpdateUserSettingsResponse

userSettings

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UserAccessLoggingSettings

userAccessLoggingSettingsArn

  • Type:
  • Required: Yes

associatedPortalArns

  • Type: typing.Optional[typing.List[str]]

kinesisStreamArn

  • Type: typing.Optional[str]

UserAccessLoggingSettingsSummary

userAccessLoggingSettingsArn

  • Type:
  • Required: Yes

kinesisStreamArn

  • Type: typing.Optional[str]

UserSettings

userSettingsArn

  • Type:
  • Required: Yes

additionalEncryptionContext

  • Type: typing.Optional[typing.Dict[str, str]]

associatedPortalArns

  • Type: typing.Optional[typing.List[str]]

cookieSynchronizationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.CookieSynchronizationConfigurationOutput]

copyAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

customerManagedKey

  • Type: typing.Optional[str]

deepLinkAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

disconnectTimeoutInMinutes

  • Type: typing.Optional[int]

downloadAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

idleDisconnectTimeoutInMinutes

  • Type: typing.Optional[int]

pasteAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

printAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

toolbarConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.ToolbarConfigurationOutput]

uploadAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

UserSettingsSummary

userSettingsArn

  • Type:
  • Required: Yes

cookieSynchronizationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.CookieSynchronizationConfigurationOutput]

copyAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

deepLinkAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

disconnectTimeoutInMinutes

  • Type: typing.Optional[int]

downloadAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

idleDisconnectTimeoutInMinutes

  • Type: typing.Optional[int]

pasteAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

printAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

toolbarConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.workspaces_web.workspaces_web_classes.ToolbarConfigurationOutput]

uploadAllowed

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]