amazonka-workspaces-web-2.0: Amazon WorkSpaces Web SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WorkSpacesWeb.Lens

Description

 
Synopsis

Operations

AssociateBrowserSettings

AssociateNetworkSettings

AssociateTrustStore

AssociateUserAccessLoggingSettings

AssociateUserSettings

CreateBrowserSettings

createBrowserSettings_additionalEncryptionContext :: Lens' CreateBrowserSettings (Maybe (HashMap Text Text)) Source #

Additional encryption context of the browser settings.

createBrowserSettings_clientToken :: Lens' CreateBrowserSettings (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

createBrowserSettings_customerManagedKey :: Lens' CreateBrowserSettings (Maybe Text) Source #

The custom managed key of the browser settings.

createBrowserSettings_tags :: Lens' CreateBrowserSettings (Maybe [Tag]) Source #

The tags to add to the browser settings resource. A tag is a key-value pair.

createBrowserSettings_browserPolicy :: Lens' CreateBrowserSettings Text Source #

A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

CreateIdentityProvider

createIdentityProvider_clientToken :: Lens' CreateIdentityProvider (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

createIdentityProvider_identityProviderDetails :: Lens' CreateIdentityProvider (HashMap Text Text) Source #

The identity provider details. The following list describes the provider detail keys for each identity provider type.

  • For Google and Login with Amazon:

    • client_id
    • client_secret
    • authorize_scopes
  • For Facebook:

    • client_id
    • client_secret
    • authorize_scopes
    • api_version
  • For Sign in with Apple:

    • client_id
    • team_id
    • key_id
    • private_key
    • authorize_scopes
  • For OIDC providers:

    • client_id
    • client_secret
    • attributes_request_method
    • oidc_issuer
    • authorize_scopes
    • authorize_url /if not available from discovery URL specified by oidc_issuer key/
    • token_url /if not available from discovery URL specified by oidc_issuer key/
    • attributes_url /if not available from discovery URL specified by oidc_issuer key/
    • jwks_uri /if not available from discovery URL specified by oidc_issuer key/
  • For SAML providers:

    • MetadataFile OR MetadataURL
    • IDPSignout (boolean) optional

CreateNetworkSettings

createNetworkSettings_clientToken :: Lens' CreateNetworkSettings (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

createNetworkSettings_tags :: Lens' CreateNetworkSettings (Maybe [Tag]) Source #

The tags to add to the network settings resource. A tag is a key-value pair.

createNetworkSettings_securityGroupIds :: Lens' CreateNetworkSettings (NonEmpty Text) Source #

One or more security groups used to control access from streaming instances to your VPC.

createNetworkSettings_subnetIds :: Lens' CreateNetworkSettings (NonEmpty Text) Source #

The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

createNetworkSettings_vpcId :: Lens' CreateNetworkSettings Text Source #

The VPC that streaming instances will connect to.

CreatePortal

createPortal_additionalEncryptionContext :: Lens' CreatePortal (Maybe (HashMap Text Text)) Source #

The additional encryption context of the portal.

createPortal_clientToken :: Lens' CreatePortal (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

createPortal_customerManagedKey :: Lens' CreatePortal (Maybe Text) Source #

The customer managed key of the web portal.

createPortal_displayName :: Lens' CreatePortal (Maybe Text) Source #

The name of the web portal. This is not visible to users who log into the web portal.

createPortal_tags :: Lens' CreatePortal (Maybe [Tag]) Source #

The tags to add to the web portal. A tag is a key-value pair.

createPortalResponse_portalEndpoint :: Lens' CreatePortalResponse Text Source #

The endpoint URL of the web portal that users access in order to start streaming sessions.

CreateTrustStore

createTrustStore_clientToken :: Lens' CreateTrustStore (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

createTrustStore_tags :: Lens' CreateTrustStore (Maybe [Tag]) Source #

The tags to add to the trust store. A tag is a key-value pair.

createTrustStore_certificateList :: Lens' CreateTrustStore [ByteString] Source #

A list of CA certificates to be added to the trust store.

CreateUserAccessLoggingSettings

createUserAccessLoggingSettings_clientToken :: Lens' CreateUserAccessLoggingSettings (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

createUserAccessLoggingSettings_tags :: Lens' CreateUserAccessLoggingSettings (Maybe [Tag]) Source #

The tags to add to the user settings resource. A tag is a key-value pair.

CreateUserSettings

createUserSettings_clientToken :: Lens' CreateUserSettings (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

createUserSettings_disconnectTimeoutInMinutes :: Lens' CreateUserSettings (Maybe Natural) Source #

The amount of time that a streaming session remains active after users disconnect.

createUserSettings_idleDisconnectTimeoutInMinutes :: Lens' CreateUserSettings (Maybe Natural) Source #

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

createUserSettings_tags :: Lens' CreateUserSettings (Maybe [Tag]) Source #

The tags to add to the user settings resource. A tag is a key-value pair.

createUserSettings_copyAllowed :: Lens' CreateUserSettings EnabledType Source #

Specifies whether the user can copy text from the streaming session to the local device.

createUserSettings_downloadAllowed :: Lens' CreateUserSettings EnabledType Source #

Specifies whether the user can download files from the streaming session to the local device.

createUserSettings_pasteAllowed :: Lens' CreateUserSettings EnabledType Source #

Specifies whether the user can paste text from the local device to the streaming session.

createUserSettings_printAllowed :: Lens' CreateUserSettings EnabledType Source #

Specifies whether the user can print to the local device.

createUserSettings_uploadAllowed :: Lens' CreateUserSettings EnabledType Source #

Specifies whether the user can upload files from the local device to the streaming session.

DeleteBrowserSettings

DeleteIdentityProvider

DeleteNetworkSettings

DeletePortal

deletePortal_portalArn :: Lens' DeletePortal Text Source #

The ARN of the web portal.

DeleteTrustStore

DeleteUserAccessLoggingSettings

DeleteUserSettings

DisassociateBrowserSettings

DisassociateNetworkSettings

DisassociateTrustStore

DisassociateUserAccessLoggingSettings

DisassociateUserSettings

GetBrowserSettings

GetIdentityProvider

GetNetworkSettings

GetPortal

getPortal_portalArn :: Lens' GetPortal Text Source #

The ARN of the web portal.

getPortalResponse_httpStatus :: Lens' GetPortalResponse Int Source #

The response's http status code.

GetPortalServiceProviderMetadata

GetTrustStore

GetTrustStoreCertificate

getTrustStoreCertificate_thumbprint :: Lens' GetTrustStoreCertificate Text Source #

The thumbprint of the trust store certificate.

GetUserAccessLoggingSettings

GetUserSettings

ListBrowserSettings

listBrowserSettings_maxResults :: Lens' ListBrowserSettings (Maybe Natural) Source #

The maximum number of results to be included in the next page.

listBrowserSettings_nextToken :: Lens' ListBrowserSettings (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

listBrowserSettingsResponse_nextToken :: Lens' ListBrowserSettingsResponse (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

ListIdentityProviders

listIdentityProviders_maxResults :: Lens' ListIdentityProviders (Maybe Natural) Source #

The maximum number of results to be included in the next page.

listIdentityProviders_nextToken :: Lens' ListIdentityProviders (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

listIdentityProvidersResponse_nextToken :: Lens' ListIdentityProvidersResponse (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

ListNetworkSettings

listNetworkSettings_maxResults :: Lens' ListNetworkSettings (Maybe Natural) Source #

The maximum number of results to be included in the next page.

listNetworkSettings_nextToken :: Lens' ListNetworkSettings (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

listNetworkSettingsResponse_nextToken :: Lens' ListNetworkSettingsResponse (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

ListPortals

listPortals_maxResults :: Lens' ListPortals (Maybe Natural) Source #

The maximum number of results to be included in the next page.

listPortals_nextToken :: Lens' ListPortals (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

listPortalsResponse_nextToken :: Lens' ListPortalsResponse (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

ListTagsForResource

ListTrustStoreCertificates

listTrustStoreCertificates_maxResults :: Lens' ListTrustStoreCertificates (Maybe Natural) Source #

The maximum number of results to be included in the next page.

listTrustStoreCertificates_nextToken :: Lens' ListTrustStoreCertificates (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

listTrustStoreCertificatesResponse_nextToken :: Lens' ListTrustStoreCertificatesResponse (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.>

ListTrustStores

listTrustStores_maxResults :: Lens' ListTrustStores (Maybe Natural) Source #

The maximum number of results to be included in the next page.

listTrustStores_nextToken :: Lens' ListTrustStores (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

listTrustStoresResponse_nextToken :: Lens' ListTrustStoresResponse (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

ListUserAccessLoggingSettings

listUserAccessLoggingSettings_maxResults :: Lens' ListUserAccessLoggingSettings (Maybe Natural) Source #

The maximum number of results to be included in the next page.

listUserAccessLoggingSettings_nextToken :: Lens' ListUserAccessLoggingSettings (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

listUserAccessLoggingSettingsResponse_nextToken :: Lens' ListUserAccessLoggingSettingsResponse (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

ListUserSettings

listUserSettings_maxResults :: Lens' ListUserSettings (Maybe Natural) Source #

The maximum number of results to be included in the next page.

listUserSettings_nextToken :: Lens' ListUserSettings (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

listUserSettingsResponse_nextToken :: Lens' ListUserSettingsResponse (Maybe Text) Source #

The pagination token used to retrieve the next page of results for this operation.

TagResource

tagResource_clientToken :: Lens' TagResource (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

tagResource_tags :: Lens' TagResource [Tag] Source #

The tags of the resource.

UntagResource

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The list of tag keys to remove from the resource.

UpdateBrowserSettings

updateBrowserSettings_browserPolicy :: Lens' UpdateBrowserSettings (Maybe Text) Source #

A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

updateBrowserSettings_clientToken :: Lens' UpdateBrowserSettings (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

UpdateIdentityProvider

updateIdentityProvider_clientToken :: Lens' UpdateIdentityProvider (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

updateIdentityProvider_identityProviderDetails :: Lens' UpdateIdentityProvider (Maybe (HashMap Text Text)) Source #

The details of the identity provider. The following list describes the provider detail keys for each identity provider type.

  • For Google and Login with Amazon:

    • client_id
    • client_secret
    • authorize_scopes
  • For Facebook:

    • client_id
    • client_secret
    • authorize_scopes
    • api_version
  • For Sign in with Apple:

    • client_id
    • team_id
    • key_id
    • private_key
    • authorize_scopes
  • For OIDC providers:

    • client_id
    • client_secret
    • attributes_request_method
    • oidc_issuer
    • authorize_scopes
    • authorize_url /if not available from discovery URL specified by oidc_issuer key/
    • token_url /if not available from discovery URL specified by oidc_issuer key/
    • attributes_url /if not available from discovery URL specified by oidc_issuer key/
    • jwks_uri /if not available from discovery URL specified by oidc_issuer key/
  • For SAML providers:

    • MetadataFile OR MetadataURL
    • IDPSignout (boolean) optional

UpdateNetworkSettings

updateNetworkSettings_clientToken :: Lens' UpdateNetworkSettings (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

updateNetworkSettings_securityGroupIds :: Lens' UpdateNetworkSettings (Maybe (NonEmpty Text)) Source #

One or more security groups used to control access from streaming instances to your VPC.

updateNetworkSettings_subnetIds :: Lens' UpdateNetworkSettings (Maybe (NonEmpty Text)) Source #

The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

updateNetworkSettings_vpcId :: Lens' UpdateNetworkSettings (Maybe Text) Source #

The VPC that streaming instances will connect to.

UpdatePortal

updatePortal_displayName :: Lens' UpdatePortal (Maybe Text) Source #

The name of the web portal. This is not visible to users who log into the web portal.

updatePortal_portalArn :: Lens' UpdatePortal Text Source #

The ARN of the web portal.

UpdateTrustStore

updateTrustStore_certificatesToAdd :: Lens' UpdateTrustStore (Maybe [ByteString]) Source #

A list of CA certificates to add to the trust store.

updateTrustStore_certificatesToDelete :: Lens' UpdateTrustStore (Maybe [Text]) Source #

A list of CA certificates to delete from a trust store.

updateTrustStore_clientToken :: Lens' UpdateTrustStore (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

UpdateUserAccessLoggingSettings

updateUserAccessLoggingSettings_clientToken :: Lens' UpdateUserAccessLoggingSettings (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

UpdateUserSettings

updateUserSettings_clientToken :: Lens' UpdateUserSettings (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

updateUserSettings_copyAllowed :: Lens' UpdateUserSettings (Maybe EnabledType) Source #

Specifies whether the user can copy text from the streaming session to the local device.

updateUserSettings_disconnectTimeoutInMinutes :: Lens' UpdateUserSettings (Maybe Natural) Source #

The amount of time that a streaming session remains active after users disconnect.

updateUserSettings_downloadAllowed :: Lens' UpdateUserSettings (Maybe EnabledType) Source #

Specifies whether the user can download files from the streaming session to the local device.

updateUserSettings_idleDisconnectTimeoutInMinutes :: Lens' UpdateUserSettings (Maybe Natural) Source #

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

updateUserSettings_pasteAllowed :: Lens' UpdateUserSettings (Maybe EnabledType) Source #

Specifies whether the user can paste text from the local device to the streaming session.

updateUserSettings_printAllowed :: Lens' UpdateUserSettings (Maybe EnabledType) Source #

Specifies whether the user can print to the local device.

updateUserSettings_uploadAllowed :: Lens' UpdateUserSettings (Maybe EnabledType) Source #

Specifies whether the user can upload files from the local device to the streaming session.

Types

BrowserSettings

browserSettings_associatedPortalArns :: Lens' BrowserSettings (Maybe [Text]) Source #

A list of web portal ARNs that this browser settings is associated with.

browserSettings_browserPolicy :: Lens' BrowserSettings (Maybe Text) Source #

A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

BrowserSettingsSummary

Certificate

certificate_body :: Lens' Certificate (Maybe ByteString) Source #

The body of the certificate.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

certificate_issuer :: Lens' Certificate (Maybe Text) Source #

The entity that issued the certificate.

certificate_notValidAfter :: Lens' Certificate (Maybe UTCTime) Source #

The certificate is not valid after this date.

certificate_notValidBefore :: Lens' Certificate (Maybe UTCTime) Source #

The certificate is not valid before this date.

certificate_subject :: Lens' Certificate (Maybe Text) Source #

The entity the certificate belongs to.

certificate_thumbprint :: Lens' Certificate (Maybe Text) Source #

A hexadecimal identifier for the certificate.

CertificateSummary

certificateSummary_issuer :: Lens' CertificateSummary (Maybe Text) Source #

The entity that issued the certificate.

certificateSummary_notValidAfter :: Lens' CertificateSummary (Maybe UTCTime) Source #

The certificate is not valid after this date.

certificateSummary_notValidBefore :: Lens' CertificateSummary (Maybe UTCTime) Source #

The certificate is not valid before this date.

certificateSummary_subject :: Lens' CertificateSummary (Maybe Text) Source #

The entity the certificate belongs to.

certificateSummary_thumbprint :: Lens' CertificateSummary (Maybe Text) Source #

A hexadecimal identifier for the certificate.

IdentityProvider

identityProvider_identityProviderDetails :: Lens' IdentityProvider (Maybe (HashMap Text Text)) Source #

The identity provider details. The following list describes the provider detail keys for each identity provider type.

  • For Google and Login with Amazon:

    • client_id
    • client_secret
    • authorize_scopes
  • For Facebook:

    • client_id
    • client_secret
    • authorize_scopes
    • api_version
  • For Sign in with Apple:

    • client_id
    • team_id
    • key_id
    • private_key
    • authorize_scopes
  • For OIDC providers:

    • client_id
    • client_secret
    • attributes_request_method
    • oidc_issuer
    • authorize_scopes
    • authorize_url /if not available from discovery URL specified by oidc_issuer key/
    • token_url /if not available from discovery URL specified by oidc_issuer key/
    • attributes_url /if not available from discovery URL specified by oidc_issuer key/
    • jwks_uri /if not available from discovery URL specified by oidc_issuer key/
  • For SAML providers:

    • MetadataFile OR MetadataURL
    • IDPSignout optional

IdentityProviderSummary

NetworkSettings

networkSettings_associatedPortalArns :: Lens' NetworkSettings (Maybe [Text]) Source #

A list of web portal ARNs that this network settings is associated with.

networkSettings_securityGroupIds :: Lens' NetworkSettings (Maybe (NonEmpty Text)) Source #

One or more security groups used to control access from streaming instances to your VPC.

networkSettings_subnetIds :: Lens' NetworkSettings (Maybe (NonEmpty Text)) Source #

The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

networkSettings_vpcId :: Lens' NetworkSettings (Maybe Text) Source #

The VPC that streaming instances will connect to.

NetworkSettingsSummary

Portal

portal_browserSettingsArn :: Lens' Portal (Maybe Text) Source #

The ARN of the browser settings that is associated with this web portal.

portal_browserType :: Lens' Portal (Maybe BrowserType) Source #

The browser that users see when using a streaming session.

portal_creationDate :: Lens' Portal (Maybe UTCTime) Source #

The creation date of the web portal.

portal_displayName :: Lens' Portal (Maybe Text) Source #

The name of the web portal.

portal_networkSettingsArn :: Lens' Portal (Maybe Text) Source #

The ARN of the network settings that is associated with the web portal.

portal_portalArn :: Lens' Portal (Maybe Text) Source #

The ARN of the web portal.

portal_portalEndpoint :: Lens' Portal (Maybe Text) Source #

The endpoint URL of the web portal that users access in order to start streaming sessions.

portal_portalStatus :: Lens' Portal (Maybe PortalStatus) Source #

The status of the web portal.

portal_rendererType :: Lens' Portal (Maybe RendererType) Source #

The renderer that is used in streaming sessions.

portal_statusReason :: Lens' Portal (Maybe Text) Source #

A message that explains why the web portal is in its current status.

portal_trustStoreArn :: Lens' Portal (Maybe Text) Source #

The ARN of the trust store that is associated with the web portal.

portal_userAccessLoggingSettingsArn :: Lens' Portal (Maybe Text) Source #

The ARN of the user access logging settings that is associated with the web portal.

portal_userSettingsArn :: Lens' Portal (Maybe Text) Source #

The ARN of the user settings that is associated with the web portal.

PortalSummary

portalSummary_browserSettingsArn :: Lens' PortalSummary (Maybe Text) Source #

The ARN of the browser settings that is associated with the web portal.

portalSummary_browserType :: Lens' PortalSummary (Maybe BrowserType) Source #

The browser type of the web portal.

portalSummary_creationDate :: Lens' PortalSummary (Maybe UTCTime) Source #

The creation date of the web portal.

portalSummary_networkSettingsArn :: Lens' PortalSummary (Maybe Text) Source #

The ARN of the network settings that is associated with the web portal.

portalSummary_portalEndpoint :: Lens' PortalSummary (Maybe Text) Source #

The endpoint URL of the web portal that users access in order to start streaming sessions.

portalSummary_rendererType :: Lens' PortalSummary (Maybe RendererType) Source #

The renderer that is used in streaming sessions.

portalSummary_trustStoreArn :: Lens' PortalSummary (Maybe Text) Source #

The ARN of the trust that is associated with this web portal.

portalSummary_userAccessLoggingSettingsArn :: Lens' PortalSummary (Maybe Text) Source #

The ARN of the user access logging settings that is associated with the web portal.

portalSummary_userSettingsArn :: Lens' PortalSummary (Maybe Text) Source #

The ARN of the user settings that is associated with the web portal.

Tag

tag_key :: Lens' Tag Text Source #

The key of the tag.

tag_value :: Lens' Tag Text Source #

The value of the tag

TrustStore

trustStore_associatedPortalArns :: Lens' TrustStore (Maybe [Text]) Source #

A list of web portal ARNs that this trust store is associated with.

trustStore_trustStoreArn :: Lens' TrustStore (Maybe Text) Source #

The ARN of the trust store.

TrustStoreSummary

UserAccessLoggingSettings

userAccessLoggingSettings_associatedPortalArns :: Lens' UserAccessLoggingSettings (Maybe [Text]) Source #

A list of web portal ARNs that this user access logging settings is associated with.

UserAccessLoggingSettingsSummary

UserSettings

userSettings_associatedPortalArns :: Lens' UserSettings (Maybe [Text]) Source #

A list of web portal ARNs that this user settings is associated with.

userSettings_copyAllowed :: Lens' UserSettings (Maybe EnabledType) Source #

Specifies whether the user can copy text from the streaming session to the local device.

userSettings_disconnectTimeoutInMinutes :: Lens' UserSettings (Maybe Natural) Source #

The amount of time that a streaming session remains active after users disconnect.

userSettings_downloadAllowed :: Lens' UserSettings (Maybe EnabledType) Source #

Specifies whether the user can download files from the streaming session to the local device.

userSettings_idleDisconnectTimeoutInMinutes :: Lens' UserSettings (Maybe Natural) Source #

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

userSettings_pasteAllowed :: Lens' UserSettings (Maybe EnabledType) Source #

Specifies whether the user can paste text from the local device to the streaming session.

userSettings_printAllowed :: Lens' UserSettings (Maybe EnabledType) Source #

Specifies whether the user can print to the local device.

userSettings_uploadAllowed :: Lens' UserSettings (Maybe EnabledType) Source #

Specifies whether the user can upload files from the local device to the streaming session.

UserSettingsSummary

userSettingsSummary_copyAllowed :: Lens' UserSettingsSummary (Maybe EnabledType) Source #

Specifies whether the user can copy text from the streaming session to the local device.

userSettingsSummary_disconnectTimeoutInMinutes :: Lens' UserSettingsSummary (Maybe Natural) Source #

The amount of time that a streaming session remains active after users disconnect.

userSettingsSummary_downloadAllowed :: Lens' UserSettingsSummary (Maybe EnabledType) Source #

Specifies whether the user can download files from the streaming session to the local device.

userSettingsSummary_idleDisconnectTimeoutInMinutes :: Lens' UserSettingsSummary (Maybe Natural) Source #

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

userSettingsSummary_pasteAllowed :: Lens' UserSettingsSummary (Maybe EnabledType) Source #

Specifies whether the user can paste text from the local device to the streaming session.

userSettingsSummary_printAllowed :: Lens' UserSettingsSummary (Maybe EnabledType) Source #

Specifies whether the user can print to the local device.

userSettingsSummary_uploadAllowed :: Lens' UserSettingsSummary (Maybe EnabledType) Source #

Specifies whether the user can upload files from the local device to the streaming session.