Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- BrowserType
- EnabledType
- IdentityProviderType
- PortalStatus
- RendererType
- BrowserSettings
- BrowserSettingsSummary
- Certificate
- CertificateSummary
- IdentityProvider
- IdentityProviderSummary
- NetworkSettings
- NetworkSettingsSummary
- Portal
- PortalSummary
- Tag
- TrustStore
- TrustStoreSummary
- UserAccessLoggingSettings
- UserAccessLoggingSettingsSummary
- UserSettings
- UserSettingsSummary
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype BrowserType where
- BrowserType' { }
- pattern BrowserType_Chrome :: BrowserType
- newtype EnabledType where
- EnabledType' { }
- pattern EnabledType_Disabled :: EnabledType
- pattern EnabledType_Enabled :: EnabledType
- newtype IdentityProviderType where
- IdentityProviderType' { }
- pattern IdentityProviderType_Facebook :: IdentityProviderType
- pattern IdentityProviderType_Google :: IdentityProviderType
- pattern IdentityProviderType_LoginWithAmazon :: IdentityProviderType
- pattern IdentityProviderType_OIDC :: IdentityProviderType
- pattern IdentityProviderType_SAML :: IdentityProviderType
- pattern IdentityProviderType_SignInWithApple :: IdentityProviderType
- newtype PortalStatus where
- PortalStatus' { }
- pattern PortalStatus_Active :: PortalStatus
- pattern PortalStatus_Incomplete :: PortalStatus
- pattern PortalStatus_Pending :: PortalStatus
- newtype RendererType where
- RendererType' { }
- pattern RendererType_AppStream :: RendererType
- data BrowserSettings = BrowserSettings' {}
- newBrowserSettings :: Text -> BrowserSettings
- browserSettings_associatedPortalArns :: Lens' BrowserSettings (Maybe [Text])
- browserSettings_browserPolicy :: Lens' BrowserSettings (Maybe Text)
- browserSettings_browserSettingsArn :: Lens' BrowserSettings Text
- data BrowserSettingsSummary = BrowserSettingsSummary' {}
- newBrowserSettingsSummary :: BrowserSettingsSummary
- browserSettingsSummary_browserSettingsArn :: Lens' BrowserSettingsSummary (Maybe Text)
- data Certificate = Certificate' {}
- newCertificate :: Certificate
- certificate_body :: Lens' Certificate (Maybe ByteString)
- certificate_issuer :: Lens' Certificate (Maybe Text)
- certificate_notValidAfter :: Lens' Certificate (Maybe UTCTime)
- certificate_notValidBefore :: Lens' Certificate (Maybe UTCTime)
- certificate_subject :: Lens' Certificate (Maybe Text)
- certificate_thumbprint :: Lens' Certificate (Maybe Text)
- data CertificateSummary = CertificateSummary' {
- issuer :: Maybe Text
- notValidAfter :: Maybe POSIX
- notValidBefore :: Maybe POSIX
- subject :: Maybe Text
- thumbprint :: Maybe Text
- newCertificateSummary :: CertificateSummary
- certificateSummary_issuer :: Lens' CertificateSummary (Maybe Text)
- certificateSummary_notValidAfter :: Lens' CertificateSummary (Maybe UTCTime)
- certificateSummary_notValidBefore :: Lens' CertificateSummary (Maybe UTCTime)
- certificateSummary_subject :: Lens' CertificateSummary (Maybe Text)
- certificateSummary_thumbprint :: Lens' CertificateSummary (Maybe Text)
- data IdentityProvider = IdentityProvider' {}
- newIdentityProvider :: Text -> IdentityProvider
- identityProvider_identityProviderDetails :: Lens' IdentityProvider (Maybe (HashMap Text Text))
- identityProvider_identityProviderName :: Lens' IdentityProvider (Maybe Text)
- identityProvider_identityProviderType :: Lens' IdentityProvider (Maybe IdentityProviderType)
- identityProvider_identityProviderArn :: Lens' IdentityProvider Text
- data IdentityProviderSummary = IdentityProviderSummary' {}
- newIdentityProviderSummary :: IdentityProviderSummary
- identityProviderSummary_identityProviderArn :: Lens' IdentityProviderSummary (Maybe Text)
- identityProviderSummary_identityProviderName :: Lens' IdentityProviderSummary (Maybe Text)
- identityProviderSummary_identityProviderType :: Lens' IdentityProviderSummary (Maybe IdentityProviderType)
- data NetworkSettings = NetworkSettings' {}
- newNetworkSettings :: Text -> NetworkSettings
- networkSettings_associatedPortalArns :: Lens' NetworkSettings (Maybe [Text])
- networkSettings_securityGroupIds :: Lens' NetworkSettings (Maybe (NonEmpty Text))
- networkSettings_subnetIds :: Lens' NetworkSettings (Maybe (NonEmpty Text))
- networkSettings_vpcId :: Lens' NetworkSettings (Maybe Text)
- networkSettings_networkSettingsArn :: Lens' NetworkSettings Text
- data NetworkSettingsSummary = NetworkSettingsSummary' {}
- newNetworkSettingsSummary :: NetworkSettingsSummary
- networkSettingsSummary_networkSettingsArn :: Lens' NetworkSettingsSummary (Maybe Text)
- networkSettingsSummary_vpcId :: Lens' NetworkSettingsSummary (Maybe Text)
- data Portal = Portal' {
- browserSettingsArn :: Maybe Text
- browserType :: Maybe BrowserType
- creationDate :: Maybe POSIX
- displayName :: Maybe (Sensitive Text)
- networkSettingsArn :: Maybe Text
- portalArn :: Maybe Text
- portalEndpoint :: Maybe Text
- portalStatus :: Maybe PortalStatus
- rendererType :: Maybe RendererType
- statusReason :: Maybe Text
- trustStoreArn :: Maybe Text
- userAccessLoggingSettingsArn :: Maybe Text
- userSettingsArn :: Maybe Text
- newPortal :: Portal
- portal_browserSettingsArn :: Lens' Portal (Maybe Text)
- portal_browserType :: Lens' Portal (Maybe BrowserType)
- portal_creationDate :: Lens' Portal (Maybe UTCTime)
- portal_displayName :: Lens' Portal (Maybe Text)
- portal_networkSettingsArn :: Lens' Portal (Maybe Text)
- portal_portalArn :: Lens' Portal (Maybe Text)
- portal_portalEndpoint :: Lens' Portal (Maybe Text)
- portal_portalStatus :: Lens' Portal (Maybe PortalStatus)
- portal_rendererType :: Lens' Portal (Maybe RendererType)
- portal_statusReason :: Lens' Portal (Maybe Text)
- portal_trustStoreArn :: Lens' Portal (Maybe Text)
- portal_userAccessLoggingSettingsArn :: Lens' Portal (Maybe Text)
- portal_userSettingsArn :: Lens' Portal (Maybe Text)
- data PortalSummary = PortalSummary' {
- browserSettingsArn :: Maybe Text
- browserType :: Maybe BrowserType
- creationDate :: Maybe POSIX
- displayName :: Maybe (Sensitive Text)
- networkSettingsArn :: Maybe Text
- portalArn :: Maybe Text
- portalEndpoint :: Maybe Text
- portalStatus :: Maybe PortalStatus
- rendererType :: Maybe RendererType
- trustStoreArn :: Maybe Text
- userAccessLoggingSettingsArn :: Maybe Text
- userSettingsArn :: Maybe Text
- newPortalSummary :: PortalSummary
- portalSummary_browserSettingsArn :: Lens' PortalSummary (Maybe Text)
- portalSummary_browserType :: Lens' PortalSummary (Maybe BrowserType)
- portalSummary_creationDate :: Lens' PortalSummary (Maybe UTCTime)
- portalSummary_displayName :: Lens' PortalSummary (Maybe Text)
- portalSummary_networkSettingsArn :: Lens' PortalSummary (Maybe Text)
- portalSummary_portalArn :: Lens' PortalSummary (Maybe Text)
- portalSummary_portalEndpoint :: Lens' PortalSummary (Maybe Text)
- portalSummary_portalStatus :: Lens' PortalSummary (Maybe PortalStatus)
- portalSummary_rendererType :: Lens' PortalSummary (Maybe RendererType)
- portalSummary_trustStoreArn :: Lens' PortalSummary (Maybe Text)
- portalSummary_userAccessLoggingSettingsArn :: Lens' PortalSummary (Maybe Text)
- portalSummary_userSettingsArn :: Lens' PortalSummary (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data TrustStore = TrustStore' {}
- newTrustStore :: TrustStore
- trustStore_associatedPortalArns :: Lens' TrustStore (Maybe [Text])
- trustStore_trustStoreArn :: Lens' TrustStore (Maybe Text)
- data TrustStoreSummary = TrustStoreSummary' {}
- newTrustStoreSummary :: TrustStoreSummary
- trustStoreSummary_trustStoreArn :: Lens' TrustStoreSummary (Maybe Text)
- data UserAccessLoggingSettings = UserAccessLoggingSettings' {}
- newUserAccessLoggingSettings :: Text -> UserAccessLoggingSettings
- userAccessLoggingSettings_associatedPortalArns :: Lens' UserAccessLoggingSettings (Maybe [Text])
- userAccessLoggingSettings_kinesisStreamArn :: Lens' UserAccessLoggingSettings (Maybe Text)
- userAccessLoggingSettings_userAccessLoggingSettingsArn :: Lens' UserAccessLoggingSettings Text
- data UserAccessLoggingSettingsSummary = UserAccessLoggingSettingsSummary' {}
- newUserAccessLoggingSettingsSummary :: UserAccessLoggingSettingsSummary
- userAccessLoggingSettingsSummary_kinesisStreamArn :: Lens' UserAccessLoggingSettingsSummary (Maybe Text)
- userAccessLoggingSettingsSummary_userAccessLoggingSettingsArn :: Lens' UserAccessLoggingSettingsSummary (Maybe Text)
- data UserSettings = UserSettings' {
- associatedPortalArns :: Maybe [Text]
- copyAllowed :: Maybe EnabledType
- disconnectTimeoutInMinutes :: Maybe Natural
- downloadAllowed :: Maybe EnabledType
- idleDisconnectTimeoutInMinutes :: Maybe Natural
- pasteAllowed :: Maybe EnabledType
- printAllowed :: Maybe EnabledType
- uploadAllowed :: Maybe EnabledType
- userSettingsArn :: Text
- newUserSettings :: Text -> UserSettings
- userSettings_associatedPortalArns :: Lens' UserSettings (Maybe [Text])
- userSettings_copyAllowed :: Lens' UserSettings (Maybe EnabledType)
- userSettings_disconnectTimeoutInMinutes :: Lens' UserSettings (Maybe Natural)
- userSettings_downloadAllowed :: Lens' UserSettings (Maybe EnabledType)
- userSettings_idleDisconnectTimeoutInMinutes :: Lens' UserSettings (Maybe Natural)
- userSettings_pasteAllowed :: Lens' UserSettings (Maybe EnabledType)
- userSettings_printAllowed :: Lens' UserSettings (Maybe EnabledType)
- userSettings_uploadAllowed :: Lens' UserSettings (Maybe EnabledType)
- userSettings_userSettingsArn :: Lens' UserSettings Text
- data UserSettingsSummary = UserSettingsSummary' {}
- newUserSettingsSummary :: UserSettingsSummary
- userSettingsSummary_copyAllowed :: Lens' UserSettingsSummary (Maybe EnabledType)
- userSettingsSummary_disconnectTimeoutInMinutes :: Lens' UserSettingsSummary (Maybe Natural)
- userSettingsSummary_downloadAllowed :: Lens' UserSettingsSummary (Maybe EnabledType)
- userSettingsSummary_idleDisconnectTimeoutInMinutes :: Lens' UserSettingsSummary (Maybe Natural)
- userSettingsSummary_pasteAllowed :: Lens' UserSettingsSummary (Maybe EnabledType)
- userSettingsSummary_printAllowed :: Lens' UserSettingsSummary (Maybe EnabledType)
- userSettingsSummary_uploadAllowed :: Lens' UserSettingsSummary (Maybe EnabledType)
- userSettingsSummary_userSettingsArn :: Lens' UserSettingsSummary (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2020-07-08
of the Amazon WorkSpaces Web SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
Access is denied.
_ConflictException :: AsError a => Fold a ServiceError Source #
There is a conflict.
_InternalServerException :: AsError a => Fold a ServiceError Source #
There is an internal server error.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource cannot be found.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The service quota has been exceeded.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
There is a throttling error.
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
There are too many tags.
_ValidationException :: AsError a => Fold a ServiceError Source #
There is a validation error.
BrowserType
newtype BrowserType Source #
pattern BrowserType_Chrome :: BrowserType |
Instances
EnabledType
newtype EnabledType Source #
pattern EnabledType_Disabled :: EnabledType | |
pattern EnabledType_Enabled :: EnabledType |
Instances
IdentityProviderType
newtype IdentityProviderType Source #
pattern IdentityProviderType_Facebook :: IdentityProviderType | |
pattern IdentityProviderType_Google :: IdentityProviderType | |
pattern IdentityProviderType_LoginWithAmazon :: IdentityProviderType | |
pattern IdentityProviderType_OIDC :: IdentityProviderType | |
pattern IdentityProviderType_SAML :: IdentityProviderType | |
pattern IdentityProviderType_SignInWithApple :: IdentityProviderType |
Instances
PortalStatus
newtype PortalStatus Source #
pattern PortalStatus_Active :: PortalStatus | |
pattern PortalStatus_Incomplete :: PortalStatus | |
pattern PortalStatus_Pending :: PortalStatus |
Instances
RendererType
newtype RendererType Source #
pattern RendererType_AppStream :: RendererType |
Instances
BrowserSettings
data BrowserSettings Source #
The browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal.
See: newBrowserSettings
smart constructor.
BrowserSettings' | |
|
Instances
Create a value of BrowserSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associatedPortalArns:BrowserSettings'
, browserSettings_associatedPortalArns
- A list of web portal ARNs that this browser settings is associated with.
$sel:browserPolicy:BrowserSettings'
, browserSettings_browserPolicy
- A JSON string containing Chrome Enterprise policies that will be applied
to all streaming sessions.
$sel:browserSettingsArn:BrowserSettings'
, browserSettings_browserSettingsArn
- The ARN of the browser settings.
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.
browserSettings_browserSettingsArn :: Lens' BrowserSettings Text Source #
The ARN of the browser settings.
BrowserSettingsSummary
data BrowserSettingsSummary Source #
The summary for browser settings.
See: newBrowserSettingsSummary
smart constructor.
BrowserSettingsSummary' | |
|
Instances
newBrowserSettingsSummary :: BrowserSettingsSummary Source #
Create a value of BrowserSettingsSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:browserSettingsArn:BrowserSettingsSummary'
, browserSettingsSummary_browserSettingsArn
- The ARN of the browser settings.
browserSettingsSummary_browserSettingsArn :: Lens' BrowserSettingsSummary (Maybe Text) Source #
The ARN of the browser settings.
Certificate
data Certificate Source #
The certificate.
See: newCertificate
smart constructor.
Certificate' | |
|
Instances
newCertificate :: Certificate Source #
Create a value of Certificate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:body:Certificate'
, certificate_body
- 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.
$sel:issuer:Certificate'
, certificate_issuer
- The entity that issued the certificate.
$sel:notValidAfter:Certificate'
, certificate_notValidAfter
- The certificate is not valid after this date.
$sel:notValidBefore:Certificate'
, certificate_notValidBefore
- The certificate is not valid before this date.
$sel:subject:Certificate'
, certificate_subject
- The entity the certificate belongs to.
$sel:thumbprint:Certificate'
, certificate_thumbprint
- A hexadecimal identifier for the 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
data CertificateSummary Source #
The summary of the certificate.
See: newCertificateSummary
smart constructor.
CertificateSummary' | |
|
Instances
newCertificateSummary :: CertificateSummary Source #
Create a value of CertificateSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:issuer:CertificateSummary'
, certificateSummary_issuer
- The entity that issued the certificate.
$sel:notValidAfter:CertificateSummary'
, certificateSummary_notValidAfter
- The certificate is not valid after this date.
$sel:notValidBefore:CertificateSummary'
, certificateSummary_notValidBefore
- The certificate is not valid before this date.
$sel:subject:CertificateSummary'
, certificateSummary_subject
- The entity the certificate belongs to.
$sel:thumbprint:CertificateSummary'
, certificateSummary_thumbprint
- A hexadecimal identifier for the certificate.
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
data IdentityProvider Source #
The identity provider.
See: newIdentityProvider
smart constructor.
IdentityProvider' | |
|
Instances
Create a value of IdentityProvider
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:identityProviderDetails:IdentityProvider'
, identityProvider_identityProviderDetails
- 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
ORMetadataURL
IDPSignout
optional
$sel:identityProviderName:IdentityProvider'
, identityProvider_identityProviderName
- The identity provider name.
$sel:identityProviderType:IdentityProvider'
, identityProvider_identityProviderType
- The identity provider type.
$sel:identityProviderArn:IdentityProvider'
, identityProvider_identityProviderArn
- The ARN of the identity provider.
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
ORMetadataURL
IDPSignout
optional
identityProvider_identityProviderName :: Lens' IdentityProvider (Maybe Text) Source #
The identity provider name.
identityProvider_identityProviderType :: Lens' IdentityProvider (Maybe IdentityProviderType) Source #
The identity provider type.
identityProvider_identityProviderArn :: Lens' IdentityProvider Text Source #
The ARN of the identity provider.
IdentityProviderSummary
data IdentityProviderSummary Source #
The summary of the identity provider.
See: newIdentityProviderSummary
smart constructor.
IdentityProviderSummary' | |
|
Instances
newIdentityProviderSummary :: IdentityProviderSummary Source #
Create a value of IdentityProviderSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:identityProviderArn:IdentityProviderSummary'
, identityProviderSummary_identityProviderArn
- The ARN of the identity provider.
$sel:identityProviderName:IdentityProviderSummary'
, identityProviderSummary_identityProviderName
- The identity provider name.
$sel:identityProviderType:IdentityProviderSummary'
, identityProviderSummary_identityProviderType
- The identity provider type.
identityProviderSummary_identityProviderArn :: Lens' IdentityProviderSummary (Maybe Text) Source #
The ARN of the identity provider.
identityProviderSummary_identityProviderName :: Lens' IdentityProviderSummary (Maybe Text) Source #
The identity provider name.
identityProviderSummary_identityProviderType :: Lens' IdentityProviderSummary (Maybe IdentityProviderType) Source #
The identity provider type.
NetworkSettings
data NetworkSettings Source #
A network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC.
See: newNetworkSettings
smart constructor.
NetworkSettings' | |
|
Instances
Create a value of NetworkSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associatedPortalArns:NetworkSettings'
, networkSettings_associatedPortalArns
- A list of web portal ARNs that this network settings is associated with.
$sel:securityGroupIds:NetworkSettings'
, networkSettings_securityGroupIds
- One or more security groups used to control access from streaming
instances to your VPC.
$sel:subnetIds:NetworkSettings'
, networkSettings_subnetIds
- 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.
$sel:vpcId:NetworkSettings'
, networkSettings_vpcId
- The VPC that streaming instances will connect to.
$sel:networkSettingsArn:NetworkSettings'
, networkSettings_networkSettingsArn
- The ARN of the network settings.
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.
networkSettings_networkSettingsArn :: Lens' NetworkSettings Text Source #
The ARN of the network settings.
NetworkSettingsSummary
data NetworkSettingsSummary Source #
The summary of network settings.
See: newNetworkSettingsSummary
smart constructor.
Instances
newNetworkSettingsSummary :: NetworkSettingsSummary Source #
Create a value of NetworkSettingsSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:networkSettingsArn:NetworkSettingsSummary'
, networkSettingsSummary_networkSettingsArn
- The ARN of the network settings.
$sel:vpcId:NetworkSettingsSummary'
, networkSettingsSummary_vpcId
- The VPC ID of the network settings.
networkSettingsSummary_networkSettingsArn :: Lens' NetworkSettingsSummary (Maybe Text) Source #
The ARN of the network settings.
networkSettingsSummary_vpcId :: Lens' NetworkSettingsSummary (Maybe Text) Source #
The VPC ID of the network settings.
Portal
The web portal.
See: newPortal
smart constructor.
Portal' | |
|
Instances
Create a value of Portal
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:browserSettingsArn:Portal'
, portal_browserSettingsArn
- The ARN of the browser settings that is associated with this web portal.
$sel:browserType:Portal'
, portal_browserType
- The browser that users see when using a streaming session.
$sel:creationDate:Portal'
, portal_creationDate
- The creation date of the web portal.
$sel:displayName:Portal'
, portal_displayName
- The name of the web portal.
$sel:networkSettingsArn:Portal'
, portal_networkSettingsArn
- The ARN of the network settings that is associated with the web portal.
$sel:portalArn:Portal'
, portal_portalArn
- The ARN of the web portal.
$sel:portalEndpoint:Portal'
, portal_portalEndpoint
- The endpoint URL of the web portal that users access in order to start
streaming sessions.
$sel:portalStatus:Portal'
, portal_portalStatus
- The status of the web portal.
$sel:rendererType:Portal'
, portal_rendererType
- The renderer that is used in streaming sessions.
$sel:statusReason:Portal'
, portal_statusReason
- A message that explains why the web portal is in its current status.
$sel:trustStoreArn:Portal'
, portal_trustStoreArn
- The ARN of the trust store that is associated with the web portal.
$sel:userAccessLoggingSettingsArn:Portal'
, portal_userAccessLoggingSettingsArn
- The ARN of the user access logging settings that is associated with the
web portal.
$sel:userSettingsArn:Portal'
, portal_userSettingsArn
- The ARN of the user settings that is associated with the web 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_networkSettingsArn :: Lens' Portal (Maybe Text) Source #
The ARN of the network settings that is associated with 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
data PortalSummary Source #
The summary of the portal.
See: newPortalSummary
smart constructor.
PortalSummary' | |
|
Instances
newPortalSummary :: PortalSummary Source #
Create a value of PortalSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:browserSettingsArn:PortalSummary'
, portalSummary_browserSettingsArn
- The ARN of the browser settings that is associated with the web portal.
$sel:browserType:PortalSummary'
, portalSummary_browserType
- The browser type of the web portal.
$sel:creationDate:PortalSummary'
, portalSummary_creationDate
- The creation date of the web portal.
$sel:displayName:PortalSummary'
, portalSummary_displayName
- The name of the web portal.
$sel:networkSettingsArn:PortalSummary'
, portalSummary_networkSettingsArn
- The ARN of the network settings that is associated with the web portal.
$sel:portalArn:PortalSummary'
, portalSummary_portalArn
- The ARN of the web portal.
$sel:portalEndpoint:PortalSummary'
, portalSummary_portalEndpoint
- The endpoint URL of the web portal that users access in order to start
streaming sessions.
$sel:portalStatus:PortalSummary'
, portalSummary_portalStatus
- The status of the web portal.
$sel:rendererType:PortalSummary'
, portalSummary_rendererType
- The renderer that is used in streaming sessions.
$sel:trustStoreArn:PortalSummary'
, portalSummary_trustStoreArn
- The ARN of the trust that is associated with this web portal.
$sel:userAccessLoggingSettingsArn:PortalSummary'
, portalSummary_userAccessLoggingSettingsArn
- The ARN of the user access logging settings that is associated with the
web portal.
$sel:userSettingsArn:PortalSummary'
, portalSummary_userSettingsArn
- The ARN of the user settings that is associated with the web portal.
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_displayName :: Lens' PortalSummary (Maybe Text) Source #
The name 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_portalArn :: Lens' PortalSummary (Maybe Text) Source #
The ARN of 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_portalStatus :: Lens' PortalSummary (Maybe PortalStatus) Source #
The status of the web portal.
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
The tag.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.WorkSpacesWeb.Types.Tag | |
Generic Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.WorkSpacesWeb.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.WorkSpacesWeb.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.WorkSpacesWeb.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.WorkSpacesWeb.Types.Tag" "amazonka-workspaces-web-2.0-7elUOg7oNE07CClY3TuUcU" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag'
, tag_key
- The key of the tag.
$sel:value:Tag'
, tag_value
- The value of the tag
TrustStore
data TrustStore Source #
A trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store.
See: newTrustStore
smart constructor.
TrustStore' | |
|
Instances
newTrustStore :: TrustStore Source #
Create a value of TrustStore
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associatedPortalArns:TrustStore'
, trustStore_associatedPortalArns
- A list of web portal ARNs that this trust store is associated with.
$sel:trustStoreArn:TrustStore'
, trustStore_trustStoreArn
- The ARN of the trust store.
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
data TrustStoreSummary Source #
The summary of the trust store.
See: newTrustStoreSummary
smart constructor.
TrustStoreSummary' | |
|
Instances
newTrustStoreSummary :: TrustStoreSummary Source #
Create a value of TrustStoreSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:trustStoreArn:TrustStoreSummary'
, trustStoreSummary_trustStoreArn
- The ARN of the trust store.
trustStoreSummary_trustStoreArn :: Lens' TrustStoreSummary (Maybe Text) Source #
The ARN of the trust store.
UserAccessLoggingSettings
data UserAccessLoggingSettings Source #
A user access logging settings resource that can be associated with a web portal.
See: newUserAccessLoggingSettings
smart constructor.
UserAccessLoggingSettings' | |
|
Instances
newUserAccessLoggingSettings Source #
Create a value of UserAccessLoggingSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associatedPortalArns:UserAccessLoggingSettings'
, userAccessLoggingSettings_associatedPortalArns
- A list of web portal ARNs that this user access logging settings is
associated with.
$sel:kinesisStreamArn:UserAccessLoggingSettings'
, userAccessLoggingSettings_kinesisStreamArn
- The ARN of the Kinesis stream.
$sel:userAccessLoggingSettingsArn:UserAccessLoggingSettings'
, userAccessLoggingSettings_userAccessLoggingSettingsArn
- The ARN of the user access logging settings.
userAccessLoggingSettings_associatedPortalArns :: Lens' UserAccessLoggingSettings (Maybe [Text]) Source #
A list of web portal ARNs that this user access logging settings is associated with.
userAccessLoggingSettings_kinesisStreamArn :: Lens' UserAccessLoggingSettings (Maybe Text) Source #
The ARN of the Kinesis stream.
userAccessLoggingSettings_userAccessLoggingSettingsArn :: Lens' UserAccessLoggingSettings Text Source #
The ARN of the user access logging settings.
UserAccessLoggingSettingsSummary
data UserAccessLoggingSettingsSummary Source #
The summary of user access logging settings.
See: newUserAccessLoggingSettingsSummary
smart constructor.
UserAccessLoggingSettingsSummary' | |
|
Instances
newUserAccessLoggingSettingsSummary :: UserAccessLoggingSettingsSummary Source #
Create a value of UserAccessLoggingSettingsSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kinesisStreamArn:UserAccessLoggingSettingsSummary'
, userAccessLoggingSettingsSummary_kinesisStreamArn
- The ARN of the Kinesis stream.
$sel:userAccessLoggingSettingsArn:UserAccessLoggingSettingsSummary'
, userAccessLoggingSettingsSummary_userAccessLoggingSettingsArn
- The ARN of the user access logging settings.
userAccessLoggingSettingsSummary_kinesisStreamArn :: Lens' UserAccessLoggingSettingsSummary (Maybe Text) Source #
The ARN of the Kinesis stream.
userAccessLoggingSettingsSummary_userAccessLoggingSettingsArn :: Lens' UserAccessLoggingSettingsSummary (Maybe Text) Source #
The ARN of the user access logging settings.
UserSettings
data UserSettings Source #
A user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.
See: newUserSettings
smart constructor.
UserSettings' | |
|
Instances
Create a value of UserSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associatedPortalArns:UserSettings'
, userSettings_associatedPortalArns
- A list of web portal ARNs that this user settings is associated with.
$sel:copyAllowed:UserSettings'
, userSettings_copyAllowed
- Specifies whether the user can copy text from the streaming session to
the local device.
$sel:disconnectTimeoutInMinutes:UserSettings'
, userSettings_disconnectTimeoutInMinutes
- The amount of time that a streaming session remains active after users
disconnect.
$sel:downloadAllowed:UserSettings'
, userSettings_downloadAllowed
- Specifies whether the user can download files from the streaming session
to the local device.
$sel:idleDisconnectTimeoutInMinutes:UserSettings'
, userSettings_idleDisconnectTimeoutInMinutes
- The amount of time that users can be idle (inactive) before they are
disconnected from their streaming session and the disconnect timeout
interval begins.
$sel:pasteAllowed:UserSettings'
, userSettings_pasteAllowed
- Specifies whether the user can paste text from the local device to the
streaming session.
$sel:printAllowed:UserSettings'
, userSettings_printAllowed
- Specifies whether the user can print to the local device.
$sel:uploadAllowed:UserSettings'
, userSettings_uploadAllowed
- Specifies whether the user can upload files from the local device to the
streaming session.
$sel:userSettingsArn:UserSettings'
, userSettings_userSettingsArn
- The ARN of the user settings.
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.
userSettings_userSettingsArn :: Lens' UserSettings Text Source #
The ARN of the user settings.
UserSettingsSummary
data UserSettingsSummary Source #
The summary of user settings.
See: newUserSettingsSummary
smart constructor.
UserSettingsSummary' | |
|
Instances
newUserSettingsSummary :: UserSettingsSummary Source #
Create a value of UserSettingsSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:copyAllowed:UserSettingsSummary'
, userSettingsSummary_copyAllowed
- Specifies whether the user can copy text from the streaming session to
the local device.
$sel:disconnectTimeoutInMinutes:UserSettingsSummary'
, userSettingsSummary_disconnectTimeoutInMinutes
- The amount of time that a streaming session remains active after users
disconnect.
$sel:downloadAllowed:UserSettingsSummary'
, userSettingsSummary_downloadAllowed
- Specifies whether the user can download files from the streaming session
to the local device.
$sel:idleDisconnectTimeoutInMinutes:UserSettingsSummary'
, userSettingsSummary_idleDisconnectTimeoutInMinutes
- The amount of time that users can be idle (inactive) before they are
disconnected from their streaming session and the disconnect timeout
interval begins.
$sel:pasteAllowed:UserSettingsSummary'
, userSettingsSummary_pasteAllowed
- Specifies whether the user can paste text from the local device to the
streaming session.
$sel:printAllowed:UserSettingsSummary'
, userSettingsSummary_printAllowed
- Specifies whether the user can print to the local device.
$sel:uploadAllowed:UserSettingsSummary'
, userSettingsSummary_uploadAllowed
- Specifies whether the user can upload files from the local device to the
streaming session.
$sel:userSettingsArn:UserSettingsSummary'
, userSettingsSummary_userSettingsArn
- The ARN of the user settings.
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.
userSettingsSummary_userSettingsArn :: Lens' UserSettingsSummary (Maybe Text) Source #
The ARN of the user settings.