| 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 |
Amazonka.AmplifyBackend.Types
Contents
- Service Configuration
- Errors
- AdditionalConstraintsElement
- AuthResources
- AuthenticatedElement
- DeliveryMethod
- MFAMode
- MfaTypesElement
- Mode
- OAuthGrantType
- OAuthScopesElement
- RequiredSignUpAttributesElement
- ResolutionStrategy
- Service
- ServiceName
- SignInMethod
- Status
- UnAuthenticatedElement
- BackendAPIAppSyncAuthSettings
- BackendAPIAuthType
- BackendAPIConflictResolution
- BackendAPIResourceConfig
- BackendAuthAppleProviderConfig
- BackendAuthSocialProviderConfig
- BackendJobRespObj
- BackendStoragePermissions
- CreateBackendAuthForgotPasswordConfig
- CreateBackendAuthIdentityPoolConfig
- CreateBackendAuthMFAConfig
- CreateBackendAuthOAuthConfig
- CreateBackendAuthPasswordPolicyConfig
- CreateBackendAuthResourceConfig
- CreateBackendAuthUserPoolConfig
- CreateBackendAuthVerificationMessageConfig
- CreateBackendStorageResourceConfig
- EmailSettings
- GetBackendStorageResourceConfig
- LoginAuthConfigReqObj
- ResourceConfig
- S3BucketInfo
- Settings
- SmsSettings
- SocialProviderSettings
- UpdateBackendAuthForgotPasswordConfig
- UpdateBackendAuthIdentityPoolConfig
- UpdateBackendAuthMFAConfig
- UpdateBackendAuthOAuthConfig
- UpdateBackendAuthPasswordPolicyConfig
- UpdateBackendAuthResourceConfig
- UpdateBackendAuthUserPoolConfig
- UpdateBackendAuthVerificationMessageConfig
- UpdateBackendStorageResourceConfig
Description
Synopsis
- defaultService :: Service
- _BadRequestException :: AsError a => Fold a ServiceError
- _GatewayTimeoutException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _TooManyRequestsException :: AsError a => Fold a ServiceError
- newtype AdditionalConstraintsElement where
- AdditionalConstraintsElement' { }
- pattern AdditionalConstraintsElement_REQUIRE_DIGIT :: AdditionalConstraintsElement
- pattern AdditionalConstraintsElement_REQUIRE_LOWERCASE :: AdditionalConstraintsElement
- pattern AdditionalConstraintsElement_REQUIRE_SYMBOL :: AdditionalConstraintsElement
- pattern AdditionalConstraintsElement_REQUIRE_UPPERCASE :: AdditionalConstraintsElement
- newtype AuthResources where
- AuthResources' { }
- pattern AuthResources_IDENTITY_POOL_AND_USER_POOL :: AuthResources
- pattern AuthResources_USER_POOL_ONLY :: AuthResources
- newtype AuthenticatedElement where
- newtype DeliveryMethod where
- DeliveryMethod' { }
- pattern DeliveryMethod_EMAIL :: DeliveryMethod
- pattern DeliveryMethod_SMS :: DeliveryMethod
- newtype MFAMode where
- MFAMode' {
- fromMFAMode :: Text
- pattern MFAMode_OFF :: MFAMode
- pattern MFAMode_ON :: MFAMode
- pattern MFAMode_OPTIONAL :: MFAMode
- MFAMode' {
- newtype MfaTypesElement where
- MfaTypesElement' { }
- pattern MfaTypesElement_SMS :: MfaTypesElement
- pattern MfaTypesElement_TOTP :: MfaTypesElement
- newtype Mode where
- Mode' { }
- pattern Mode_AMAZON_COGNITO_USER_POOLS :: Mode
- pattern Mode_API_KEY :: Mode
- pattern Mode_AWS_IAM :: Mode
- pattern Mode_OPENID_CONNECT :: Mode
- newtype OAuthGrantType where
- OAuthGrantType' { }
- pattern OAuthGrantType_CODE :: OAuthGrantType
- pattern OAuthGrantType_IMPLICIT :: OAuthGrantType
- newtype OAuthScopesElement where
- OAuthScopesElement' { }
- pattern OAuthScopesElement_AWS_COGNITO_SIGNIN_USER_ADMIN :: OAuthScopesElement
- pattern OAuthScopesElement_EMAIL :: OAuthScopesElement
- pattern OAuthScopesElement_OPENID :: OAuthScopesElement
- pattern OAuthScopesElement_PHONE :: OAuthScopesElement
- pattern OAuthScopesElement_PROFILE :: OAuthScopesElement
- newtype RequiredSignUpAttributesElement where
- RequiredSignUpAttributesElement' { }
- pattern RequiredSignUpAttributesElement_ADDRESS :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_BIRTHDATE :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_EMAIL :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_FAMILY_NAME :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_GENDER :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_GIVEN_NAME :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_LOCALE :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_MIDDLE_NAME :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_NAME :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_NICKNAME :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_PHONE_NUMBER :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_PICTURE :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_PREFERRED_USERNAME :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_PROFILE :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_UPDATED_AT :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_WEBSITE :: RequiredSignUpAttributesElement
- pattern RequiredSignUpAttributesElement_ZONE_INFO :: RequiredSignUpAttributesElement
- newtype ResolutionStrategy where
- newtype Service where
- Service' {
- fromService :: Text
- pattern Service_COGNITO :: Service
- Service' {
- newtype ServiceName where
- ServiceName' { }
- pattern ServiceName_S3 :: ServiceName
- newtype SignInMethod where
- SignInMethod' { }
- pattern SignInMethod_EMAIL :: SignInMethod
- pattern SignInMethod_EMAIL_AND_PHONE_NUMBER :: SignInMethod
- pattern SignInMethod_PHONE_NUMBER :: SignInMethod
- pattern SignInMethod_USERNAME :: SignInMethod
- newtype Status where
- Status' {
- fromStatus :: Text
- pattern Status_LATEST :: Status
- pattern Status_STALE :: Status
- Status' {
- newtype UnAuthenticatedElement where
- data BackendAPIAppSyncAuthSettings = BackendAPIAppSyncAuthSettings' {}
- newBackendAPIAppSyncAuthSettings :: BackendAPIAppSyncAuthSettings
- backendAPIAppSyncAuthSettings_cognitoUserPoolId :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text)
- backendAPIAppSyncAuthSettings_description :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text)
- backendAPIAppSyncAuthSettings_expirationTime :: Lens' BackendAPIAppSyncAuthSettings (Maybe Double)
- backendAPIAppSyncAuthSettings_openIDAuthTTL :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text)
- backendAPIAppSyncAuthSettings_openIDClientId :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text)
- backendAPIAppSyncAuthSettings_openIDIatTTL :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text)
- backendAPIAppSyncAuthSettings_openIDIssueURL :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text)
- backendAPIAppSyncAuthSettings_openIDProviderName :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text)
- data BackendAPIAuthType = BackendAPIAuthType' {}
- newBackendAPIAuthType :: BackendAPIAuthType
- backendAPIAuthType_mode :: Lens' BackendAPIAuthType (Maybe Mode)
- backendAPIAuthType_settings :: Lens' BackendAPIAuthType (Maybe BackendAPIAppSyncAuthSettings)
- data BackendAPIConflictResolution = BackendAPIConflictResolution' {}
- newBackendAPIConflictResolution :: BackendAPIConflictResolution
- backendAPIConflictResolution_resolutionStrategy :: Lens' BackendAPIConflictResolution (Maybe ResolutionStrategy)
- data BackendAPIResourceConfig = BackendAPIResourceConfig' {}
- newBackendAPIResourceConfig :: BackendAPIResourceConfig
- backendAPIResourceConfig_additionalAuthTypes :: Lens' BackendAPIResourceConfig (Maybe [BackendAPIAuthType])
- backendAPIResourceConfig_apiName :: Lens' BackendAPIResourceConfig (Maybe Text)
- backendAPIResourceConfig_conflictResolution :: Lens' BackendAPIResourceConfig (Maybe BackendAPIConflictResolution)
- backendAPIResourceConfig_defaultAuthType :: Lens' BackendAPIResourceConfig (Maybe BackendAPIAuthType)
- backendAPIResourceConfig_service :: Lens' BackendAPIResourceConfig (Maybe Text)
- backendAPIResourceConfig_transformSchema :: Lens' BackendAPIResourceConfig (Maybe Text)
- data BackendAuthAppleProviderConfig = BackendAuthAppleProviderConfig' {}
- newBackendAuthAppleProviderConfig :: BackendAuthAppleProviderConfig
- backendAuthAppleProviderConfig_clientId :: Lens' BackendAuthAppleProviderConfig (Maybe Text)
- backendAuthAppleProviderConfig_keyId :: Lens' BackendAuthAppleProviderConfig (Maybe Text)
- backendAuthAppleProviderConfig_privateKey :: Lens' BackendAuthAppleProviderConfig (Maybe Text)
- backendAuthAppleProviderConfig_teamId :: Lens' BackendAuthAppleProviderConfig (Maybe Text)
- data BackendAuthSocialProviderConfig = BackendAuthSocialProviderConfig' {}
- newBackendAuthSocialProviderConfig :: BackendAuthSocialProviderConfig
- backendAuthSocialProviderConfig_clientId :: Lens' BackendAuthSocialProviderConfig (Maybe Text)
- backendAuthSocialProviderConfig_clientSecret :: Lens' BackendAuthSocialProviderConfig (Maybe Text)
- data BackendJobRespObj = BackendJobRespObj' {}
- newBackendJobRespObj :: Text -> Text -> BackendJobRespObj
- backendJobRespObj_createTime :: Lens' BackendJobRespObj (Maybe Text)
- backendJobRespObj_error :: Lens' BackendJobRespObj (Maybe Text)
- backendJobRespObj_jobId :: Lens' BackendJobRespObj (Maybe Text)
- backendJobRespObj_operation :: Lens' BackendJobRespObj (Maybe Text)
- backendJobRespObj_status :: Lens' BackendJobRespObj (Maybe Text)
- backendJobRespObj_updateTime :: Lens' BackendJobRespObj (Maybe Text)
- backendJobRespObj_appId :: Lens' BackendJobRespObj Text
- backendJobRespObj_backendEnvironmentName :: Lens' BackendJobRespObj Text
- data BackendStoragePermissions = BackendStoragePermissions' {}
- newBackendStoragePermissions :: BackendStoragePermissions
- backendStoragePermissions_unAuthenticated :: Lens' BackendStoragePermissions (Maybe [UnAuthenticatedElement])
- backendStoragePermissions_authenticated :: Lens' BackendStoragePermissions [AuthenticatedElement]
- data CreateBackendAuthForgotPasswordConfig = CreateBackendAuthForgotPasswordConfig' {}
- newCreateBackendAuthForgotPasswordConfig :: DeliveryMethod -> CreateBackendAuthForgotPasswordConfig
- createBackendAuthForgotPasswordConfig_emailSettings :: Lens' CreateBackendAuthForgotPasswordConfig (Maybe EmailSettings)
- createBackendAuthForgotPasswordConfig_smsSettings :: Lens' CreateBackendAuthForgotPasswordConfig (Maybe SmsSettings)
- createBackendAuthForgotPasswordConfig_deliveryMethod :: Lens' CreateBackendAuthForgotPasswordConfig DeliveryMethod
- data CreateBackendAuthIdentityPoolConfig = CreateBackendAuthIdentityPoolConfig' {}
- newCreateBackendAuthIdentityPoolConfig :: Bool -> Text -> CreateBackendAuthIdentityPoolConfig
- createBackendAuthIdentityPoolConfig_unauthenticatedLogin :: Lens' CreateBackendAuthIdentityPoolConfig Bool
- createBackendAuthIdentityPoolConfig_identityPoolName :: Lens' CreateBackendAuthIdentityPoolConfig Text
- data CreateBackendAuthMFAConfig = CreateBackendAuthMFAConfig' {}
- newCreateBackendAuthMFAConfig :: MFAMode -> CreateBackendAuthMFAConfig
- createBackendAuthMFAConfig_settings :: Lens' CreateBackendAuthMFAConfig (Maybe Settings)
- createBackendAuthMFAConfig_mfaMode :: Lens' CreateBackendAuthMFAConfig MFAMode
- data CreateBackendAuthOAuthConfig = CreateBackendAuthOAuthConfig' {}
- newCreateBackendAuthOAuthConfig :: OAuthGrantType -> CreateBackendAuthOAuthConfig
- createBackendAuthOAuthConfig_domainPrefix :: Lens' CreateBackendAuthOAuthConfig (Maybe Text)
- createBackendAuthOAuthConfig_socialProviderSettings :: Lens' CreateBackendAuthOAuthConfig (Maybe SocialProviderSettings)
- createBackendAuthOAuthConfig_redirectSignOutURIs :: Lens' CreateBackendAuthOAuthConfig [Text]
- createBackendAuthOAuthConfig_redirectSignInURIs :: Lens' CreateBackendAuthOAuthConfig [Text]
- createBackendAuthOAuthConfig_oAuthGrantType :: Lens' CreateBackendAuthOAuthConfig OAuthGrantType
- createBackendAuthOAuthConfig_oAuthScopes :: Lens' CreateBackendAuthOAuthConfig [OAuthScopesElement]
- data CreateBackendAuthPasswordPolicyConfig = CreateBackendAuthPasswordPolicyConfig' {}
- newCreateBackendAuthPasswordPolicyConfig :: Double -> CreateBackendAuthPasswordPolicyConfig
- createBackendAuthPasswordPolicyConfig_additionalConstraints :: Lens' CreateBackendAuthPasswordPolicyConfig (Maybe [AdditionalConstraintsElement])
- createBackendAuthPasswordPolicyConfig_minimumLength :: Lens' CreateBackendAuthPasswordPolicyConfig Double
- data CreateBackendAuthResourceConfig = CreateBackendAuthResourceConfig' {}
- newCreateBackendAuthResourceConfig :: AuthResources -> CreateBackendAuthUserPoolConfig -> Service -> CreateBackendAuthResourceConfig
- createBackendAuthResourceConfig_identityPoolConfigs :: Lens' CreateBackendAuthResourceConfig (Maybe CreateBackendAuthIdentityPoolConfig)
- createBackendAuthResourceConfig_authResources :: Lens' CreateBackendAuthResourceConfig AuthResources
- createBackendAuthResourceConfig_userPoolConfigs :: Lens' CreateBackendAuthResourceConfig CreateBackendAuthUserPoolConfig
- createBackendAuthResourceConfig_service :: Lens' CreateBackendAuthResourceConfig Service
- data CreateBackendAuthUserPoolConfig = CreateBackendAuthUserPoolConfig' {
- forgotPassword :: Maybe CreateBackendAuthForgotPasswordConfig
- mfa :: Maybe CreateBackendAuthMFAConfig
- oAuth :: Maybe CreateBackendAuthOAuthConfig
- passwordPolicy :: Maybe CreateBackendAuthPasswordPolicyConfig
- verificationMessage :: Maybe CreateBackendAuthVerificationMessageConfig
- requiredSignUpAttributes :: [RequiredSignUpAttributesElement]
- signInMethod :: SignInMethod
- userPoolName :: Text
- newCreateBackendAuthUserPoolConfig :: SignInMethod -> Text -> CreateBackendAuthUserPoolConfig
- createBackendAuthUserPoolConfig_forgotPassword :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthForgotPasswordConfig)
- createBackendAuthUserPoolConfig_mfa :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthMFAConfig)
- createBackendAuthUserPoolConfig_oAuth :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthOAuthConfig)
- createBackendAuthUserPoolConfig_passwordPolicy :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthPasswordPolicyConfig)
- createBackendAuthUserPoolConfig_verificationMessage :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthVerificationMessageConfig)
- createBackendAuthUserPoolConfig_requiredSignUpAttributes :: Lens' CreateBackendAuthUserPoolConfig [RequiredSignUpAttributesElement]
- createBackendAuthUserPoolConfig_signInMethod :: Lens' CreateBackendAuthUserPoolConfig SignInMethod
- createBackendAuthUserPoolConfig_userPoolName :: Lens' CreateBackendAuthUserPoolConfig Text
- data CreateBackendAuthVerificationMessageConfig = CreateBackendAuthVerificationMessageConfig' {}
- newCreateBackendAuthVerificationMessageConfig :: DeliveryMethod -> CreateBackendAuthVerificationMessageConfig
- createBackendAuthVerificationMessageConfig_emailSettings :: Lens' CreateBackendAuthVerificationMessageConfig (Maybe EmailSettings)
- createBackendAuthVerificationMessageConfig_smsSettings :: Lens' CreateBackendAuthVerificationMessageConfig (Maybe SmsSettings)
- createBackendAuthVerificationMessageConfig_deliveryMethod :: Lens' CreateBackendAuthVerificationMessageConfig DeliveryMethod
- data CreateBackendStorageResourceConfig = CreateBackendStorageResourceConfig' {}
- newCreateBackendStorageResourceConfig :: ServiceName -> BackendStoragePermissions -> CreateBackendStorageResourceConfig
- createBackendStorageResourceConfig_bucketName :: Lens' CreateBackendStorageResourceConfig (Maybe Text)
- createBackendStorageResourceConfig_serviceName :: Lens' CreateBackendStorageResourceConfig ServiceName
- createBackendStorageResourceConfig_permissions :: Lens' CreateBackendStorageResourceConfig BackendStoragePermissions
- data EmailSettings = EmailSettings' {}
- newEmailSettings :: EmailSettings
- emailSettings_emailMessage :: Lens' EmailSettings (Maybe Text)
- emailSettings_emailSubject :: Lens' EmailSettings (Maybe Text)
- data GetBackendStorageResourceConfig = GetBackendStorageResourceConfig' {}
- newGetBackendStorageResourceConfig :: ServiceName -> Bool -> GetBackendStorageResourceConfig
- getBackendStorageResourceConfig_bucketName :: Lens' GetBackendStorageResourceConfig (Maybe Text)
- getBackendStorageResourceConfig_permissions :: Lens' GetBackendStorageResourceConfig (Maybe BackendStoragePermissions)
- getBackendStorageResourceConfig_serviceName :: Lens' GetBackendStorageResourceConfig ServiceName
- getBackendStorageResourceConfig_imported :: Lens' GetBackendStorageResourceConfig Bool
- data LoginAuthConfigReqObj = LoginAuthConfigReqObj' {}
- newLoginAuthConfigReqObj :: LoginAuthConfigReqObj
- loginAuthConfigReqObj_awsCognitoIdentityPoolId :: Lens' LoginAuthConfigReqObj (Maybe Text)
- loginAuthConfigReqObj_awsCognitoRegion :: Lens' LoginAuthConfigReqObj (Maybe Text)
- loginAuthConfigReqObj_awsUserPoolsId :: Lens' LoginAuthConfigReqObj (Maybe Text)
- loginAuthConfigReqObj_awsUserPoolsWebClientId :: Lens' LoginAuthConfigReqObj (Maybe Text)
- data ResourceConfig = ResourceConfig' {
- newResourceConfig :: ResourceConfig
- data S3BucketInfo = S3BucketInfo' {}
- newS3BucketInfo :: S3BucketInfo
- s3BucketInfo_creationDate :: Lens' S3BucketInfo (Maybe Text)
- s3BucketInfo_name :: Lens' S3BucketInfo (Maybe Text)
- data Settings = Settings' {
- mfaTypes :: Maybe [MfaTypesElement]
- smsMessage :: Maybe Text
- newSettings :: Settings
- settings_mfaTypes :: Lens' Settings (Maybe [MfaTypesElement])
- settings_smsMessage :: Lens' Settings (Maybe Text)
- data SmsSettings = SmsSettings' {
- smsMessage :: Maybe Text
- newSmsSettings :: SmsSettings
- smsSettings_smsMessage :: Lens' SmsSettings (Maybe Text)
- data SocialProviderSettings = SocialProviderSettings' {}
- newSocialProviderSettings :: SocialProviderSettings
- socialProviderSettings_facebook :: Lens' SocialProviderSettings (Maybe BackendAuthSocialProviderConfig)
- socialProviderSettings_google :: Lens' SocialProviderSettings (Maybe BackendAuthSocialProviderConfig)
- socialProviderSettings_loginWithAmazon :: Lens' SocialProviderSettings (Maybe BackendAuthSocialProviderConfig)
- socialProviderSettings_signInWithApple :: Lens' SocialProviderSettings (Maybe BackendAuthAppleProviderConfig)
- data UpdateBackendAuthForgotPasswordConfig = UpdateBackendAuthForgotPasswordConfig' {}
- newUpdateBackendAuthForgotPasswordConfig :: UpdateBackendAuthForgotPasswordConfig
- updateBackendAuthForgotPasswordConfig_deliveryMethod :: Lens' UpdateBackendAuthForgotPasswordConfig (Maybe DeliveryMethod)
- updateBackendAuthForgotPasswordConfig_emailSettings :: Lens' UpdateBackendAuthForgotPasswordConfig (Maybe EmailSettings)
- updateBackendAuthForgotPasswordConfig_smsSettings :: Lens' UpdateBackendAuthForgotPasswordConfig (Maybe SmsSettings)
- data UpdateBackendAuthIdentityPoolConfig = UpdateBackendAuthIdentityPoolConfig' {}
- newUpdateBackendAuthIdentityPoolConfig :: UpdateBackendAuthIdentityPoolConfig
- updateBackendAuthIdentityPoolConfig_unauthenticatedLogin :: Lens' UpdateBackendAuthIdentityPoolConfig (Maybe Bool)
- data UpdateBackendAuthMFAConfig = UpdateBackendAuthMFAConfig' {}
- newUpdateBackendAuthMFAConfig :: UpdateBackendAuthMFAConfig
- updateBackendAuthMFAConfig_mfaMode :: Lens' UpdateBackendAuthMFAConfig (Maybe MFAMode)
- updateBackendAuthMFAConfig_settings :: Lens' UpdateBackendAuthMFAConfig (Maybe Settings)
- data UpdateBackendAuthOAuthConfig = UpdateBackendAuthOAuthConfig' {}
- newUpdateBackendAuthOAuthConfig :: UpdateBackendAuthOAuthConfig
- updateBackendAuthOAuthConfig_domainPrefix :: Lens' UpdateBackendAuthOAuthConfig (Maybe Text)
- updateBackendAuthOAuthConfig_oAuthGrantType :: Lens' UpdateBackendAuthOAuthConfig (Maybe OAuthGrantType)
- updateBackendAuthOAuthConfig_oAuthScopes :: Lens' UpdateBackendAuthOAuthConfig (Maybe [OAuthScopesElement])
- updateBackendAuthOAuthConfig_redirectSignInURIs :: Lens' UpdateBackendAuthOAuthConfig (Maybe [Text])
- updateBackendAuthOAuthConfig_redirectSignOutURIs :: Lens' UpdateBackendAuthOAuthConfig (Maybe [Text])
- updateBackendAuthOAuthConfig_socialProviderSettings :: Lens' UpdateBackendAuthOAuthConfig (Maybe SocialProviderSettings)
- data UpdateBackendAuthPasswordPolicyConfig = UpdateBackendAuthPasswordPolicyConfig' {}
- newUpdateBackendAuthPasswordPolicyConfig :: UpdateBackendAuthPasswordPolicyConfig
- updateBackendAuthPasswordPolicyConfig_additionalConstraints :: Lens' UpdateBackendAuthPasswordPolicyConfig (Maybe [AdditionalConstraintsElement])
- updateBackendAuthPasswordPolicyConfig_minimumLength :: Lens' UpdateBackendAuthPasswordPolicyConfig (Maybe Double)
- data UpdateBackendAuthResourceConfig = UpdateBackendAuthResourceConfig' {}
- newUpdateBackendAuthResourceConfig :: AuthResources -> UpdateBackendAuthUserPoolConfig -> Service -> UpdateBackendAuthResourceConfig
- updateBackendAuthResourceConfig_identityPoolConfigs :: Lens' UpdateBackendAuthResourceConfig (Maybe UpdateBackendAuthIdentityPoolConfig)
- updateBackendAuthResourceConfig_authResources :: Lens' UpdateBackendAuthResourceConfig AuthResources
- updateBackendAuthResourceConfig_userPoolConfigs :: Lens' UpdateBackendAuthResourceConfig UpdateBackendAuthUserPoolConfig
- updateBackendAuthResourceConfig_service :: Lens' UpdateBackendAuthResourceConfig Service
- data UpdateBackendAuthUserPoolConfig = UpdateBackendAuthUserPoolConfig' {}
- newUpdateBackendAuthUserPoolConfig :: UpdateBackendAuthUserPoolConfig
- updateBackendAuthUserPoolConfig_forgotPassword :: Lens' UpdateBackendAuthUserPoolConfig (Maybe UpdateBackendAuthForgotPasswordConfig)
- updateBackendAuthUserPoolConfig_mfa :: Lens' UpdateBackendAuthUserPoolConfig (Maybe UpdateBackendAuthMFAConfig)
- updateBackendAuthUserPoolConfig_oAuth :: Lens' UpdateBackendAuthUserPoolConfig (Maybe UpdateBackendAuthOAuthConfig)
- updateBackendAuthUserPoolConfig_passwordPolicy :: Lens' UpdateBackendAuthUserPoolConfig (Maybe UpdateBackendAuthPasswordPolicyConfig)
- updateBackendAuthUserPoolConfig_verificationMessage :: Lens' UpdateBackendAuthUserPoolConfig (Maybe UpdateBackendAuthVerificationMessageConfig)
- data UpdateBackendAuthVerificationMessageConfig = UpdateBackendAuthVerificationMessageConfig' {}
- newUpdateBackendAuthVerificationMessageConfig :: DeliveryMethod -> UpdateBackendAuthVerificationMessageConfig
- updateBackendAuthVerificationMessageConfig_emailSettings :: Lens' UpdateBackendAuthVerificationMessageConfig (Maybe EmailSettings)
- updateBackendAuthVerificationMessageConfig_smsSettings :: Lens' UpdateBackendAuthVerificationMessageConfig (Maybe SmsSettings)
- updateBackendAuthVerificationMessageConfig_deliveryMethod :: Lens' UpdateBackendAuthVerificationMessageConfig DeliveryMethod
- data UpdateBackendStorageResourceConfig = UpdateBackendStorageResourceConfig' {}
- newUpdateBackendStorageResourceConfig :: ServiceName -> BackendStoragePermissions -> UpdateBackendStorageResourceConfig
- updateBackendStorageResourceConfig_serviceName :: Lens' UpdateBackendStorageResourceConfig ServiceName
- updateBackendStorageResourceConfig_permissions :: Lens' UpdateBackendStorageResourceConfig BackendStoragePermissions
Service Configuration
defaultService :: Service Source #
API version 2020-08-11 of the Amazon AmplifyBackend SDK configuration.
Errors
_BadRequestException :: AsError a => Fold a ServiceError Source #
An error returned if a request is not formed properly.
_GatewayTimeoutException :: AsError a => Fold a ServiceError Source #
An error returned if there's a temporary issue with the service.
_NotFoundException :: AsError a => Fold a ServiceError Source #
An error returned when a specific resource type is not found.
_TooManyRequestsException :: AsError a => Fold a ServiceError Source #
An error that is returned when a limit of a specific type has been exceeded.
AdditionalConstraintsElement
newtype AdditionalConstraintsElement Source #
Constructors
| AdditionalConstraintsElement' | |
Fields | |
Bundled Patterns
Instances
AuthResources
newtype AuthResources Source #
Constructors
| AuthResources' | |
Fields | |
Bundled Patterns
| pattern AuthResources_IDENTITY_POOL_AND_USER_POOL :: AuthResources | |
| pattern AuthResources_USER_POOL_ONLY :: AuthResources |
Instances
AuthenticatedElement
newtype AuthenticatedElement Source #
Constructors
| AuthenticatedElement' | |
Fields | |
Bundled Patterns
| pattern AuthenticatedElement_CREATE_AND_UPDATE :: AuthenticatedElement | |
| pattern AuthenticatedElement_DELETE :: AuthenticatedElement | |
| pattern AuthenticatedElement_READ :: AuthenticatedElement |
Instances
DeliveryMethod
newtype DeliveryMethod Source #
The type of verification message to send.
Constructors
| DeliveryMethod' | |
Fields | |
Bundled Patterns
| pattern DeliveryMethod_EMAIL :: DeliveryMethod | |
| pattern DeliveryMethod_SMS :: DeliveryMethod |
Instances
MFAMode
Constructors
| MFAMode' | |
Fields
| |
Bundled Patterns
| pattern MFAMode_OFF :: MFAMode | |
| pattern MFAMode_ON :: MFAMode | |
| pattern MFAMode_OPTIONAL :: MFAMode |
Instances
MfaTypesElement
newtype MfaTypesElement Source #
Constructors
| MfaTypesElement' | |
Fields | |
Bundled Patterns
| pattern MfaTypesElement_SMS :: MfaTypesElement | |
| pattern MfaTypesElement_TOTP :: MfaTypesElement |
Instances
Mode
Bundled Patterns
| pattern Mode_AMAZON_COGNITO_USER_POOLS :: Mode | |
| pattern Mode_API_KEY :: Mode | |
| pattern Mode_AWS_IAM :: Mode | |
| pattern Mode_OPENID_CONNECT :: Mode |
Instances
OAuthGrantType
newtype OAuthGrantType Source #
Constructors
| OAuthGrantType' | |
Fields | |
Bundled Patterns
| pattern OAuthGrantType_CODE :: OAuthGrantType | |
| pattern OAuthGrantType_IMPLICIT :: OAuthGrantType |
Instances
OAuthScopesElement
newtype OAuthScopesElement Source #
Constructors
| OAuthScopesElement' | |
Fields | |
Bundled Patterns
| pattern OAuthScopesElement_AWS_COGNITO_SIGNIN_USER_ADMIN :: OAuthScopesElement | |
| pattern OAuthScopesElement_EMAIL :: OAuthScopesElement | |
| pattern OAuthScopesElement_OPENID :: OAuthScopesElement | |
| pattern OAuthScopesElement_PHONE :: OAuthScopesElement | |
| pattern OAuthScopesElement_PROFILE :: OAuthScopesElement |
Instances
RequiredSignUpAttributesElement
newtype RequiredSignUpAttributesElement Source #
Constructors
| RequiredSignUpAttributesElement' | |
Fields | |
Bundled Patterns
Instances
ResolutionStrategy
newtype ResolutionStrategy Source #
Constructors
| ResolutionStrategy' | |
Fields | |
Bundled Patterns
| pattern ResolutionStrategy_AUTOMERGE :: ResolutionStrategy | |
| pattern ResolutionStrategy_LAMBDA :: ResolutionStrategy | |
| pattern ResolutionStrategy_NONE :: ResolutionStrategy | |
| pattern ResolutionStrategy_OPTIMISTIC_CONCURRENCY :: ResolutionStrategy |
Instances
Service
Constructors
| Service' | |
Fields
| |
Bundled Patterns
| pattern Service_COGNITO :: Service |
Instances
ServiceName
newtype ServiceName Source #
Constructors
| ServiceName' | |
Fields | |
Bundled Patterns
| pattern ServiceName_S3 :: ServiceName |
Instances
SignInMethod
newtype SignInMethod Source #
Constructors
| SignInMethod' | |
Fields | |
Bundled Patterns
| pattern SignInMethod_EMAIL :: SignInMethod | |
| pattern SignInMethod_EMAIL_AND_PHONE_NUMBER :: SignInMethod | |
| pattern SignInMethod_PHONE_NUMBER :: SignInMethod | |
| pattern SignInMethod_USERNAME :: SignInMethod |
Instances
Status
Constructors
| Status' | |
Fields
| |
Bundled Patterns
| pattern Status_LATEST :: Status | |
| pattern Status_STALE :: Status |
Instances
UnAuthenticatedElement
newtype UnAuthenticatedElement Source #
Constructors
| UnAuthenticatedElement' | |
Fields | |
Bundled Patterns
Instances
BackendAPIAppSyncAuthSettings
data BackendAPIAppSyncAuthSettings Source #
The authentication settings for accessing provisioned data models in your Amplify project.
See: newBackendAPIAppSyncAuthSettings smart constructor.
Constructors
| BackendAPIAppSyncAuthSettings' | |
Fields
| |
Instances
newBackendAPIAppSyncAuthSettings :: BackendAPIAppSyncAuthSettings Source #
Create a value of BackendAPIAppSyncAuthSettings 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:cognitoUserPoolId:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_cognitoUserPoolId - The Amazon Cognito user pool ID, if Amazon Cognito was used as an
authentication setting to access your data models.
$sel:description:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_description - The API key description for API_KEY, if it was used as an authentication
mechanism to access your data models.
$sel:expirationTime:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_expirationTime - The API key expiration time for API_KEY, if it was used as an
authentication mechanism to access your data models.
$sel:openIDAuthTTL:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_openIDAuthTTL - The expiry time for the OpenID authentication mechanism.
$sel:openIDClientId:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_openIDClientId - The clientID for openID, if openID was used as an authentication setting
to access your data models.
$sel:openIDIatTTL:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_openIDIatTTL - The expiry time for the OpenID authentication mechanism.
$sel:openIDIssueURL:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_openIDIssueURL - The openID issuer URL, if openID was used as an authentication setting
to access your data models.
$sel:openIDProviderName:BackendAPIAppSyncAuthSettings', backendAPIAppSyncAuthSettings_openIDProviderName - The OpenID provider name, if OpenID was used as an authentication
mechanism to access your data models.
backendAPIAppSyncAuthSettings_cognitoUserPoolId :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
backendAPIAppSyncAuthSettings_description :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
backendAPIAppSyncAuthSettings_expirationTime :: Lens' BackendAPIAppSyncAuthSettings (Maybe Double) Source #
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
backendAPIAppSyncAuthSettings_openIDAuthTTL :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #
The expiry time for the OpenID authentication mechanism.
backendAPIAppSyncAuthSettings_openIDClientId :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #
The clientID for openID, if openID was used as an authentication setting to access your data models.
backendAPIAppSyncAuthSettings_openIDIatTTL :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #
The expiry time for the OpenID authentication mechanism.
backendAPIAppSyncAuthSettings_openIDIssueURL :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #
The openID issuer URL, if openID was used as an authentication setting to access your data models.
backendAPIAppSyncAuthSettings_openIDProviderName :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
BackendAPIAuthType
data BackendAPIAuthType Source #
Describes the auth types for your configured data models.
See: newBackendAPIAuthType smart constructor.
Constructors
| BackendAPIAuthType' | |
Instances
newBackendAPIAuthType :: BackendAPIAuthType Source #
Create a value of BackendAPIAuthType 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:mode:BackendAPIAuthType', backendAPIAuthType_mode - Describes the authentication mode.
$sel:settings:BackendAPIAuthType', backendAPIAuthType_settings - Describes settings for the authentication mode.
backendAPIAuthType_mode :: Lens' BackendAPIAuthType (Maybe Mode) Source #
Describes the authentication mode.
backendAPIAuthType_settings :: Lens' BackendAPIAuthType (Maybe BackendAPIAppSyncAuthSettings) Source #
Describes settings for the authentication mode.
BackendAPIConflictResolution
data BackendAPIConflictResolution Source #
Describes the conflict resolution configuration for your data model configured in your Amplify project.
See: newBackendAPIConflictResolution smart constructor.
Constructors
| BackendAPIConflictResolution' | |
Fields
| |
Instances
newBackendAPIConflictResolution :: BackendAPIConflictResolution Source #
Create a value of BackendAPIConflictResolution 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:resolutionStrategy:BackendAPIConflictResolution', backendAPIConflictResolution_resolutionStrategy - The strategy for conflict resolution.
backendAPIConflictResolution_resolutionStrategy :: Lens' BackendAPIConflictResolution (Maybe ResolutionStrategy) Source #
The strategy for conflict resolution.
BackendAPIResourceConfig
data BackendAPIResourceConfig Source #
The resource config for the data model, configured as a part of the Amplify project.
See: newBackendAPIResourceConfig smart constructor.
Constructors
| BackendAPIResourceConfig' | |
Fields
| |
Instances
newBackendAPIResourceConfig :: BackendAPIResourceConfig Source #
Create a value of BackendAPIResourceConfig 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:additionalAuthTypes:BackendAPIResourceConfig', backendAPIResourceConfig_additionalAuthTypes - Additional authentication methods used to interact with your data
models.
$sel:apiName:BackendAPIResourceConfig', backendAPIResourceConfig_apiName - The API name used to interact with the data model, configured as a part
of your Amplify project.
$sel:conflictResolution:BackendAPIResourceConfig', backendAPIResourceConfig_conflictResolution - The conflict resolution strategy for your data stored in the data
models.
$sel:defaultAuthType:BackendAPIResourceConfig', backendAPIResourceConfig_defaultAuthType - The default authentication type for interacting with the configured data
models in your Amplify project.
$sel:service:BackendAPIResourceConfig', backendAPIResourceConfig_service - The service used to provision and interact with the data model.
$sel:transformSchema:BackendAPIResourceConfig', backendAPIResourceConfig_transformSchema - The definition of the data model in the annotated transform of the
GraphQL schema.
backendAPIResourceConfig_additionalAuthTypes :: Lens' BackendAPIResourceConfig (Maybe [BackendAPIAuthType]) Source #
Additional authentication methods used to interact with your data models.
backendAPIResourceConfig_apiName :: Lens' BackendAPIResourceConfig (Maybe Text) Source #
The API name used to interact with the data model, configured as a part of your Amplify project.
backendAPIResourceConfig_conflictResolution :: Lens' BackendAPIResourceConfig (Maybe BackendAPIConflictResolution) Source #
The conflict resolution strategy for your data stored in the data models.
backendAPIResourceConfig_defaultAuthType :: Lens' BackendAPIResourceConfig (Maybe BackendAPIAuthType) Source #
The default authentication type for interacting with the configured data models in your Amplify project.
backendAPIResourceConfig_service :: Lens' BackendAPIResourceConfig (Maybe Text) Source #
The service used to provision and interact with the data model.
backendAPIResourceConfig_transformSchema :: Lens' BackendAPIResourceConfig (Maybe Text) Source #
The definition of the data model in the annotated transform of the GraphQL schema.
BackendAuthAppleProviderConfig
data BackendAuthAppleProviderConfig Source #
Describes Apple social federation configurations for allowing your app users to sign in using OAuth.
See: newBackendAuthAppleProviderConfig smart constructor.
Constructors
| BackendAuthAppleProviderConfig' | |
Instances
newBackendAuthAppleProviderConfig :: BackendAuthAppleProviderConfig Source #
Create a value of BackendAuthAppleProviderConfig 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:clientId:BackendAuthAppleProviderConfig', backendAuthAppleProviderConfig_clientId - Describes the client_id (also called Services ID) that comes from Apple.
$sel:keyId:BackendAuthAppleProviderConfig', backendAuthAppleProviderConfig_keyId - Describes the key_id that comes from Apple.
$sel:privateKey:BackendAuthAppleProviderConfig', backendAuthAppleProviderConfig_privateKey - Describes the private_key that comes from Apple.
$sel:teamId:BackendAuthAppleProviderConfig', backendAuthAppleProviderConfig_teamId - Describes the team_id that comes from Apple.
backendAuthAppleProviderConfig_clientId :: Lens' BackendAuthAppleProviderConfig (Maybe Text) Source #
Describes the client_id (also called Services ID) that comes from Apple.
backendAuthAppleProviderConfig_keyId :: Lens' BackendAuthAppleProviderConfig (Maybe Text) Source #
Describes the key_id that comes from Apple.
backendAuthAppleProviderConfig_privateKey :: Lens' BackendAuthAppleProviderConfig (Maybe Text) Source #
Describes the private_key that comes from Apple.
backendAuthAppleProviderConfig_teamId :: Lens' BackendAuthAppleProviderConfig (Maybe Text) Source #
Describes the team_id that comes from Apple.
BackendAuthSocialProviderConfig
data BackendAuthSocialProviderConfig Source #
Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
See: newBackendAuthSocialProviderConfig smart constructor.
Constructors
| BackendAuthSocialProviderConfig' | |
Instances
newBackendAuthSocialProviderConfig :: BackendAuthSocialProviderConfig Source #
Create a value of BackendAuthSocialProviderConfig 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:clientId:BackendAuthSocialProviderConfig', backendAuthSocialProviderConfig_clientId - Describes the client_id, which can be obtained from the third-party
social federation provider.
$sel:clientSecret:BackendAuthSocialProviderConfig', backendAuthSocialProviderConfig_clientSecret - Describes the client_secret, which can be obtained from third-party
social federation providers.
backendAuthSocialProviderConfig_clientId :: Lens' BackendAuthSocialProviderConfig (Maybe Text) Source #
Describes the client_id, which can be obtained from the third-party social federation provider.
backendAuthSocialProviderConfig_clientSecret :: Lens' BackendAuthSocialProviderConfig (Maybe Text) Source #
Describes the client_secret, which can be obtained from third-party social federation providers.
BackendJobRespObj
data BackendJobRespObj Source #
The response object for this operation.
See: newBackendJobRespObj smart constructor.
Constructors
| BackendJobRespObj' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> BackendJobRespObj |
Create a value of BackendJobRespObj 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:createTime:BackendJobRespObj', backendJobRespObj_createTime - The time when the job was created.
$sel:error:BackendJobRespObj', backendJobRespObj_error - If the request fails, this error is returned.
$sel:jobId:BackendJobRespObj', backendJobRespObj_jobId - The ID for the job.
$sel:operation:BackendJobRespObj', backendJobRespObj_operation - The name of the operation.
$sel:status:BackendJobRespObj', backendJobRespObj_status - The current status of the request.
$sel:updateTime:BackendJobRespObj', backendJobRespObj_updateTime - The time when the job was last updated.
$sel:appId:BackendJobRespObj', backendJobRespObj_appId - The app ID.
$sel:backendEnvironmentName:BackendJobRespObj', backendJobRespObj_backendEnvironmentName - The name of the backend environment.
backendJobRespObj_createTime :: Lens' BackendJobRespObj (Maybe Text) Source #
The time when the job was created.
backendJobRespObj_error :: Lens' BackendJobRespObj (Maybe Text) Source #
If the request fails, this error is returned.
backendJobRespObj_jobId :: Lens' BackendJobRespObj (Maybe Text) Source #
The ID for the job.
backendJobRespObj_operation :: Lens' BackendJobRespObj (Maybe Text) Source #
The name of the operation.
backendJobRespObj_status :: Lens' BackendJobRespObj (Maybe Text) Source #
The current status of the request.
backendJobRespObj_updateTime :: Lens' BackendJobRespObj (Maybe Text) Source #
The time when the job was last updated.
backendJobRespObj_appId :: Lens' BackendJobRespObj Text Source #
The app ID.
backendJobRespObj_backendEnvironmentName :: Lens' BackendJobRespObj Text Source #
The name of the backend environment.
BackendStoragePermissions
data BackendStoragePermissions Source #
Describes the read, write, and delete permissions users have against your storage S3 bucket.
See: newBackendStoragePermissions smart constructor.
Constructors
| BackendStoragePermissions' | |
Fields
| |
Instances
newBackendStoragePermissions :: BackendStoragePermissions Source #
Create a value of BackendStoragePermissions 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:unAuthenticated:BackendStoragePermissions', backendStoragePermissions_unAuthenticated - Lists all unauthenticated user read, write, and delete permissions for
your S3 bucket.
$sel:authenticated:BackendStoragePermissions', backendStoragePermissions_authenticated - Lists all authenticated user read, write, and delete permissions for
your S3 bucket.
backendStoragePermissions_unAuthenticated :: Lens' BackendStoragePermissions (Maybe [UnAuthenticatedElement]) Source #
Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.
backendStoragePermissions_authenticated :: Lens' BackendStoragePermissions [AuthenticatedElement] Source #
Lists all authenticated user read, write, and delete permissions for your S3 bucket.
CreateBackendAuthForgotPasswordConfig
data CreateBackendAuthForgotPasswordConfig Source #
(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.
See: newCreateBackendAuthForgotPasswordConfig smart constructor.
Constructors
| CreateBackendAuthForgotPasswordConfig' | |
Fields
| |
Instances
newCreateBackendAuthForgotPasswordConfig Source #
Arguments
| :: DeliveryMethod | |
| -> CreateBackendAuthForgotPasswordConfig |
Create a value of CreateBackendAuthForgotPasswordConfig 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:emailSettings:CreateBackendAuthForgotPasswordConfig', createBackendAuthForgotPasswordConfig_emailSettings - (DEPRECATED) The configuration for the email sent when an app user
forgets their password.
$sel:smsSettings:CreateBackendAuthForgotPasswordConfig', createBackendAuthForgotPasswordConfig_smsSettings - (DEPRECATED) The configuration for the SMS message sent when an app
user forgets their password.
$sel:deliveryMethod:CreateBackendAuthForgotPasswordConfig', createBackendAuthForgotPasswordConfig_deliveryMethod - (DEPRECATED) Describes which mode to use (either SMS or email) to
deliver messages to app users who want to recover their password.
createBackendAuthForgotPasswordConfig_emailSettings :: Lens' CreateBackendAuthForgotPasswordConfig (Maybe EmailSettings) Source #
(DEPRECATED) The configuration for the email sent when an app user forgets their password.
createBackendAuthForgotPasswordConfig_smsSettings :: Lens' CreateBackendAuthForgotPasswordConfig (Maybe SmsSettings) Source #
(DEPRECATED) The configuration for the SMS message sent when an app user forgets their password.
createBackendAuthForgotPasswordConfig_deliveryMethod :: Lens' CreateBackendAuthForgotPasswordConfig DeliveryMethod Source #
(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.
CreateBackendAuthIdentityPoolConfig
data CreateBackendAuthIdentityPoolConfig Source #
Describes authorization configurations for the auth resources, configured as a part of your Amplify project.
See: newCreateBackendAuthIdentityPoolConfig smart constructor.
Constructors
| CreateBackendAuthIdentityPoolConfig' | |
Fields
| |
Instances
newCreateBackendAuthIdentityPoolConfig Source #
Arguments
| :: Bool |
|
| -> Text | |
| -> CreateBackendAuthIdentityPoolConfig |
Create a value of CreateBackendAuthIdentityPoolConfig 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:unauthenticatedLogin:CreateBackendAuthIdentityPoolConfig', createBackendAuthIdentityPoolConfig_unauthenticatedLogin - Set to true or false based on whether you want to enable guest
authorization to your Amplify app.
$sel:identityPoolName:CreateBackendAuthIdentityPoolConfig', createBackendAuthIdentityPoolConfig_identityPoolName - Name of the Amazon Cognito identity pool used for authorization.
createBackendAuthIdentityPoolConfig_unauthenticatedLogin :: Lens' CreateBackendAuthIdentityPoolConfig Bool Source #
Set to true or false based on whether you want to enable guest authorization to your Amplify app.
createBackendAuthIdentityPoolConfig_identityPoolName :: Lens' CreateBackendAuthIdentityPoolConfig Text Source #
Name of the Amazon Cognito identity pool used for authorization.
CreateBackendAuthMFAConfig
data CreateBackendAuthMFAConfig Source #
Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
See: newCreateBackendAuthMFAConfig smart constructor.
Constructors
| CreateBackendAuthMFAConfig' | |
Instances
newCreateBackendAuthMFAConfig Source #
Create a value of CreateBackendAuthMFAConfig 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:settings:CreateBackendAuthMFAConfig', createBackendAuthMFAConfig_settings - Describes the configuration settings and methods for your Amplify app
users to use MFA.
$sel:mfaMode:CreateBackendAuthMFAConfig', createBackendAuthMFAConfig_mfaMode - Describes whether MFA should be [ON, OFF, or OPTIONAL] for
authentication in your Amplify project.
createBackendAuthMFAConfig_settings :: Lens' CreateBackendAuthMFAConfig (Maybe Settings) Source #
Describes the configuration settings and methods for your Amplify app users to use MFA.
createBackendAuthMFAConfig_mfaMode :: Lens' CreateBackendAuthMFAConfig MFAMode Source #
Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.
CreateBackendAuthOAuthConfig
data CreateBackendAuthOAuthConfig Source #
Creates the OAuth configuration for your Amplify project.
See: newCreateBackendAuthOAuthConfig smart constructor.
Constructors
| CreateBackendAuthOAuthConfig' | |
Fields
| |
Instances
newCreateBackendAuthOAuthConfig Source #
Arguments
| :: OAuthGrantType | |
| -> CreateBackendAuthOAuthConfig |
Create a value of CreateBackendAuthOAuthConfig 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:domainPrefix:CreateBackendAuthOAuthConfig', createBackendAuthOAuthConfig_domainPrefix - The domain prefix for your Amplify app.
$sel:socialProviderSettings:CreateBackendAuthOAuthConfig', createBackendAuthOAuthConfig_socialProviderSettings - The settings for using social providers to access your Amplify app.
$sel:redirectSignOutURIs:CreateBackendAuthOAuthConfig', createBackendAuthOAuthConfig_redirectSignOutURIs - Redirect URLs that OAuth uses when a user signs out of an Amplify app.
$sel:redirectSignInURIs:CreateBackendAuthOAuthConfig', createBackendAuthOAuthConfig_redirectSignInURIs - The redirected URI for signing in to your Amplify app.
$sel:oAuthGrantType:CreateBackendAuthOAuthConfig', createBackendAuthOAuthConfig_oAuthGrantType - The OAuth grant type that you use to allow app users to authenticate
from your Amplify app.
$sel:oAuthScopes:CreateBackendAuthOAuthConfig', createBackendAuthOAuthConfig_oAuthScopes - List of OAuth-related flows used to allow your app users to authenticate
from your Amplify app.
createBackendAuthOAuthConfig_domainPrefix :: Lens' CreateBackendAuthOAuthConfig (Maybe Text) Source #
The domain prefix for your Amplify app.
createBackendAuthOAuthConfig_socialProviderSettings :: Lens' CreateBackendAuthOAuthConfig (Maybe SocialProviderSettings) Source #
The settings for using social providers to access your Amplify app.
createBackendAuthOAuthConfig_redirectSignOutURIs :: Lens' CreateBackendAuthOAuthConfig [Text] Source #
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
createBackendAuthOAuthConfig_redirectSignInURIs :: Lens' CreateBackendAuthOAuthConfig [Text] Source #
The redirected URI for signing in to your Amplify app.
createBackendAuthOAuthConfig_oAuthGrantType :: Lens' CreateBackendAuthOAuthConfig OAuthGrantType Source #
The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
createBackendAuthOAuthConfig_oAuthScopes :: Lens' CreateBackendAuthOAuthConfig [OAuthScopesElement] Source #
List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
CreateBackendAuthPasswordPolicyConfig
data CreateBackendAuthPasswordPolicyConfig Source #
The password policy configuration for the backend to your Amplify project.
See: newCreateBackendAuthPasswordPolicyConfig smart constructor.
Constructors
| CreateBackendAuthPasswordPolicyConfig' | |
Fields
| |
Instances
newCreateBackendAuthPasswordPolicyConfig Source #
Arguments
| :: Double | |
| -> CreateBackendAuthPasswordPolicyConfig |
Create a value of CreateBackendAuthPasswordPolicyConfig 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:additionalConstraints:CreateBackendAuthPasswordPolicyConfig', createBackendAuthPasswordPolicyConfig_additionalConstraints - Additional constraints for the password used to access the backend of
your Amplify project.
$sel:minimumLength:CreateBackendAuthPasswordPolicyConfig', createBackendAuthPasswordPolicyConfig_minimumLength - The minimum length of the password used to access the backend of your
Amplify project.
createBackendAuthPasswordPolicyConfig_additionalConstraints :: Lens' CreateBackendAuthPasswordPolicyConfig (Maybe [AdditionalConstraintsElement]) Source #
Additional constraints for the password used to access the backend of your Amplify project.
createBackendAuthPasswordPolicyConfig_minimumLength :: Lens' CreateBackendAuthPasswordPolicyConfig Double Source #
The minimum length of the password used to access the backend of your Amplify project.
CreateBackendAuthResourceConfig
data CreateBackendAuthResourceConfig Source #
Defines the resource configuration when creating an auth resource in your Amplify project.
See: newCreateBackendAuthResourceConfig smart constructor.
Constructors
| CreateBackendAuthResourceConfig' | |
Fields
| |
Instances
newCreateBackendAuthResourceConfig Source #
Arguments
| :: AuthResources | |
| -> CreateBackendAuthUserPoolConfig | |
| -> Service | |
| -> CreateBackendAuthResourceConfig |
Create a value of CreateBackendAuthResourceConfig 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:identityPoolConfigs:CreateBackendAuthResourceConfig', createBackendAuthResourceConfig_identityPoolConfigs - Describes the authorization configuration for the Amazon Cognito
identity pool, provisioned as a part of your auth resource in the
Amplify project.
$sel:authResources:CreateBackendAuthResourceConfig', createBackendAuthResourceConfig_authResources - Defines whether you want to configure only authentication or both
authentication and authorization settings.
$sel:userPoolConfigs:CreateBackendAuthResourceConfig', createBackendAuthResourceConfig_userPoolConfigs - Describes authentication configuration for the Amazon Cognito user pool,
provisioned as a part of your auth resource in the Amplify project.
$sel:service:CreateBackendAuthResourceConfig', createBackendAuthResourceConfig_service - Defines the service name to use when configuring an authentication
resource in your Amplify project.
createBackendAuthResourceConfig_identityPoolConfigs :: Lens' CreateBackendAuthResourceConfig (Maybe CreateBackendAuthIdentityPoolConfig) Source #
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
createBackendAuthResourceConfig_authResources :: Lens' CreateBackendAuthResourceConfig AuthResources Source #
Defines whether you want to configure only authentication or both authentication and authorization settings.
createBackendAuthResourceConfig_userPoolConfigs :: Lens' CreateBackendAuthResourceConfig CreateBackendAuthUserPoolConfig Source #
Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
createBackendAuthResourceConfig_service :: Lens' CreateBackendAuthResourceConfig Service Source #
Defines the service name to use when configuring an authentication resource in your Amplify project.
CreateBackendAuthUserPoolConfig
data CreateBackendAuthUserPoolConfig Source #
Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.
See: newCreateBackendAuthUserPoolConfig smart constructor.
Constructors
| CreateBackendAuthUserPoolConfig' | |
Fields
| |
Instances
newCreateBackendAuthUserPoolConfig Source #
Arguments
| :: SignInMethod | |
| -> Text | |
| -> CreateBackendAuthUserPoolConfig |
Create a value of CreateBackendAuthUserPoolConfig 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:forgotPassword:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_forgotPassword - (DEPRECATED) Describes the forgotten password policy for your Amazon
Cognito user pool, configured as a part of your Amplify project.
$sel:mfa:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_mfa - Describes whether to apply multi-factor authentication policies for your
Amazon Cognito user pool configured as a part of your Amplify project.
$sel:oAuth:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_oAuth - Describes the OAuth policy and rules for your Amazon Cognito user pool,
configured as a part of your Amplify project.
$sel:passwordPolicy:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_passwordPolicy - Describes the password policy for your Amazon Cognito user pool,
configured as a part of your Amplify project.
$sel:verificationMessage:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_verificationMessage - Describes the email or SMS verification message for your Amazon Cognito
user pool, configured as a part of your Amplify project.
$sel:requiredSignUpAttributes:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_requiredSignUpAttributes - The required attributes to sign up new users in the user pool.
$sel:signInMethod:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_signInMethod - Describes the sign-in methods that your Amplify app users use to log in
using the Amazon Cognito user pool, configured as a part of your Amplify
project.
$sel:userPoolName:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_userPoolName - The Amazon Cognito user pool name.
createBackendAuthUserPoolConfig_forgotPassword :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthForgotPasswordConfig) Source #
(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
createBackendAuthUserPoolConfig_mfa :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthMFAConfig) Source #
Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
createBackendAuthUserPoolConfig_oAuth :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthOAuthConfig) Source #
Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
createBackendAuthUserPoolConfig_passwordPolicy :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthPasswordPolicyConfig) Source #
Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
createBackendAuthUserPoolConfig_verificationMessage :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthVerificationMessageConfig) Source #
Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
createBackendAuthUserPoolConfig_requiredSignUpAttributes :: Lens' CreateBackendAuthUserPoolConfig [RequiredSignUpAttributesElement] Source #
The required attributes to sign up new users in the user pool.
createBackendAuthUserPoolConfig_signInMethod :: Lens' CreateBackendAuthUserPoolConfig SignInMethod Source #
Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.
createBackendAuthUserPoolConfig_userPoolName :: Lens' CreateBackendAuthUserPoolConfig Text Source #
The Amazon Cognito user pool name.
CreateBackendAuthVerificationMessageConfig
data CreateBackendAuthVerificationMessageConfig Source #
Creates an email or SMS verification message for the auth resource configured for your Amplify project.
See: newCreateBackendAuthVerificationMessageConfig smart constructor.
Constructors
| CreateBackendAuthVerificationMessageConfig' | |
Fields
| |
Instances
newCreateBackendAuthVerificationMessageConfig Source #
Arguments
| :: DeliveryMethod |
|
| -> CreateBackendAuthVerificationMessageConfig |
Create a value of CreateBackendAuthVerificationMessageConfig 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:emailSettings:CreateBackendAuthVerificationMessageConfig', createBackendAuthVerificationMessageConfig_emailSettings - The settings for the email message.
$sel:smsSettings:CreateBackendAuthVerificationMessageConfig', createBackendAuthVerificationMessageConfig_smsSettings - The settings for the SMS message.
$sel:deliveryMethod:CreateBackendAuthVerificationMessageConfig', createBackendAuthVerificationMessageConfig_deliveryMethod - The type of verification message to send.
createBackendAuthVerificationMessageConfig_emailSettings :: Lens' CreateBackendAuthVerificationMessageConfig (Maybe EmailSettings) Source #
The settings for the email message.
createBackendAuthVerificationMessageConfig_smsSettings :: Lens' CreateBackendAuthVerificationMessageConfig (Maybe SmsSettings) Source #
The settings for the SMS message.
createBackendAuthVerificationMessageConfig_deliveryMethod :: Lens' CreateBackendAuthVerificationMessageConfig DeliveryMethod Source #
The type of verification message to send.
CreateBackendStorageResourceConfig
data CreateBackendStorageResourceConfig Source #
The resource configuration for creating backend storage.
See: newCreateBackendStorageResourceConfig smart constructor.
Constructors
| CreateBackendStorageResourceConfig' | |
Fields
| |
Instances
newCreateBackendStorageResourceConfig Source #
Arguments
| :: ServiceName | |
| -> BackendStoragePermissions | |
| -> CreateBackendStorageResourceConfig |
Create a value of CreateBackendStorageResourceConfig 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:bucketName:CreateBackendStorageResourceConfig', createBackendStorageResourceConfig_bucketName - The name of the S3 bucket.
$sel:serviceName:CreateBackendStorageResourceConfig', createBackendStorageResourceConfig_serviceName - The name of the storage service.
$sel:permissions:CreateBackendStorageResourceConfig', createBackendStorageResourceConfig_permissions - The authorization configuration for the storage S3 bucket.
createBackendStorageResourceConfig_bucketName :: Lens' CreateBackendStorageResourceConfig (Maybe Text) Source #
The name of the S3 bucket.
createBackendStorageResourceConfig_serviceName :: Lens' CreateBackendStorageResourceConfig ServiceName Source #
The name of the storage service.
createBackendStorageResourceConfig_permissions :: Lens' CreateBackendStorageResourceConfig BackendStoragePermissions Source #
The authorization configuration for the storage S3 bucket.
EmailSettings
data EmailSettings Source #
The configuration for the email sent when an app user forgets their password.
See: newEmailSettings smart constructor.
Constructors
| EmailSettings' | |
Fields
| |
Instances
newEmailSettings :: EmailSettings Source #
Create a value of EmailSettings 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:emailMessage:EmailSettings', emailSettings_emailMessage - The contents of the email message.
$sel:emailSubject:EmailSettings', emailSettings_emailSubject - The contents of the subject line of the email message.
emailSettings_emailMessage :: Lens' EmailSettings (Maybe Text) Source #
The contents of the email message.
emailSettings_emailSubject :: Lens' EmailSettings (Maybe Text) Source #
The contents of the subject line of the email message.
GetBackendStorageResourceConfig
data GetBackendStorageResourceConfig Source #
The details for a backend storage resource.
See: newGetBackendStorageResourceConfig smart constructor.
Constructors
| GetBackendStorageResourceConfig' | |
Fields
| |
Instances
newGetBackendStorageResourceConfig Source #
Arguments
| :: ServiceName | |
| -> Bool | |
| -> GetBackendStorageResourceConfig |
Create a value of GetBackendStorageResourceConfig 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:bucketName:GetBackendStorageResourceConfig', getBackendStorageResourceConfig_bucketName - The name of the S3 bucket.
$sel:permissions:GetBackendStorageResourceConfig', getBackendStorageResourceConfig_permissions - The authorization configuration for the storage S3 bucket.
$sel:serviceName:GetBackendStorageResourceConfig', getBackendStorageResourceConfig_serviceName - The name of the storage service.
$sel:imported:GetBackendStorageResourceConfig', getBackendStorageResourceConfig_imported - Returns True if the storage resource has been imported.
getBackendStorageResourceConfig_bucketName :: Lens' GetBackendStorageResourceConfig (Maybe Text) Source #
The name of the S3 bucket.
getBackendStorageResourceConfig_permissions :: Lens' GetBackendStorageResourceConfig (Maybe BackendStoragePermissions) Source #
The authorization configuration for the storage S3 bucket.
getBackendStorageResourceConfig_serviceName :: Lens' GetBackendStorageResourceConfig ServiceName Source #
The name of the storage service.
getBackendStorageResourceConfig_imported :: Lens' GetBackendStorageResourceConfig Bool Source #
Returns True if the storage resource has been imported.
LoginAuthConfigReqObj
data LoginAuthConfigReqObj Source #
The request object for this operation.
See: newLoginAuthConfigReqObj smart constructor.
Constructors
| LoginAuthConfigReqObj' | |
Fields
| |
Instances
newLoginAuthConfigReqObj :: LoginAuthConfigReqObj Source #
Create a value of LoginAuthConfigReqObj 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:awsCognitoIdentityPoolId:LoginAuthConfigReqObj', loginAuthConfigReqObj_awsCognitoIdentityPoolId - The Amazon Cognito identity pool ID used for the Amplify Admin UI login
authorization.
$sel:awsCognitoRegion:LoginAuthConfigReqObj', loginAuthConfigReqObj_awsCognitoRegion - The AWS Region for the Amplify Admin UI login.
$sel:awsUserPoolsId:LoginAuthConfigReqObj', loginAuthConfigReqObj_awsUserPoolsId - The Amazon Cognito user pool ID used for Amplify Admin UI login
authentication.
$sel:awsUserPoolsWebClientId:LoginAuthConfigReqObj', loginAuthConfigReqObj_awsUserPoolsWebClientId - The web client ID for the Amazon Cognito user pools.
loginAuthConfigReqObj_awsCognitoIdentityPoolId :: Lens' LoginAuthConfigReqObj (Maybe Text) Source #
The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.
loginAuthConfigReqObj_awsCognitoRegion :: Lens' LoginAuthConfigReqObj (Maybe Text) Source #
The AWS Region for the Amplify Admin UI login.
loginAuthConfigReqObj_awsUserPoolsId :: Lens' LoginAuthConfigReqObj (Maybe Text) Source #
The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.
loginAuthConfigReqObj_awsUserPoolsWebClientId :: Lens' LoginAuthConfigReqObj (Maybe Text) Source #
The web client ID for the Amazon Cognito user pools.
ResourceConfig
data ResourceConfig Source #
Defines the resource configuration for the data model in your Amplify project.
See: newResourceConfig smart constructor.
Constructors
| ResourceConfig' | |
Instances
newResourceConfig :: ResourceConfig Source #
Create a value of ResourceConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
S3BucketInfo
data S3BucketInfo Source #
Describes the metadata of the S3 bucket.
See: newS3BucketInfo smart constructor.
Constructors
| S3BucketInfo' | |
Instances
newS3BucketInfo :: S3BucketInfo Source #
Create a value of S3BucketInfo 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:creationDate:S3BucketInfo', s3BucketInfo_creationDate - The creation date of the S3 bucket.
$sel:name:S3BucketInfo', s3BucketInfo_name - The name of the S3 bucket.
s3BucketInfo_creationDate :: Lens' S3BucketInfo (Maybe Text) Source #
The creation date of the S3 bucket.
s3BucketInfo_name :: Lens' S3BucketInfo (Maybe Text) Source #
The name of the S3 bucket.
Settings
The settings of your MFA configuration for the backend of your Amplify project.
See: newSettings smart constructor.
Constructors
| Settings' | |
Fields
| |
Instances
| FromJSON Settings Source # | |
| ToJSON Settings Source # | |
Defined in Amazonka.AmplifyBackend.Types.Settings | |
| Generic Settings Source # | |
| Read Settings Source # | |
| Show Settings Source # | |
| NFData Settings Source # | |
Defined in Amazonka.AmplifyBackend.Types.Settings | |
| Eq Settings Source # | |
| Hashable Settings Source # | |
Defined in Amazonka.AmplifyBackend.Types.Settings | |
| type Rep Settings Source # | |
Defined in Amazonka.AmplifyBackend.Types.Settings type Rep Settings = D1 ('MetaData "Settings" "Amazonka.AmplifyBackend.Types.Settings" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "Settings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "mfaTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MfaTypesElement])) :*: S1 ('MetaSel ('Just "smsMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newSettings :: Settings Source #
Create a value of Settings 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:mfaTypes:Settings', settings_mfaTypes - The supported MFA types.
$sel:smsMessage:Settings', settings_smsMessage - The body of the SMS message.
settings_mfaTypes :: Lens' Settings (Maybe [MfaTypesElement]) Source #
The supported MFA types.
SmsSettings
data SmsSettings Source #
SMS settings for authentication.
See: newSmsSettings smart constructor.
Constructors
| SmsSettings' | |
Fields
| |
Instances
newSmsSettings :: SmsSettings Source #
Create a value of SmsSettings 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:smsMessage:SmsSettings', smsSettings_smsMessage - The contents of the SMS message.
smsSettings_smsMessage :: Lens' SmsSettings (Maybe Text) Source #
The contents of the SMS message.
SocialProviderSettings
data SocialProviderSettings Source #
The settings for using the social identity providers for access to your Amplify app.
See: newSocialProviderSettings smart constructor.
Constructors
| SocialProviderSettings' | |
Instances
newSocialProviderSettings :: SocialProviderSettings Source #
Create a value of SocialProviderSettings 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:facebook:SocialProviderSettings', socialProviderSettings_facebook - Undocumented member.
$sel:google:SocialProviderSettings', socialProviderSettings_google - Undocumented member.
$sel:loginWithAmazon:SocialProviderSettings', socialProviderSettings_loginWithAmazon - Undocumented member.
$sel:signInWithApple:SocialProviderSettings', socialProviderSettings_signInWithApple - Undocumented member.
socialProviderSettings_facebook :: Lens' SocialProviderSettings (Maybe BackendAuthSocialProviderConfig) Source #
Undocumented member.
socialProviderSettings_google :: Lens' SocialProviderSettings (Maybe BackendAuthSocialProviderConfig) Source #
Undocumented member.
socialProviderSettings_loginWithAmazon :: Lens' SocialProviderSettings (Maybe BackendAuthSocialProviderConfig) Source #
Undocumented member.
socialProviderSettings_signInWithApple :: Lens' SocialProviderSettings (Maybe BackendAuthAppleProviderConfig) Source #
Undocumented member.
UpdateBackendAuthForgotPasswordConfig
data UpdateBackendAuthForgotPasswordConfig Source #
(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.
See: newUpdateBackendAuthForgotPasswordConfig smart constructor.
Constructors
| UpdateBackendAuthForgotPasswordConfig' | |
Fields
| |
Instances
newUpdateBackendAuthForgotPasswordConfig :: UpdateBackendAuthForgotPasswordConfig Source #
Create a value of UpdateBackendAuthForgotPasswordConfig 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:deliveryMethod:UpdateBackendAuthForgotPasswordConfig', updateBackendAuthForgotPasswordConfig_deliveryMethod - (DEPRECATED) Describes which mode to use (either SMS or email) to
deliver messages to app users that want to recover their password.
$sel:emailSettings:UpdateBackendAuthForgotPasswordConfig', updateBackendAuthForgotPasswordConfig_emailSettings - (DEPRECATED) The configuration for the email sent when an app user
forgets their password.
$sel:smsSettings:UpdateBackendAuthForgotPasswordConfig', updateBackendAuthForgotPasswordConfig_smsSettings - (DEPRECATED) The configuration for the SMS message sent when an
Amplify app user forgets their password.
updateBackendAuthForgotPasswordConfig_deliveryMethod :: Lens' UpdateBackendAuthForgotPasswordConfig (Maybe DeliveryMethod) Source #
(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.
updateBackendAuthForgotPasswordConfig_emailSettings :: Lens' UpdateBackendAuthForgotPasswordConfig (Maybe EmailSettings) Source #
(DEPRECATED) The configuration for the email sent when an app user forgets their password.
updateBackendAuthForgotPasswordConfig_smsSettings :: Lens' UpdateBackendAuthForgotPasswordConfig (Maybe SmsSettings) Source #
(DEPRECATED) The configuration for the SMS message sent when an Amplify app user forgets their password.
UpdateBackendAuthIdentityPoolConfig
data UpdateBackendAuthIdentityPoolConfig Source #
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
See: newUpdateBackendAuthIdentityPoolConfig smart constructor.
Constructors
| UpdateBackendAuthIdentityPoolConfig' | |
Fields
| |
Instances
newUpdateBackendAuthIdentityPoolConfig :: UpdateBackendAuthIdentityPoolConfig Source #
Create a value of UpdateBackendAuthIdentityPoolConfig 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:unauthenticatedLogin:UpdateBackendAuthIdentityPoolConfig', updateBackendAuthIdentityPoolConfig_unauthenticatedLogin - A boolean value that can be set to allow or disallow guest-level
authorization into your Amplify app.
updateBackendAuthIdentityPoolConfig_unauthenticatedLogin :: Lens' UpdateBackendAuthIdentityPoolConfig (Maybe Bool) Source #
A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.
UpdateBackendAuthMFAConfig
data UpdateBackendAuthMFAConfig Source #
Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.
See: newUpdateBackendAuthMFAConfig smart constructor.
Constructors
| UpdateBackendAuthMFAConfig' | |
Instances
newUpdateBackendAuthMFAConfig :: UpdateBackendAuthMFAConfig Source #
Create a value of UpdateBackendAuthMFAConfig 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:mfaMode:UpdateBackendAuthMFAConfig', updateBackendAuthMFAConfig_mfaMode - The MFA mode for the backend of your Amplify project.
$sel:settings:UpdateBackendAuthMFAConfig', updateBackendAuthMFAConfig_settings - The settings of your MFA configuration for the backend of your Amplify
project.
updateBackendAuthMFAConfig_mfaMode :: Lens' UpdateBackendAuthMFAConfig (Maybe MFAMode) Source #
The MFA mode for the backend of your Amplify project.
updateBackendAuthMFAConfig_settings :: Lens' UpdateBackendAuthMFAConfig (Maybe Settings) Source #
The settings of your MFA configuration for the backend of your Amplify project.
UpdateBackendAuthOAuthConfig
data UpdateBackendAuthOAuthConfig Source #
The OAuth configurations for authenticating users into your Amplify app.
See: newUpdateBackendAuthOAuthConfig smart constructor.
Constructors
| UpdateBackendAuthOAuthConfig' | |
Fields
| |
Instances
newUpdateBackendAuthOAuthConfig :: UpdateBackendAuthOAuthConfig Source #
Create a value of UpdateBackendAuthOAuthConfig 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:domainPrefix:UpdateBackendAuthOAuthConfig', updateBackendAuthOAuthConfig_domainPrefix - The Amazon Cognito domain prefix used to create a hosted UI for
authentication.
$sel:oAuthGrantType:UpdateBackendAuthOAuthConfig', updateBackendAuthOAuthConfig_oAuthGrantType - The OAuth grant type to allow app users to authenticate from your
Amplify app.
$sel:oAuthScopes:UpdateBackendAuthOAuthConfig', updateBackendAuthOAuthConfig_oAuthScopes - The list of OAuth-related flows that can allow users to authenticate
from your Amplify app.
$sel:redirectSignInURIs:UpdateBackendAuthOAuthConfig', updateBackendAuthOAuthConfig_redirectSignInURIs - Redirect URLs that OAuth uses when a user signs in to an Amplify app.
$sel:redirectSignOutURIs:UpdateBackendAuthOAuthConfig', updateBackendAuthOAuthConfig_redirectSignOutURIs - Redirect URLs that OAuth uses when a user signs out of an Amplify app.
$sel:socialProviderSettings:UpdateBackendAuthOAuthConfig', updateBackendAuthOAuthConfig_socialProviderSettings - Describes third-party social federation configurations for allowing your
users to sign in with OAuth.
updateBackendAuthOAuthConfig_domainPrefix :: Lens' UpdateBackendAuthOAuthConfig (Maybe Text) Source #
The Amazon Cognito domain prefix used to create a hosted UI for authentication.
updateBackendAuthOAuthConfig_oAuthGrantType :: Lens' UpdateBackendAuthOAuthConfig (Maybe OAuthGrantType) Source #
The OAuth grant type to allow app users to authenticate from your Amplify app.
updateBackendAuthOAuthConfig_oAuthScopes :: Lens' UpdateBackendAuthOAuthConfig (Maybe [OAuthScopesElement]) Source #
The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
updateBackendAuthOAuthConfig_redirectSignInURIs :: Lens' UpdateBackendAuthOAuthConfig (Maybe [Text]) Source #
Redirect URLs that OAuth uses when a user signs in to an Amplify app.
updateBackendAuthOAuthConfig_redirectSignOutURIs :: Lens' UpdateBackendAuthOAuthConfig (Maybe [Text]) Source #
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
updateBackendAuthOAuthConfig_socialProviderSettings :: Lens' UpdateBackendAuthOAuthConfig (Maybe SocialProviderSettings) Source #
Describes third-party social federation configurations for allowing your users to sign in with OAuth.
UpdateBackendAuthPasswordPolicyConfig
data UpdateBackendAuthPasswordPolicyConfig Source #
Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.
See: newUpdateBackendAuthPasswordPolicyConfig smart constructor.
Constructors
| UpdateBackendAuthPasswordPolicyConfig' | |
Fields
| |
Instances
newUpdateBackendAuthPasswordPolicyConfig :: UpdateBackendAuthPasswordPolicyConfig Source #
Create a value of UpdateBackendAuthPasswordPolicyConfig 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:additionalConstraints:UpdateBackendAuthPasswordPolicyConfig', updateBackendAuthPasswordPolicyConfig_additionalConstraints - Describes additional constraints on password requirements to sign in to
the auth resource, configured as a part of your Amplify project.
$sel:minimumLength:UpdateBackendAuthPasswordPolicyConfig', updateBackendAuthPasswordPolicyConfig_minimumLength - Describes the minimum length of the password required to sign in to the
auth resource, configured as a part of your Amplify project.
updateBackendAuthPasswordPolicyConfig_additionalConstraints :: Lens' UpdateBackendAuthPasswordPolicyConfig (Maybe [AdditionalConstraintsElement]) Source #
Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.
updateBackendAuthPasswordPolicyConfig_minimumLength :: Lens' UpdateBackendAuthPasswordPolicyConfig (Maybe Double) Source #
Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.
UpdateBackendAuthResourceConfig
data UpdateBackendAuthResourceConfig Source #
Defines the resource configuration when updating an authentication resource in your Amplify project.
See: newUpdateBackendAuthResourceConfig smart constructor.
Constructors
| UpdateBackendAuthResourceConfig' | |
Fields
| |
Instances
newUpdateBackendAuthResourceConfig Source #
Arguments
| :: AuthResources | |
| -> UpdateBackendAuthUserPoolConfig | |
| -> Service | |
| -> UpdateBackendAuthResourceConfig |
Create a value of UpdateBackendAuthResourceConfig 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:identityPoolConfigs:UpdateBackendAuthResourceConfig', updateBackendAuthResourceConfig_identityPoolConfigs - Describes the authorization configuration for the Amazon Cognito
identity pool, provisioned as a part of your auth resource in the
Amplify project.
$sel:authResources:UpdateBackendAuthResourceConfig', updateBackendAuthResourceConfig_authResources - Defines the service name to use when configuring an authentication
resource in your Amplify project.
$sel:userPoolConfigs:UpdateBackendAuthResourceConfig', updateBackendAuthResourceConfig_userPoolConfigs - Describes the authentication configuration for the Amazon Cognito user
pool, provisioned as a part of your auth resource in the Amplify
project.
$sel:service:UpdateBackendAuthResourceConfig', updateBackendAuthResourceConfig_service - Defines the service name to use when configuring an authentication
resource in your Amplify project.
updateBackendAuthResourceConfig_identityPoolConfigs :: Lens' UpdateBackendAuthResourceConfig (Maybe UpdateBackendAuthIdentityPoolConfig) Source #
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
updateBackendAuthResourceConfig_authResources :: Lens' UpdateBackendAuthResourceConfig AuthResources Source #
Defines the service name to use when configuring an authentication resource in your Amplify project.
updateBackendAuthResourceConfig_userPoolConfigs :: Lens' UpdateBackendAuthResourceConfig UpdateBackendAuthUserPoolConfig Source #
Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
updateBackendAuthResourceConfig_service :: Lens' UpdateBackendAuthResourceConfig Service Source #
Defines the service name to use when configuring an authentication resource in your Amplify project.
UpdateBackendAuthUserPoolConfig
data UpdateBackendAuthUserPoolConfig Source #
Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.
See: newUpdateBackendAuthUserPoolConfig smart constructor.
Constructors
| UpdateBackendAuthUserPoolConfig' | |
Fields
| |
Instances
newUpdateBackendAuthUserPoolConfig :: UpdateBackendAuthUserPoolConfig Source #
Create a value of UpdateBackendAuthUserPoolConfig 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:forgotPassword:UpdateBackendAuthUserPoolConfig', updateBackendAuthUserPoolConfig_forgotPassword - (DEPRECATED) Describes the forgot password policy for your Amazon
Cognito user pool, configured as a part of your Amplify project.
$sel:mfa:UpdateBackendAuthUserPoolConfig', updateBackendAuthUserPoolConfig_mfa - Describes whether to apply multi-factor authentication policies for your
Amazon Cognito user pool configured as a part of your Amplify project.
$sel:oAuth:UpdateBackendAuthUserPoolConfig', updateBackendAuthUserPoolConfig_oAuth - Describes the OAuth policy and rules for your Amazon Cognito user pool,
configured as a part of your Amplify project.
$sel:passwordPolicy:UpdateBackendAuthUserPoolConfig', updateBackendAuthUserPoolConfig_passwordPolicy - Describes the password policy for your Amazon Cognito user pool,
configured as a part of your Amplify project.
$sel:verificationMessage:UpdateBackendAuthUserPoolConfig', updateBackendAuthUserPoolConfig_verificationMessage - Describes the email or SMS verification message for your Amazon Cognito
user pool, configured as a part of your Amplify project.
updateBackendAuthUserPoolConfig_forgotPassword :: Lens' UpdateBackendAuthUserPoolConfig (Maybe UpdateBackendAuthForgotPasswordConfig) Source #
(DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
updateBackendAuthUserPoolConfig_mfa :: Lens' UpdateBackendAuthUserPoolConfig (Maybe UpdateBackendAuthMFAConfig) Source #
Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
updateBackendAuthUserPoolConfig_oAuth :: Lens' UpdateBackendAuthUserPoolConfig (Maybe UpdateBackendAuthOAuthConfig) Source #
Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
updateBackendAuthUserPoolConfig_passwordPolicy :: Lens' UpdateBackendAuthUserPoolConfig (Maybe UpdateBackendAuthPasswordPolicyConfig) Source #
Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
updateBackendAuthUserPoolConfig_verificationMessage :: Lens' UpdateBackendAuthUserPoolConfig (Maybe UpdateBackendAuthVerificationMessageConfig) Source #
Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
UpdateBackendAuthVerificationMessageConfig
data UpdateBackendAuthVerificationMessageConfig Source #
Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.
See: newUpdateBackendAuthVerificationMessageConfig smart constructor.
Constructors
| UpdateBackendAuthVerificationMessageConfig' | |
Fields
| |
Instances
newUpdateBackendAuthVerificationMessageConfig Source #
Arguments
| :: DeliveryMethod |
|
| -> UpdateBackendAuthVerificationMessageConfig |
Create a value of UpdateBackendAuthVerificationMessageConfig 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:emailSettings:UpdateBackendAuthVerificationMessageConfig', updateBackendAuthVerificationMessageConfig_emailSettings - The settings for the email message.
$sel:smsSettings:UpdateBackendAuthVerificationMessageConfig', updateBackendAuthVerificationMessageConfig_smsSettings - The settings for the SMS message.
$sel:deliveryMethod:UpdateBackendAuthVerificationMessageConfig', updateBackendAuthVerificationMessageConfig_deliveryMethod - The type of verification message to send.
updateBackendAuthVerificationMessageConfig_emailSettings :: Lens' UpdateBackendAuthVerificationMessageConfig (Maybe EmailSettings) Source #
The settings for the email message.
updateBackendAuthVerificationMessageConfig_smsSettings :: Lens' UpdateBackendAuthVerificationMessageConfig (Maybe SmsSettings) Source #
The settings for the SMS message.
updateBackendAuthVerificationMessageConfig_deliveryMethod :: Lens' UpdateBackendAuthVerificationMessageConfig DeliveryMethod Source #
The type of verification message to send.
UpdateBackendStorageResourceConfig
data UpdateBackendStorageResourceConfig Source #
The resource configuration for updating backend storage.
See: newUpdateBackendStorageResourceConfig smart constructor.
Constructors
| UpdateBackendStorageResourceConfig' | |
Fields
| |
Instances
newUpdateBackendStorageResourceConfig Source #
Arguments
| :: ServiceName | |
| -> BackendStoragePermissions | |
| -> UpdateBackendStorageResourceConfig |
Create a value of UpdateBackendStorageResourceConfig 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:serviceName:UpdateBackendStorageResourceConfig', updateBackendStorageResourceConfig_serviceName - The name of the storage service.
$sel:permissions:UpdateBackendStorageResourceConfig', updateBackendStorageResourceConfig_permissions - The authorization configuration for the storage S3 bucket.
updateBackendStorageResourceConfig_serviceName :: Lens' UpdateBackendStorageResourceConfig ServiceName Source #
The name of the storage service.
updateBackendStorageResourceConfig_permissions :: Lens' UpdateBackendStorageResourceConfig BackendStoragePermissions Source #
The authorization configuration for the storage S3 bucket.