Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- Waiters
- Operations
- CloneBackend
- DeleteToken
- CreateBackendConfig
- ListBackendJobs (Paginated)
- GetBackend
- GetBackendAuth
- CreateBackendAuth
- RemoveBackendConfig
- CreateBackend
- GenerateBackendAPIModels
- UpdateBackendConfig
- CreateToken
- GetBackendAPI
- UpdateBackendJob
- UpdateBackendAPI
- DeleteBackendAPI
- GetBackendJob
- DeleteBackend
- DeleteBackendAuth
- UpdateBackendAuth
- GetToken
- RemoveAllBackends
- CreateBackendAPI
- GetBackendAPIModels
- ImportBackendAuth
- Types
- AdditionalConstraintsElement
- AuthResources
- DeliveryMethod
- MFAMode
- MfaTypesElement
- Mode
- OAuthGrantType
- OAuthScopesElement
- RequiredSignUpAttributesElement
- ResolutionStrategy
- Service
- SignInMethod
- Status
- BackendAPIAppSyncAuthSettings
- BackendAPIAuthType
- BackendAPIConflictResolution
- BackendAPIResourceConfig
- BackendAuthAppleProviderConfig
- BackendAuthSocialProviderConfig
- BackendJobRespObj
- CreateBackendAuthForgotPasswordConfig
- CreateBackendAuthIdentityPoolConfig
- CreateBackendAuthMFAConfig
- CreateBackendAuthOAuthConfig
- CreateBackendAuthPasswordPolicyConfig
- CreateBackendAuthResourceConfig
- CreateBackendAuthUserPoolConfig
- EmailSettings
- LoginAuthConfigReqObj
- ResourceConfig
- Settings
- SmsSettings
- SocialProviderSettings
- UpdateBackendAuthForgotPasswordConfig
- UpdateBackendAuthIdentityPoolConfig
- UpdateBackendAuthMFAConfig
- UpdateBackendAuthOAuthConfig
- UpdateBackendAuthPasswordPolicyConfig
- UpdateBackendAuthResourceConfig
- UpdateBackendAuthUserPoolConfig
Derived from API version 2020-08-11
of the AWS service descriptions, licensed under Apache 2.0.
AWS Amplify Admin API
Synopsis
- defaultService :: Service
- _GatewayTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- data CloneBackend = CloneBackend' Text Text Text
- newCloneBackend :: Text -> Text -> Text -> CloneBackend
- data CloneBackendResponse = CloneBackendResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCloneBackendResponse :: Int -> CloneBackendResponse
- data DeleteToken = DeleteToken' Text Text
- newDeleteToken :: Text -> Text -> DeleteToken
- data DeleteTokenResponse = DeleteTokenResponse' (Maybe Bool) Int
- newDeleteTokenResponse :: Int -> DeleteTokenResponse
- data CreateBackendConfig = CreateBackendConfig' (Maybe Text) Text
- newCreateBackendConfig :: Text -> CreateBackendConfig
- data CreateBackendConfigResponse = CreateBackendConfigResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateBackendConfigResponse :: Int -> CreateBackendConfigResponse
- data ListBackendJobs = ListBackendJobs' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) Text Text
- newListBackendJobs :: Text -> Text -> ListBackendJobs
- data ListBackendJobsResponse = ListBackendJobsResponse' (Maybe Text) (Maybe [BackendJobRespObj]) Int
- newListBackendJobsResponse :: Int -> ListBackendJobsResponse
- data GetBackend = GetBackend' (Maybe Text) Text
- newGetBackend :: Text -> GetBackend
- data GetBackendResponse = GetBackendResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) Int
- newGetBackendResponse :: Int -> GetBackendResponse
- data GetBackendAuth = GetBackendAuth' Text Text Text
- newGetBackendAuth :: Text -> Text -> Text -> GetBackendAuth
- data GetBackendAuthResponse = GetBackendAuthResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CreateBackendAuthResourceConfig) (Maybe Text) Int
- newGetBackendAuthResponse :: Int -> GetBackendAuthResponse
- data CreateBackendAuth = CreateBackendAuth' Text Text Text CreateBackendAuthResourceConfig
- newCreateBackendAuth :: Text -> Text -> Text -> CreateBackendAuthResourceConfig -> CreateBackendAuth
- data CreateBackendAuthResponse = CreateBackendAuthResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateBackendAuthResponse :: Int -> CreateBackendAuthResponse
- data RemoveBackendConfig = RemoveBackendConfig' Text
- newRemoveBackendConfig :: Text -> RemoveBackendConfig
- data RemoveBackendConfigResponse = RemoveBackendConfigResponse' (Maybe Text) Int
- newRemoveBackendConfigResponse :: Int -> RemoveBackendConfigResponse
- data CreateBackend = CreateBackend' (Maybe Text) (Maybe ResourceConfig) Text Text Text
- newCreateBackend :: Text -> Text -> Text -> CreateBackend
- data CreateBackendResponse = CreateBackendResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateBackendResponse :: Int -> CreateBackendResponse
- data GenerateBackendAPIModels = GenerateBackendAPIModels' Text Text Text
- newGenerateBackendAPIModels :: Text -> Text -> Text -> GenerateBackendAPIModels
- data GenerateBackendAPIModelsResponse = GenerateBackendAPIModelsResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGenerateBackendAPIModelsResponse :: Int -> GenerateBackendAPIModelsResponse
- data UpdateBackendConfig = UpdateBackendConfig' (Maybe LoginAuthConfigReqObj) Text
- newUpdateBackendConfig :: Text -> UpdateBackendConfig
- data UpdateBackendConfigResponse = UpdateBackendConfigResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LoginAuthConfigReqObj) Int
- newUpdateBackendConfigResponse :: Int -> UpdateBackendConfigResponse
- data CreateToken = CreateToken' Text
- newCreateToken :: Text -> CreateToken
- data CreateTokenResponse = CreateTokenResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateTokenResponse :: Int -> CreateTokenResponse
- data GetBackendAPI = GetBackendAPI' (Maybe BackendAPIResourceConfig) Text Text Text
- newGetBackendAPI :: Text -> Text -> Text -> GetBackendAPI
- data GetBackendAPIResponse = GetBackendAPIResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe BackendAPIResourceConfig) (Maybe Text) Int
- newGetBackendAPIResponse :: Int -> GetBackendAPIResponse
- data UpdateBackendJob = UpdateBackendJob' (Maybe Text) (Maybe Text) Text Text Text
- newUpdateBackendJob :: Text -> Text -> Text -> UpdateBackendJob
- data UpdateBackendJobResponse = UpdateBackendJobResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newUpdateBackendJobResponse :: Int -> UpdateBackendJobResponse
- data UpdateBackendAPI = UpdateBackendAPI' (Maybe BackendAPIResourceConfig) Text Text Text
- newUpdateBackendAPI :: Text -> Text -> Text -> UpdateBackendAPI
- data UpdateBackendAPIResponse = UpdateBackendAPIResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newUpdateBackendAPIResponse :: Int -> UpdateBackendAPIResponse
- data DeleteBackendAPI = DeleteBackendAPI' (Maybe BackendAPIResourceConfig) Text Text Text
- newDeleteBackendAPI :: Text -> Text -> Text -> DeleteBackendAPI
- data DeleteBackendAPIResponse = DeleteBackendAPIResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDeleteBackendAPIResponse :: Int -> DeleteBackendAPIResponse
- data GetBackendJob = GetBackendJob' Text Text Text
- newGetBackendJob :: Text -> Text -> Text -> GetBackendJob
- data GetBackendJobResponse = GetBackendJobResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetBackendJobResponse :: Int -> GetBackendJobResponse
- data DeleteBackend = DeleteBackend' Text Text
- newDeleteBackend :: Text -> Text -> DeleteBackend
- data DeleteBackendResponse = DeleteBackendResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDeleteBackendResponse :: Int -> DeleteBackendResponse
- data DeleteBackendAuth = DeleteBackendAuth' Text Text Text
- newDeleteBackendAuth :: Text -> Text -> Text -> DeleteBackendAuth
- data DeleteBackendAuthResponse = DeleteBackendAuthResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDeleteBackendAuthResponse :: Int -> DeleteBackendAuthResponse
- data UpdateBackendAuth = UpdateBackendAuth' Text Text Text UpdateBackendAuthResourceConfig
- newUpdateBackendAuth :: Text -> Text -> Text -> UpdateBackendAuthResourceConfig -> UpdateBackendAuth
- data UpdateBackendAuthResponse = UpdateBackendAuthResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newUpdateBackendAuthResponse :: Int -> UpdateBackendAuthResponse
- data GetToken = GetToken' Text Text
- newGetToken :: Text -> Text -> GetToken
- data GetTokenResponse = GetTokenResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetTokenResponse :: Int -> GetTokenResponse
- data RemoveAllBackends = RemoveAllBackends' (Maybe Bool) Text
- newRemoveAllBackends :: Text -> RemoveAllBackends
- data RemoveAllBackendsResponse = RemoveAllBackendsResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newRemoveAllBackendsResponse :: Int -> RemoveAllBackendsResponse
- data CreateBackendAPI = CreateBackendAPI' Text Text Text BackendAPIResourceConfig
- newCreateBackendAPI :: Text -> Text -> Text -> BackendAPIResourceConfig -> CreateBackendAPI
- data CreateBackendAPIResponse = CreateBackendAPIResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateBackendAPIResponse :: Int -> CreateBackendAPIResponse
- data GetBackendAPIModels = GetBackendAPIModels' Text Text Text
- newGetBackendAPIModels :: Text -> Text -> Text -> GetBackendAPIModels
- data GetBackendAPIModelsResponse = GetBackendAPIModelsResponse' (Maybe Status) (Maybe Text) Int
- newGetBackendAPIModelsResponse :: Int -> GetBackendAPIModelsResponse
- data ImportBackendAuth = ImportBackendAuth' (Maybe Text) Text Text Text Text Text
- newImportBackendAuth :: Text -> Text -> Text -> Text -> Text -> ImportBackendAuth
- data ImportBackendAuthResponse = ImportBackendAuthResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newImportBackendAuthResponse :: Int -> ImportBackendAuthResponse
- 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 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 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' {
- data BackendAPIAppSyncAuthSettings = BackendAPIAppSyncAuthSettings' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Text)
- newBackendAPIAppSyncAuthSettings :: BackendAPIAppSyncAuthSettings
- data BackendAPIAuthType = BackendAPIAuthType' (Maybe BackendAPIAppSyncAuthSettings) (Maybe Mode)
- newBackendAPIAuthType :: BackendAPIAuthType
- data BackendAPIConflictResolution = BackendAPIConflictResolution' (Maybe ResolutionStrategy)
- newBackendAPIConflictResolution :: BackendAPIConflictResolution
- data BackendAPIResourceConfig = BackendAPIResourceConfig' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [BackendAPIAuthType]) (Maybe BackendAPIConflictResolution) (Maybe BackendAPIAuthType)
- newBackendAPIResourceConfig :: BackendAPIResourceConfig
- data BackendAuthAppleProviderConfig = BackendAuthAppleProviderConfig' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newBackendAuthAppleProviderConfig :: BackendAuthAppleProviderConfig
- data BackendAuthSocialProviderConfig = BackendAuthSocialProviderConfig' (Maybe Text) (Maybe Text)
- newBackendAuthSocialProviderConfig :: BackendAuthSocialProviderConfig
- data BackendJobRespObj = BackendJobRespObj' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text
- newBackendJobRespObj :: Text -> Text -> BackendJobRespObj
- data CreateBackendAuthForgotPasswordConfig = CreateBackendAuthForgotPasswordConfig' (Maybe EmailSettings) (Maybe SmsSettings) DeliveryMethod
- newCreateBackendAuthForgotPasswordConfig :: DeliveryMethod -> CreateBackendAuthForgotPasswordConfig
- data CreateBackendAuthIdentityPoolConfig = CreateBackendAuthIdentityPoolConfig' Bool Text
- newCreateBackendAuthIdentityPoolConfig :: Bool -> Text -> CreateBackendAuthIdentityPoolConfig
- data CreateBackendAuthMFAConfig = CreateBackendAuthMFAConfig' (Maybe Settings) MFAMode
- newCreateBackendAuthMFAConfig :: MFAMode -> CreateBackendAuthMFAConfig
- data CreateBackendAuthOAuthConfig = CreateBackendAuthOAuthConfig' (Maybe SocialProviderSettings) (Maybe Text) [Text] [Text] OAuthGrantType [OAuthScopesElement]
- newCreateBackendAuthOAuthConfig :: OAuthGrantType -> CreateBackendAuthOAuthConfig
- data CreateBackendAuthPasswordPolicyConfig = CreateBackendAuthPasswordPolicyConfig' (Maybe [AdditionalConstraintsElement]) Double
- newCreateBackendAuthPasswordPolicyConfig :: Double -> CreateBackendAuthPasswordPolicyConfig
- data CreateBackendAuthResourceConfig = CreateBackendAuthResourceConfig' (Maybe CreateBackendAuthIdentityPoolConfig) AuthResources CreateBackendAuthUserPoolConfig Service
- newCreateBackendAuthResourceConfig :: AuthResources -> CreateBackendAuthUserPoolConfig -> Service -> CreateBackendAuthResourceConfig
- data CreateBackendAuthUserPoolConfig = CreateBackendAuthUserPoolConfig' (Maybe CreateBackendAuthPasswordPolicyConfig) (Maybe CreateBackendAuthMFAConfig) (Maybe CreateBackendAuthForgotPasswordConfig) (Maybe CreateBackendAuthOAuthConfig) [RequiredSignUpAttributesElement] SignInMethod Text
- newCreateBackendAuthUserPoolConfig :: SignInMethod -> Text -> CreateBackendAuthUserPoolConfig
- data EmailSettings = EmailSettings' (Maybe Text) (Maybe Text)
- newEmailSettings :: EmailSettings
- data LoginAuthConfigReqObj = LoginAuthConfigReqObj' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newLoginAuthConfigReqObj :: LoginAuthConfigReqObj
- data ResourceConfig = ResourceConfig' {
- newResourceConfig :: ResourceConfig
- data Settings = Settings' (Maybe Text) (Maybe [MfaTypesElement])
- newSettings :: Settings
- data SmsSettings = SmsSettings' (Maybe Text)
- newSmsSettings :: SmsSettings
- data SocialProviderSettings = SocialProviderSettings' (Maybe BackendAuthSocialProviderConfig) (Maybe BackendAuthAppleProviderConfig) (Maybe BackendAuthSocialProviderConfig) (Maybe BackendAuthSocialProviderConfig)
- newSocialProviderSettings :: SocialProviderSettings
- data UpdateBackendAuthForgotPasswordConfig = UpdateBackendAuthForgotPasswordConfig' (Maybe EmailSettings) (Maybe SmsSettings) (Maybe DeliveryMethod)
- newUpdateBackendAuthForgotPasswordConfig :: UpdateBackendAuthForgotPasswordConfig
- data UpdateBackendAuthIdentityPoolConfig = UpdateBackendAuthIdentityPoolConfig' (Maybe Bool)
- newUpdateBackendAuthIdentityPoolConfig :: UpdateBackendAuthIdentityPoolConfig
- data UpdateBackendAuthMFAConfig = UpdateBackendAuthMFAConfig' (Maybe Settings) (Maybe MFAMode)
- newUpdateBackendAuthMFAConfig :: UpdateBackendAuthMFAConfig
- data UpdateBackendAuthOAuthConfig = UpdateBackendAuthOAuthConfig' (Maybe SocialProviderSettings) (Maybe Text) (Maybe [OAuthScopesElement]) (Maybe OAuthGrantType) (Maybe [Text]) (Maybe [Text])
- newUpdateBackendAuthOAuthConfig :: UpdateBackendAuthOAuthConfig
- data UpdateBackendAuthPasswordPolicyConfig = UpdateBackendAuthPasswordPolicyConfig' (Maybe [AdditionalConstraintsElement]) (Maybe Double)
- newUpdateBackendAuthPasswordPolicyConfig :: UpdateBackendAuthPasswordPolicyConfig
- data UpdateBackendAuthResourceConfig = UpdateBackendAuthResourceConfig' (Maybe UpdateBackendAuthIdentityPoolConfig) AuthResources UpdateBackendAuthUserPoolConfig Service
- newUpdateBackendAuthResourceConfig :: AuthResources -> UpdateBackendAuthUserPoolConfig -> Service -> UpdateBackendAuthResourceConfig
- data UpdateBackendAuthUserPoolConfig = UpdateBackendAuthUserPoolConfig' (Maybe UpdateBackendAuthPasswordPolicyConfig) (Maybe UpdateBackendAuthMFAConfig) (Maybe UpdateBackendAuthForgotPasswordConfig) (Maybe UpdateBackendAuthOAuthConfig)
- newUpdateBackendAuthUserPoolConfig :: UpdateBackendAuthUserPoolConfig
Service Configuration
defaultService :: Service Source #
API version 2020-08-11
of the Amazon AmplifyBackend SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by AmplifyBackend
.
GatewayTimeoutException
_GatewayTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error returned if there's a temporary issue with the service.
NotFoundException
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error returned when a specific resource type is not found.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error that is returned when a limit of a specific type has been exceeded.
BadRequestException
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error returned if a request is not formed properly.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CloneBackend
data CloneBackend Source #
The request body for CloneBackend.
See: newCloneBackend
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> CloneBackend |
Create a value of CloneBackend
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:appId:CloneBackend'
, cloneBackend_appId
- The app ID.
$sel:backendEnvironmentName:CloneBackend'
, cloneBackend_backendEnvironmentName
- The name of the backend environment.
$sel:targetEnvironmentName:CloneBackend'
, cloneBackend_targetEnvironmentName
- The name of the destination backend environment to be created.
data CloneBackendResponse Source #
See: newCloneBackendResponse
smart constructor.
CloneBackendResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newCloneBackendResponse Source #
Create a value of CloneBackendResponse
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:status:CloneBackendResponse'
, cloneBackendResponse_status
- The current status of the request.
$sel:jobId:CloneBackendResponse'
, cloneBackendResponse_jobId
- The ID for the job.
$sel:operation:CloneBackendResponse'
, cloneBackendResponse_operation
- The name of the operation.
$sel:error:CloneBackendResponse'
, cloneBackendResponse_error
- If the request fails, this error is returned.
$sel:appId:CloneBackend'
, cloneBackendResponse_appId
- The app ID.
$sel:backendEnvironmentName:CloneBackend'
, cloneBackendResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:CloneBackendResponse'
, cloneBackendResponse_httpStatus
- The response's http status code.
DeleteToken
data DeleteToken Source #
See: newDeleteToken
smart constructor.
Instances
Create a value of DeleteToken
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:sessionId:DeleteToken'
, deleteToken_sessionId
- The session ID.
$sel:appId:DeleteToken'
, deleteToken_appId
- The app ID.
data DeleteTokenResponse Source #
See: newDeleteTokenResponse
smart constructor.
Instances
newDeleteTokenResponse Source #
Create a value of DeleteTokenResponse
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:isSuccess:DeleteTokenResponse'
, deleteTokenResponse_isSuccess
- Indicates whether the request succeeded or failed.
$sel:httpStatus:DeleteTokenResponse'
, deleteTokenResponse_httpStatus
- The response's http status code.
CreateBackendConfig
data CreateBackendConfig Source #
The request body for CreateBackendConfig.
See: newCreateBackendConfig
smart constructor.
Instances
newCreateBackendConfig Source #
Create a value of CreateBackendConfig
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:backendManagerAppId:CreateBackendConfig'
, createBackendConfig_backendManagerAppId
- The app ID for the backend manager.
$sel:appId:CreateBackendConfig'
, createBackendConfig_appId
- The app ID.
data CreateBackendConfigResponse Source #
See: newCreateBackendConfigResponse
smart constructor.
Instances
newCreateBackendConfigResponse Source #
Create a value of CreateBackendConfigResponse
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:status:CreateBackendConfigResponse'
, createBackendConfigResponse_status
- The current status of the request.
$sel:jobId:CreateBackendConfigResponse'
, createBackendConfigResponse_jobId
- The ID for the job.
$sel:appId:CreateBackendConfig'
, createBackendConfigResponse_appId
- The app ID.
$sel:backendEnvironmentName:CreateBackendConfigResponse'
, createBackendConfigResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:CreateBackendConfigResponse'
, createBackendConfigResponse_httpStatus
- The response's http status code.
ListBackendJobs (Paginated)
data ListBackendJobs Source #
The request body for ListBackendJobs.
See: newListBackendJobs
smart constructor.
Instances
:: Text | |
-> Text | |
-> ListBackendJobs |
Create a value of ListBackendJobs
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:status:ListBackendJobs'
, listBackendJobs_status
- Filters the list of response objects to include only those with the
specified status.
$sel:jobId:ListBackendJobs'
, listBackendJobs_jobId
- The ID for the job.
$sel:operation:ListBackendJobs'
, listBackendJobs_operation
- Filters the list of response objects to include only those with the
specified operation name.
$sel:nextToken:ListBackendJobs'
, listBackendJobs_nextToken
- The token for the next set of results.
$sel:maxResults:ListBackendJobs'
, listBackendJobs_maxResults
- The maximum number of results that you want in the response.
$sel:appId:ListBackendJobs'
, listBackendJobs_appId
- The app ID.
$sel:backendEnvironmentName:ListBackendJobs'
, listBackendJobs_backendEnvironmentName
- The name of the backend environment.
data ListBackendJobsResponse Source #
See: newListBackendJobsResponse
smart constructor.
Instances
newListBackendJobsResponse Source #
Create a value of ListBackendJobsResponse
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:nextToken:ListBackendJobs'
, listBackendJobsResponse_nextToken
- The token for the next set of results.
$sel:jobs:ListBackendJobsResponse'
, listBackendJobsResponse_jobs
- An array of jobs and their properties.
$sel:httpStatus:ListBackendJobsResponse'
, listBackendJobsResponse_httpStatus
- The response's http status code.
GetBackend
data GetBackend Source #
The request body for GetBackend.
See: newGetBackend
smart constructor.
Instances
Create a value of GetBackend
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:backendEnvironmentName:GetBackend'
, getBackend_backendEnvironmentName
- The name of the backend environment.
$sel:appId:GetBackend'
, getBackend_appId
- The app ID.
data GetBackendResponse Source #
See: newGetBackendResponse
smart constructor.
GetBackendResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) Int |
Instances
newGetBackendResponse Source #
Create a value of GetBackendResponse
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:error:GetBackendResponse'
, getBackendResponse_error
- If the request failed, this is the returned error.
$sel:appName:GetBackendResponse'
, getBackendResponse_appName
- The name of the app.
$sel:amplifyMetaConfig:GetBackendResponse'
, getBackendResponse_amplifyMetaConfig
- A stringified version of the current configs for your Amplify project.
$sel:appId:GetBackend'
, getBackendResponse_appId
- The app ID.
$sel:amplifyFeatureFlags:GetBackendResponse'
, getBackendResponse_amplifyFeatureFlags
- A stringified version of the cli.json file for your Amplify project.
$sel:backendEnvironmentList:GetBackendResponse'
, getBackendResponse_backendEnvironmentList
- A list of backend environments in an array.
$sel:backendEnvironmentName:GetBackend'
, getBackendResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:GetBackendResponse'
, getBackendResponse_httpStatus
- The response's http status code.
GetBackendAuth
data GetBackendAuth Source #
The request body for GetBackendAuth.
See: newGetBackendAuth
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> GetBackendAuth |
Create a value of GetBackendAuth
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:appId:GetBackendAuth'
, getBackendAuth_appId
- The app ID.
$sel:backendEnvironmentName:GetBackendAuth'
, getBackendAuth_backendEnvironmentName
- The name of the backend environment.
$sel:resourceName:GetBackendAuth'
, getBackendAuth_resourceName
- The name of this resource.
data GetBackendAuthResponse Source #
See: newGetBackendAuthResponse
smart constructor.
GetBackendAuthResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CreateBackendAuthResourceConfig) (Maybe Text) Int |
Instances
newGetBackendAuthResponse Source #
Create a value of GetBackendAuthResponse
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:resourceName:GetBackendAuth'
, getBackendAuthResponse_resourceName
- The name of this resource.
$sel:error:GetBackendAuthResponse'
, getBackendAuthResponse_error
- If the request fails, this error is returned.
$sel:appId:GetBackendAuth'
, getBackendAuthResponse_appId
- The app ID.
$sel:resourceConfig:GetBackendAuthResponse'
, getBackendAuthResponse_resourceConfig
- The resource configuration for authorization requests to the backend of
your Amplify project.
$sel:backendEnvironmentName:GetBackendAuth'
, getBackendAuthResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:GetBackendAuthResponse'
, getBackendAuthResponse_httpStatus
- The response's http status code.
CreateBackendAuth
data CreateBackendAuth Source #
The request body for CreateBackendAuth.
See: newCreateBackendAuth
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> CreateBackendAuthResourceConfig | |
-> CreateBackendAuth |
Create a value of CreateBackendAuth
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:appId:CreateBackendAuth'
, createBackendAuth_appId
- The app ID.
$sel:resourceName:CreateBackendAuth'
, createBackendAuth_resourceName
- The name of this resource.
$sel:backendEnvironmentName:CreateBackendAuth'
, createBackendAuth_backendEnvironmentName
- The name of the backend environment.
$sel:resourceConfig:CreateBackendAuth'
, createBackendAuth_resourceConfig
- The resource configuration for this request object.
data CreateBackendAuthResponse Source #
See: newCreateBackendAuthResponse
smart constructor.
CreateBackendAuthResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newCreateBackendAuthResponse Source #
Create a value of CreateBackendAuthResponse
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:status:CreateBackendAuthResponse'
, createBackendAuthResponse_status
- The current status of the request.
$sel:jobId:CreateBackendAuthResponse'
, createBackendAuthResponse_jobId
- The ID for the job.
$sel:operation:CreateBackendAuthResponse'
, createBackendAuthResponse_operation
- The name of the operation.
$sel:error:CreateBackendAuthResponse'
, createBackendAuthResponse_error
- If the request fails, this error is returned.
$sel:appId:CreateBackendAuth'
, createBackendAuthResponse_appId
- The app ID.
$sel:backendEnvironmentName:CreateBackendAuth'
, createBackendAuthResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:CreateBackendAuthResponse'
, createBackendAuthResponse_httpStatus
- The response's http status code.
RemoveBackendConfig
data RemoveBackendConfig Source #
See: newRemoveBackendConfig
smart constructor.
Instances
newRemoveBackendConfig Source #
Create a value of RemoveBackendConfig
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:appId:RemoveBackendConfig'
, removeBackendConfig_appId
- The app ID.
data RemoveBackendConfigResponse Source #
See: newRemoveBackendConfigResponse
smart constructor.
Instances
newRemoveBackendConfigResponse Source #
Create a value of RemoveBackendConfigResponse
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:error:RemoveBackendConfigResponse'
, removeBackendConfigResponse_error
- If the request fails, this error is returned.
$sel:httpStatus:RemoveBackendConfigResponse'
, removeBackendConfigResponse_httpStatus
- The response's http status code.
CreateBackend
data CreateBackend Source #
The request body for CreateBackend.
See: newCreateBackend
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> CreateBackend |
Create a value of CreateBackend
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:resourceName:CreateBackend'
, createBackend_resourceName
- The name of the resource.
$sel:resourceConfig:CreateBackend'
, createBackend_resourceConfig
- The resource configuration for the create backend request.
$sel:appId:CreateBackend'
, createBackend_appId
- The app ID.
$sel:backendEnvironmentName:CreateBackend'
, createBackend_backendEnvironmentName
- The name of the backend environment.
$sel:appName:CreateBackend'
, createBackend_appName
- The name of the app.
data CreateBackendResponse Source #
See: newCreateBackendResponse
smart constructor.
CreateBackendResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newCreateBackendResponse Source #
Create a value of CreateBackendResponse
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:status:CreateBackendResponse'
, createBackendResponse_status
- The current status of the request.
$sel:jobId:CreateBackendResponse'
, createBackendResponse_jobId
- The ID for the job.
$sel:operation:CreateBackendResponse'
, createBackendResponse_operation
- The name of the operation.
$sel:error:CreateBackendResponse'
, createBackendResponse_error
- If the request fails, this error is returned.
$sel:appId:CreateBackend'
, createBackendResponse_appId
- The app ID.
$sel:backendEnvironmentName:CreateBackend'
, createBackendResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:CreateBackendResponse'
, createBackendResponse_httpStatus
- The response's http status code.
GenerateBackendAPIModels
data GenerateBackendAPIModels Source #
The request body for GenerateBackendAPIModels.
See: newGenerateBackendAPIModels
smart constructor.
Instances
newGenerateBackendAPIModels Source #
:: Text | |
-> Text | |
-> Text | |
-> GenerateBackendAPIModels |
Create a value of GenerateBackendAPIModels
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:appId:GenerateBackendAPIModels'
, generateBackendAPIModels_appId
- The app ID.
$sel:backendEnvironmentName:GenerateBackendAPIModels'
, generateBackendAPIModels_backendEnvironmentName
- The name of the backend environment.
$sel:resourceName:GenerateBackendAPIModels'
, generateBackendAPIModels_resourceName
- The name of this resource.
data GenerateBackendAPIModelsResponse Source #
See: newGenerateBackendAPIModelsResponse
smart constructor.
GenerateBackendAPIModelsResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newGenerateBackendAPIModelsResponse Source #
Create a value of GenerateBackendAPIModelsResponse
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:status:GenerateBackendAPIModelsResponse'
, generateBackendAPIModelsResponse_status
- The current status of the request.
$sel:jobId:GenerateBackendAPIModelsResponse'
, generateBackendAPIModelsResponse_jobId
- The ID for the job.
$sel:operation:GenerateBackendAPIModelsResponse'
, generateBackendAPIModelsResponse_operation
- The name of the operation.
$sel:error:GenerateBackendAPIModelsResponse'
, generateBackendAPIModelsResponse_error
- If the request fails, this error is returned.
$sel:appId:GenerateBackendAPIModels'
, generateBackendAPIModelsResponse_appId
- The app ID.
$sel:backendEnvironmentName:GenerateBackendAPIModels'
, generateBackendAPIModelsResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:GenerateBackendAPIModelsResponse'
, generateBackendAPIModelsResponse_httpStatus
- The response's http status code.
UpdateBackendConfig
data UpdateBackendConfig Source #
The request body for UpdateBackendConfig.
See: newUpdateBackendConfig
smart constructor.
Instances
newUpdateBackendConfig Source #
Create a value of UpdateBackendConfig
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:loginAuthConfig:UpdateBackendConfig'
, updateBackendConfig_loginAuthConfig
- Describes the Amazon Cognito configuration for Admin UI access.
$sel:appId:UpdateBackendConfig'
, updateBackendConfig_appId
- The app ID.
data UpdateBackendConfigResponse Source #
See: newUpdateBackendConfigResponse
smart constructor.
UpdateBackendConfigResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LoginAuthConfigReqObj) Int |
Instances
newUpdateBackendConfigResponse Source #
Create a value of UpdateBackendConfigResponse
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:error:UpdateBackendConfigResponse'
, updateBackendConfigResponse_error
- If the request fails, this error is returned.
$sel:appId:UpdateBackendConfig'
, updateBackendConfigResponse_appId
- The app ID.
$sel:backendManagerAppId:UpdateBackendConfigResponse'
, updateBackendConfigResponse_backendManagerAppId
- The app ID for the backend manager.
$sel:loginAuthConfig:UpdateBackendConfig'
, updateBackendConfigResponse_loginAuthConfig
- Describes the Amazon Cognito configurations for the Admin UI auth
resource to log in with.
$sel:httpStatus:UpdateBackendConfigResponse'
, updateBackendConfigResponse_httpStatus
- The response's http status code.
CreateToken
data CreateToken Source #
See: newCreateToken
smart constructor.
Instances
Create a value of CreateToken
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:appId:CreateToken'
, createToken_appId
- The app ID.
data CreateTokenResponse Source #
See: newCreateTokenResponse
smart constructor.
Instances
newCreateTokenResponse Source #
Create a value of CreateTokenResponse
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:ttl:CreateTokenResponse'
, createTokenResponse_ttl
- The expiry time for the one-time generated token code.
$sel:appId:CreateToken'
, createTokenResponse_appId
- The app ID.
$sel:sessionId:CreateTokenResponse'
, createTokenResponse_sessionId
- A unique ID provided when creating a new challenge token.
$sel:challengeCode:CreateTokenResponse'
, createTokenResponse_challengeCode
- One-time challenge code for authenticating into the Amplify Admin UI.
$sel:httpStatus:CreateTokenResponse'
, createTokenResponse_httpStatus
- The response's http status code.
GetBackendAPI
data GetBackendAPI Source #
The request body for GetBackendAPI.
See: newGetBackendAPI
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> GetBackendAPI |
Create a value of GetBackendAPI
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:resourceConfig:GetBackendAPI'
, getBackendAPI_resourceConfig
- Defines the resource configuration for the data model in your Amplify
project.
$sel:appId:GetBackendAPI'
, getBackendAPI_appId
- The app ID.
$sel:backendEnvironmentName:GetBackendAPI'
, getBackendAPI_backendEnvironmentName
- The name of the backend environment.
$sel:resourceName:GetBackendAPI'
, getBackendAPI_resourceName
- The name of this resource.
data GetBackendAPIResponse Source #
See: newGetBackendAPIResponse
smart constructor.
GetBackendAPIResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe BackendAPIResourceConfig) (Maybe Text) Int |
Instances
newGetBackendAPIResponse Source #
Create a value of GetBackendAPIResponse
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:resourceName:GetBackendAPI'
, getBackendAPIResponse_resourceName
- The name of this resource.
$sel:error:GetBackendAPIResponse'
, getBackendAPIResponse_error
- If the request fails, this error is returned.
$sel:appId:GetBackendAPI'
, getBackendAPIResponse_appId
- The app ID.
$sel:resourceConfig:GetBackendAPI'
, getBackendAPIResponse_resourceConfig
- The resource configuration for this response object.
$sel:backendEnvironmentName:GetBackendAPI'
, getBackendAPIResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:GetBackendAPIResponse'
, getBackendAPIResponse_httpStatus
- The response's http status code.
UpdateBackendJob
data UpdateBackendJob Source #
The request body for GetBackendJob.
See: newUpdateBackendJob
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> UpdateBackendJob |
Create a value of UpdateBackendJob
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:status:UpdateBackendJob'
, updateBackendJob_status
- Filters the list of response objects to include only those with the
specified status.
$sel:operation:UpdateBackendJob'
, updateBackendJob_operation
- Filters the list of response objects to include only those with the
specified operation name.
$sel:appId:UpdateBackendJob'
, updateBackendJob_appId
- The app ID.
$sel:backendEnvironmentName:UpdateBackendJob'
, updateBackendJob_backendEnvironmentName
- The name of the backend environment.
$sel:jobId:UpdateBackendJob'
, updateBackendJob_jobId
- The ID for the job.
data UpdateBackendJobResponse Source #
See: newUpdateBackendJobResponse
smart constructor.
UpdateBackendJobResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newUpdateBackendJobResponse Source #
Create a value of UpdateBackendJobResponse
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:status:UpdateBackendJob'
, updateBackendJobResponse_status
- The current status of the request.
$sel:jobId:UpdateBackendJob'
, updateBackendJobResponse_jobId
- The ID for the job.
$sel:operation:UpdateBackendJob'
, updateBackendJobResponse_operation
- The name of the operation.
$sel:error:UpdateBackendJobResponse'
, updateBackendJobResponse_error
- If the request fails, this error is returned.
$sel:updateTime:UpdateBackendJobResponse'
, updateBackendJobResponse_updateTime
- The time when the job was last updated.
$sel:appId:UpdateBackendJob'
, updateBackendJobResponse_appId
- The app ID.
$sel:backendEnvironmentName:UpdateBackendJob'
, updateBackendJobResponse_backendEnvironmentName
- The name of the backend environment.
$sel:createTime:UpdateBackendJobResponse'
, updateBackendJobResponse_createTime
- The time when the job was created.
$sel:httpStatus:UpdateBackendJobResponse'
, updateBackendJobResponse_httpStatus
- The response's http status code.
UpdateBackendAPI
data UpdateBackendAPI Source #
The request body for UpdateBackendAPI.
See: newUpdateBackendAPI
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> UpdateBackendAPI |
Create a value of UpdateBackendAPI
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:resourceConfig:UpdateBackendAPI'
, updateBackendAPI_resourceConfig
- Defines the resource configuration for the data model in your Amplify
project.
$sel:appId:UpdateBackendAPI'
, updateBackendAPI_appId
- The app ID.
$sel:backendEnvironmentName:UpdateBackendAPI'
, updateBackendAPI_backendEnvironmentName
- The name of the backend environment.
$sel:resourceName:UpdateBackendAPI'
, updateBackendAPI_resourceName
- The name of this resource.
data UpdateBackendAPIResponse Source #
See: newUpdateBackendAPIResponse
smart constructor.
UpdateBackendAPIResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newUpdateBackendAPIResponse Source #
Create a value of UpdateBackendAPIResponse
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:status:UpdateBackendAPIResponse'
, updateBackendAPIResponse_status
- The current status of the request.
$sel:jobId:UpdateBackendAPIResponse'
, updateBackendAPIResponse_jobId
- The ID for the job.
$sel:operation:UpdateBackendAPIResponse'
, updateBackendAPIResponse_operation
- The name of the operation.
$sel:error:UpdateBackendAPIResponse'
, updateBackendAPIResponse_error
- If the request fails, this error is returned.
$sel:appId:UpdateBackendAPI'
, updateBackendAPIResponse_appId
- The app ID.
$sel:backendEnvironmentName:UpdateBackendAPI'
, updateBackendAPIResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:UpdateBackendAPIResponse'
, updateBackendAPIResponse_httpStatus
- The response's http status code.
DeleteBackendAPI
data DeleteBackendAPI Source #
The request body for DeleteBackendAPI.
See: newDeleteBackendAPI
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> DeleteBackendAPI |
Create a value of DeleteBackendAPI
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:resourceConfig:DeleteBackendAPI'
, deleteBackendAPI_resourceConfig
- Defines the resource configuration for the data model in your Amplify
project.
$sel:appId:DeleteBackendAPI'
, deleteBackendAPI_appId
- The app ID.
$sel:backendEnvironmentName:DeleteBackendAPI'
, deleteBackendAPI_backendEnvironmentName
- The name of the backend environment.
$sel:resourceName:DeleteBackendAPI'
, deleteBackendAPI_resourceName
- The name of this resource.
data DeleteBackendAPIResponse Source #
See: newDeleteBackendAPIResponse
smart constructor.
DeleteBackendAPIResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newDeleteBackendAPIResponse Source #
Create a value of DeleteBackendAPIResponse
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:status:DeleteBackendAPIResponse'
, deleteBackendAPIResponse_status
- The current status of the request.
$sel:jobId:DeleteBackendAPIResponse'
, deleteBackendAPIResponse_jobId
- The ID for the job.
$sel:operation:DeleteBackendAPIResponse'
, deleteBackendAPIResponse_operation
- The name of the operation.
$sel:error:DeleteBackendAPIResponse'
, deleteBackendAPIResponse_error
- If the request fails, this error is returned.
$sel:appId:DeleteBackendAPI'
, deleteBackendAPIResponse_appId
- The app ID.
$sel:backendEnvironmentName:DeleteBackendAPI'
, deleteBackendAPIResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:DeleteBackendAPIResponse'
, deleteBackendAPIResponse_httpStatus
- The response's http status code.
GetBackendJob
data GetBackendJob Source #
See: newGetBackendJob
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> GetBackendJob |
Create a value of GetBackendJob
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:appId:GetBackendJob'
, getBackendJob_appId
- The app ID.
$sel:backendEnvironmentName:GetBackendJob'
, getBackendJob_backendEnvironmentName
- The name of the backend environment.
$sel:jobId:GetBackendJob'
, getBackendJob_jobId
- The ID for the job.
data GetBackendJobResponse Source #
See: newGetBackendJobResponse
smart constructor.
GetBackendJobResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newGetBackendJobResponse Source #
Create a value of GetBackendJobResponse
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:status:GetBackendJobResponse'
, getBackendJobResponse_status
- The current status of the request.
$sel:jobId:GetBackendJob'
, getBackendJobResponse_jobId
- The ID for the job.
$sel:operation:GetBackendJobResponse'
, getBackendJobResponse_operation
- The name of the operation.
$sel:error:GetBackendJobResponse'
, getBackendJobResponse_error
- If the request fails, this error is returned.
$sel:updateTime:GetBackendJobResponse'
, getBackendJobResponse_updateTime
- The time when the job was last updated.
$sel:appId:GetBackendJob'
, getBackendJobResponse_appId
- The app ID.
$sel:backendEnvironmentName:GetBackendJob'
, getBackendJobResponse_backendEnvironmentName
- The name of the backend environment.
$sel:createTime:GetBackendJobResponse'
, getBackendJobResponse_createTime
- The time when the job was created.
$sel:httpStatus:GetBackendJobResponse'
, getBackendJobResponse_httpStatus
- The response's http status code.
DeleteBackend
data DeleteBackend Source #
See: newDeleteBackend
smart constructor.
Instances
Create a value of DeleteBackend
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:appId:DeleteBackend'
, deleteBackend_appId
- The app ID.
$sel:backendEnvironmentName:DeleteBackend'
, deleteBackend_backendEnvironmentName
- The name of the backend environment.
data DeleteBackendResponse Source #
See: newDeleteBackendResponse
smart constructor.
DeleteBackendResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newDeleteBackendResponse Source #
Create a value of DeleteBackendResponse
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:status:DeleteBackendResponse'
, deleteBackendResponse_status
- The current status of the request.
$sel:jobId:DeleteBackendResponse'
, deleteBackendResponse_jobId
- The ID for the job.
$sel:operation:DeleteBackendResponse'
, deleteBackendResponse_operation
- The name of the operation.
$sel:error:DeleteBackendResponse'
, deleteBackendResponse_error
- If the request fails, this error is returned.
$sel:appId:DeleteBackend'
, deleteBackendResponse_appId
- The app ID.
$sel:backendEnvironmentName:DeleteBackend'
, deleteBackendResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:DeleteBackendResponse'
, deleteBackendResponse_httpStatus
- The response's http status code.
DeleteBackendAuth
data DeleteBackendAuth Source #
The request body for DeleteBackendAuth.
See: newDeleteBackendAuth
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> DeleteBackendAuth |
Create a value of DeleteBackendAuth
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:appId:DeleteBackendAuth'
, deleteBackendAuth_appId
- The app ID.
$sel:backendEnvironmentName:DeleteBackendAuth'
, deleteBackendAuth_backendEnvironmentName
- The name of the backend environment.
$sel:resourceName:DeleteBackendAuth'
, deleteBackendAuth_resourceName
- The name of this resource.
data DeleteBackendAuthResponse Source #
See: newDeleteBackendAuthResponse
smart constructor.
DeleteBackendAuthResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newDeleteBackendAuthResponse Source #
Create a value of DeleteBackendAuthResponse
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:status:DeleteBackendAuthResponse'
, deleteBackendAuthResponse_status
- The current status of the request.
$sel:jobId:DeleteBackendAuthResponse'
, deleteBackendAuthResponse_jobId
- The ID for the job.
$sel:operation:DeleteBackendAuthResponse'
, deleteBackendAuthResponse_operation
- The name of the operation.
$sel:error:DeleteBackendAuthResponse'
, deleteBackendAuthResponse_error
- If the request fails, this error is returned.
$sel:appId:DeleteBackendAuth'
, deleteBackendAuthResponse_appId
- The app ID.
$sel:backendEnvironmentName:DeleteBackendAuth'
, deleteBackendAuthResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:DeleteBackendAuthResponse'
, deleteBackendAuthResponse_httpStatus
- The response's http status code.
UpdateBackendAuth
data UpdateBackendAuth Source #
The request body for UpdateBackendAuth.
See: newUpdateBackendAuth
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> UpdateBackendAuthResourceConfig | |
-> UpdateBackendAuth |
Create a value of UpdateBackendAuth
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:appId:UpdateBackendAuth'
, updateBackendAuth_appId
- The app ID.
$sel:backendEnvironmentName:UpdateBackendAuth'
, updateBackendAuth_backendEnvironmentName
- The name of the backend environment.
$sel:resourceName:UpdateBackendAuth'
, updateBackendAuth_resourceName
- The name of this resource.
$sel:resourceConfig:UpdateBackendAuth'
, updateBackendAuth_resourceConfig
- The resource configuration for this request object.
data UpdateBackendAuthResponse Source #
See: newUpdateBackendAuthResponse
smart constructor.
UpdateBackendAuthResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newUpdateBackendAuthResponse Source #
Create a value of UpdateBackendAuthResponse
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:status:UpdateBackendAuthResponse'
, updateBackendAuthResponse_status
- The current status of the request.
$sel:jobId:UpdateBackendAuthResponse'
, updateBackendAuthResponse_jobId
- The ID for the job.
$sel:operation:UpdateBackendAuthResponse'
, updateBackendAuthResponse_operation
- The name of the operation.
$sel:error:UpdateBackendAuthResponse'
, updateBackendAuthResponse_error
- If the request fails, this error is returned.
$sel:appId:UpdateBackendAuth'
, updateBackendAuthResponse_appId
- The app ID.
$sel:backendEnvironmentName:UpdateBackendAuth'
, updateBackendAuthResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:UpdateBackendAuthResponse'
, updateBackendAuthResponse_httpStatus
- The response's http status code.
GetToken
See: newGetToken
smart constructor.
Instances
Create a value of GetToken
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:sessionId:GetToken'
, getToken_sessionId
- The session ID.
$sel:appId:GetToken'
, getToken_appId
- The app ID.
data GetTokenResponse Source #
See: newGetTokenResponse
smart constructor.
Instances
Create a value of GetTokenResponse
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:ttl:GetTokenResponse'
, getTokenResponse_ttl
- The expiry time for the one-time generated token code.
$sel:appId:GetToken'
, getTokenResponse_appId
- The app ID.
$sel:sessionId:GetToken'
, getTokenResponse_sessionId
- A unique ID provided when creating a new challenge token.
$sel:challengeCode:GetTokenResponse'
, getTokenResponse_challengeCode
- The one-time challenge code for authenticating into the Amplify Admin
UI.
$sel:httpStatus:GetTokenResponse'
, getTokenResponse_httpStatus
- The response's http status code.
RemoveAllBackends
data RemoveAllBackends Source #
The request body for RemoveAllBackends.
See: newRemoveAllBackends
smart constructor.
Instances
Create a value of RemoveAllBackends
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:cleanAmplifyApp:RemoveAllBackends'
, removeAllBackends_cleanAmplifyApp
- Cleans up the Amplify Console app if this value is set to true.
$sel:appId:RemoveAllBackends'
, removeAllBackends_appId
- The app ID.
data RemoveAllBackendsResponse Source #
See: newRemoveAllBackendsResponse
smart constructor.
Instances
newRemoveAllBackendsResponse Source #
Create a value of RemoveAllBackendsResponse
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:status:RemoveAllBackendsResponse'
, removeAllBackendsResponse_status
- The current status of the request.
$sel:jobId:RemoveAllBackendsResponse'
, removeAllBackendsResponse_jobId
- The ID for the job.
$sel:operation:RemoveAllBackendsResponse'
, removeAllBackendsResponse_operation
- The name of the operation.
$sel:error:RemoveAllBackendsResponse'
, removeAllBackendsResponse_error
- If the request fails, this error is returned.
$sel:appId:RemoveAllBackends'
, removeAllBackendsResponse_appId
- The app ID.
$sel:httpStatus:RemoveAllBackendsResponse'
, removeAllBackendsResponse_httpStatus
- The response's http status code.
CreateBackendAPI
data CreateBackendAPI Source #
The request body for CreateBackendAPI.
See: newCreateBackendAPI
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> BackendAPIResourceConfig | |
-> CreateBackendAPI |
Create a value of CreateBackendAPI
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:appId:CreateBackendAPI'
, createBackendAPI_appId
- The app ID.
$sel:resourceName:CreateBackendAPI'
, createBackendAPI_resourceName
- The name of this resource.
$sel:backendEnvironmentName:CreateBackendAPI'
, createBackendAPI_backendEnvironmentName
- The name of the backend environment.
$sel:resourceConfig:CreateBackendAPI'
, createBackendAPI_resourceConfig
- The resource configuration for this request.
data CreateBackendAPIResponse Source #
See: newCreateBackendAPIResponse
smart constructor.
CreateBackendAPIResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newCreateBackendAPIResponse Source #
Create a value of CreateBackendAPIResponse
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:status:CreateBackendAPIResponse'
, createBackendAPIResponse_status
- The current status of the request.
$sel:jobId:CreateBackendAPIResponse'
, createBackendAPIResponse_jobId
- The ID for the job.
$sel:operation:CreateBackendAPIResponse'
, createBackendAPIResponse_operation
- The name of the operation.
$sel:error:CreateBackendAPIResponse'
, createBackendAPIResponse_error
- If the request fails, this error is returned.
$sel:appId:CreateBackendAPI'
, createBackendAPIResponse_appId
- The app ID.
$sel:backendEnvironmentName:CreateBackendAPI'
, createBackendAPIResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:CreateBackendAPIResponse'
, createBackendAPIResponse_httpStatus
- The response's http status code.
GetBackendAPIModels
data GetBackendAPIModels Source #
The request body for GetBackendAPIModels.
See: newGetBackendAPIModels
smart constructor.
Instances
newGetBackendAPIModels Source #
:: Text | |
-> Text | |
-> Text | |
-> GetBackendAPIModels |
Create a value of GetBackendAPIModels
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:appId:GetBackendAPIModels'
, getBackendAPIModels_appId
- The app ID.
$sel:backendEnvironmentName:GetBackendAPIModels'
, getBackendAPIModels_backendEnvironmentName
- The name of the backend environment.
$sel:resourceName:GetBackendAPIModels'
, getBackendAPIModels_resourceName
- The name of this resource.
data GetBackendAPIModelsResponse Source #
See: newGetBackendAPIModelsResponse
smart constructor.
Instances
newGetBackendAPIModelsResponse Source #
Create a value of GetBackendAPIModelsResponse
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:status:GetBackendAPIModelsResponse'
, getBackendAPIModelsResponse_status
- The current status of the request.
$sel:models:GetBackendAPIModelsResponse'
, getBackendAPIModelsResponse_models
- Stringified JSON of the datastore model.
$sel:httpStatus:GetBackendAPIModelsResponse'
, getBackendAPIModelsResponse_httpStatus
- The response's http status code.
ImportBackendAuth
data ImportBackendAuth Source #
The request body for ImportBackendAuth.
See: newImportBackendAuth
smart constructor.
Instances
Create a value of ImportBackendAuth
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:identityPoolId:ImportBackendAuth'
, importBackendAuth_identityPoolId
- The ID of the Amazon Cognito identity pool.
$sel:appId:ImportBackendAuth'
, importBackendAuth_appId
- The app ID.
$sel:backendEnvironmentName:ImportBackendAuth'
, importBackendAuth_backendEnvironmentName
- The name of the backend environment.
$sel:userPoolId:ImportBackendAuth'
, importBackendAuth_userPoolId
- The ID of the Amazon Cognito user pool.
$sel:nativeClientId:ImportBackendAuth'
, importBackendAuth_nativeClientId
- The ID of the Amazon Cognito native client.
$sel:webClientId:ImportBackendAuth'
, importBackendAuth_webClientId
- The ID of the Amazon Cognito web client.
data ImportBackendAuthResponse Source #
See: newImportBackendAuthResponse
smart constructor.
ImportBackendAuthResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newImportBackendAuthResponse Source #
Create a value of ImportBackendAuthResponse
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:status:ImportBackendAuthResponse'
, importBackendAuthResponse_status
- The current status of the request.
$sel:jobId:ImportBackendAuthResponse'
, importBackendAuthResponse_jobId
- The ID for the job.
$sel:operation:ImportBackendAuthResponse'
, importBackendAuthResponse_operation
- The name of the operation.
$sel:error:ImportBackendAuthResponse'
, importBackendAuthResponse_error
- If the request fails, this error is returned.
$sel:appId:ImportBackendAuth'
, importBackendAuthResponse_appId
- The app ID.
$sel:backendEnvironmentName:ImportBackendAuth'
, importBackendAuthResponse_backendEnvironmentName
- The name of the backend environment.
$sel:httpStatus:ImportBackendAuthResponse'
, importBackendAuthResponse_httpStatus
- The response's http status code.
Types
AdditionalConstraintsElement
newtype AdditionalConstraintsElement Source #
Instances
AuthResources
newtype AuthResources Source #
pattern AuthResources_IDENTITY_POOL_AND_USER_POOL :: AuthResources | |
pattern AuthResources_USER_POOL_ONLY :: AuthResources |
Instances
DeliveryMethod
newtype DeliveryMethod Source #
pattern DeliveryMethod_EMAIL :: DeliveryMethod | |
pattern DeliveryMethod_SMS :: DeliveryMethod |
Instances
MFAMode
pattern MFAMode_OFF :: MFAMode | |
pattern MFAMode_ON :: MFAMode | |
pattern MFAMode_OPTIONAL :: MFAMode |
Instances
MfaTypesElement
newtype MfaTypesElement Source #
pattern MfaTypesElement_SMS :: MfaTypesElement | |
pattern MfaTypesElement_TOTP :: MfaTypesElement |
Instances
Mode
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 #
pattern OAuthGrantType_CODE :: OAuthGrantType | |
pattern OAuthGrantType_IMPLICIT :: OAuthGrantType |
Instances
OAuthScopesElement
newtype OAuthScopesElement Source #
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 #
Instances
ResolutionStrategy
newtype ResolutionStrategy Source #
pattern ResolutionStrategy_AUTOMERGE :: ResolutionStrategy | |
pattern ResolutionStrategy_LAMBDA :: ResolutionStrategy | |
pattern ResolutionStrategy_NONE :: ResolutionStrategy | |
pattern ResolutionStrategy_OPTIMISTIC_CONCURRENCY :: ResolutionStrategy |
Instances
Service
pattern Service_COGNITO :: Service |
Instances
SignInMethod
newtype SignInMethod Source #
pattern SignInMethod_EMAIL :: SignInMethod | |
pattern SignInMethod_EMAIL_AND_PHONE_NUMBER :: SignInMethod | |
pattern SignInMethod_PHONE_NUMBER :: SignInMethod | |
pattern SignInMethod_USERNAME :: SignInMethod |
Instances
Status
pattern Status_LATEST :: Status | |
pattern Status_STALE :: Status |
Instances
BackendAPIAppSyncAuthSettings
data BackendAPIAppSyncAuthSettings Source #
The authentication settings for accessing provisioned data models in your Amplify project.
See: newBackendAPIAppSyncAuthSettings
smart constructor.
BackendAPIAppSyncAuthSettings' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Text) |
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:openIDProviderName:BackendAPIAppSyncAuthSettings'
, backendAPIAppSyncAuthSettings_openIDProviderName
- The OpenID provider name, if OpenID was used as an authentication
mechanism to access your data models.
$sel:openIDClientId:BackendAPIAppSyncAuthSettings'
, backendAPIAppSyncAuthSettings_openIDClientId
- The clientID for openID, if openID was used as an authentication setting
to access your data models.
$sel:openIDIssueURL:BackendAPIAppSyncAuthSettings'
, backendAPIAppSyncAuthSettings_openIDIssueURL
- The openID issuer URL, if openID was used as an authentication setting
to access your data models.
$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:openIDAuthTTL:BackendAPIAppSyncAuthSettings'
, backendAPIAppSyncAuthSettings_openIDAuthTTL
- The expiry time for the OpenID authentication mechanism.
$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:openIDIatTTL:BackendAPIAppSyncAuthSettings'
, backendAPIAppSyncAuthSettings_openIDIatTTL
- The expiry time for the OpenID authentication mechanism.
BackendAPIAuthType
data BackendAPIAuthType Source #
Describes the auth types for your configured data models.
See: newBackendAPIAuthType
smart constructor.
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:settings:BackendAPIAuthType'
, backendAPIAuthType_settings
- Describes settings for the authentication mode.
$sel:mode:BackendAPIAuthType'
, backendAPIAuthType_mode
- Describes 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.
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.
BackendAPIResourceConfig
data BackendAPIResourceConfig Source #
The resource config for the data model, configured as a part of the Amplify project.
See: newBackendAPIResourceConfig
smart constructor.
BackendAPIResourceConfig' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [BackendAPIAuthType]) (Maybe BackendAPIConflictResolution) (Maybe BackendAPIAuthType) |
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:apiName:BackendAPIResourceConfig'
, backendAPIResourceConfig_apiName
- The API name used to interact with the data model, configured as a part
of 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.
$sel:additionalAuthTypes:BackendAPIResourceConfig'
, backendAPIResourceConfig_additionalAuthTypes
- Additional authentication methods used to interact with your data
models.
$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.
BackendAuthAppleProviderConfig
data BackendAuthAppleProviderConfig Source #
Describes Apple social federation configurations for allowing your app users to sign in using OAuth.
See: newBackendAuthAppleProviderConfig
smart constructor.
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:privateKey:BackendAuthAppleProviderConfig'
, backendAuthAppleProviderConfig_privateKey
- Describes the private_key that comes from Apple.
$sel:keyId:BackendAuthAppleProviderConfig'
, backendAuthAppleProviderConfig_keyId
- Describes the key_id that comes from Apple.
$sel:teamId:BackendAuthAppleProviderConfig'
, backendAuthAppleProviderConfig_teamId
- 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.
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.
BackendJobRespObj
data BackendJobRespObj Source #
The response object for this operation.
See: newBackendJobRespObj
smart constructor.
BackendJobRespObj' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text |
Instances
:: 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:status:BackendJobRespObj'
, backendJobRespObj_status
- The current status of the request.
$sel:jobId:BackendJobRespObj'
, backendJobRespObj_jobId
- The ID for the job.
$sel:operation:BackendJobRespObj'
, backendJobRespObj_operation
- The name of the operation.
$sel:error:BackendJobRespObj'
, backendJobRespObj_error
- If the request fails, this error is returned.
$sel:updateTime:BackendJobRespObj'
, backendJobRespObj_updateTime
- The time when the job was last updated.
$sel:createTime:BackendJobRespObj'
, backendJobRespObj_createTime
- The time when the job was created.
$sel:appId:BackendJobRespObj'
, backendJobRespObj_appId
- The app ID.
$sel:backendEnvironmentName:BackendJobRespObj'
, backendJobRespObj_backendEnvironmentName
- The name of the backend environment.
CreateBackendAuthForgotPasswordConfig
data CreateBackendAuthForgotPasswordConfig Source #
Describes the forgot password policy for authenticating into the Amplify app.
See: newCreateBackendAuthForgotPasswordConfig
smart constructor.
Instances
newCreateBackendAuthForgotPasswordConfig Source #
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
- The configuration for the email sent when an app user forgets their
password.
$sel:smsSettings:CreateBackendAuthForgotPasswordConfig'
, createBackendAuthForgotPasswordConfig_smsSettings
- The configuration for the SMS message sent when an app user forgets
their password.
$sel:deliveryMethod:CreateBackendAuthForgotPasswordConfig'
, createBackendAuthForgotPasswordConfig_deliveryMethod
- 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.
Instances
newCreateBackendAuthIdentityPoolConfig Source #
:: 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.
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.
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.
CreateBackendAuthOAuthConfig
data CreateBackendAuthOAuthConfig Source #
Creates the OAuth configuration for your Amplify project.
See: newCreateBackendAuthOAuthConfig
smart constructor.
CreateBackendAuthOAuthConfig' (Maybe SocialProviderSettings) (Maybe Text) [Text] [Text] OAuthGrantType [OAuthScopesElement] |
Instances
newCreateBackendAuthOAuthConfig Source #
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:socialProviderSettings:CreateBackendAuthOAuthConfig'
, createBackendAuthOAuthConfig_socialProviderSettings
- The settings for using social providers to access your Amplify app.
$sel:domainPrefix:CreateBackendAuthOAuthConfig'
, createBackendAuthOAuthConfig_domainPrefix
- The domain prefix for 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.
CreateBackendAuthPasswordPolicyConfig
data CreateBackendAuthPasswordPolicyConfig Source #
The password policy configuration for the backend to your Amplify project.
See: newCreateBackendAuthPasswordPolicyConfig
smart constructor.
Instances
newCreateBackendAuthPasswordPolicyConfig Source #
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.
CreateBackendAuthResourceConfig
data CreateBackendAuthResourceConfig Source #
Defines the resource configuration when creating an auth resource in your Amplify project.
See: newCreateBackendAuthResourceConfig
smart constructor.
CreateBackendAuthResourceConfig' (Maybe CreateBackendAuthIdentityPoolConfig) AuthResources CreateBackendAuthUserPoolConfig Service |
Instances
newCreateBackendAuthResourceConfig Source #
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.
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.
Instances
newCreateBackendAuthUserPoolConfig Source #
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:passwordPolicy:CreateBackendAuthUserPoolConfig'
, createBackendAuthUserPoolConfig_passwordPolicy
- Describes the 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:forgotPassword:CreateBackendAuthUserPoolConfig'
, createBackendAuthUserPoolConfig_forgotPassword
- Describes the forgotten password policy 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: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.
EmailSettings
data EmailSettings Source #
The configuration for the email sent when an app user forgets their password.
See: newEmailSettings
smart constructor.
EmailSettings' (Maybe Text) (Maybe Text) |
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:emailSubject:EmailSettings'
, emailSettings_emailSubject
- The subject of the email.
$sel:emailMessage:EmailSettings'
, emailSettings_emailMessage
- The body of the email.
LoginAuthConfigReqObj
data LoginAuthConfigReqObj Source #
The request object for this operation.
See: newLoginAuthConfigReqObj
smart constructor.
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:awsUserPoolsWebClientId:LoginAuthConfigReqObj'
, loginAuthConfigReqObj_awsUserPoolsWebClientId
- The web client ID for the Amazon Cognito user pools.
$sel:awsCognitoIdentityPoolId:LoginAuthConfigReqObj'
, loginAuthConfigReqObj_awsCognitoIdentityPoolId
- The Amazon Cognito identity pool ID used for the Amplify Admin UI login
authorization.
$sel:awsUserPoolsId:LoginAuthConfigReqObj'
, loginAuthConfigReqObj_awsUserPoolsId
- The Amazon Cognito user pool ID used for Amplify Admin UI login
authentication.
$sel:awsCognitoRegion:LoginAuthConfigReqObj'
, loginAuthConfigReqObj_awsCognitoRegion
- The AWS Region for the Amplify Admin UI login.
ResourceConfig
data ResourceConfig Source #
Defines the resource configuration for the data model in your Amplify project.
See: newResourceConfig
smart constructor.
Instances
newResourceConfig :: ResourceConfig Source #
Create a value of ResourceConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Settings
The settings of your MFA configuration for the backend of your Amplify project.
See: newSettings
smart constructor.
Settings' (Maybe Text) (Maybe [MfaTypesElement]) |
Instances
Eq Settings Source # | |
Read Settings Source # | |
Show Settings Source # | |
Generic Settings Source # | |
NFData Settings Source # | |
Defined in Amazonka.AmplifyBackend.Types.Settings | |
Hashable Settings Source # | |
Defined in Amazonka.AmplifyBackend.Types.Settings | |
ToJSON Settings Source # | |
Defined in Amazonka.AmplifyBackend.Types.Settings | |
FromJSON Settings Source # | |
type Rep Settings Source # | |
Defined in Amazonka.AmplifyBackend.Types.Settings type Rep Settings = D1 ('MetaData "Settings" "Amazonka.AmplifyBackend.Types.Settings" "libZSservicesZSamazonka-amplifybackendZSamazonka-amplifybackend" 'False) (C1 ('MetaCons "Settings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "smsMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "mfaTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MfaTypesElement])))) |
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:smsMessage:Settings'
, settings_smsMessage
- The body of the SMS message.
$sel:mfaTypes:Settings'
, settings_mfaTypes
- The supported MFA types.
SmsSettings
data SmsSettings Source #
SMS settings for authentication.
See: newSmsSettings
smart constructor.
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 body 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.
SocialProviderSettings' (Maybe BackendAuthSocialProviderConfig) (Maybe BackendAuthAppleProviderConfig) (Maybe BackendAuthSocialProviderConfig) (Maybe BackendAuthSocialProviderConfig) |
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:loginWithAmazon:SocialProviderSettings'
, socialProviderSettings_loginWithAmazon
- Undocumented member.
$sel:signInWithApple:SocialProviderSettings'
, socialProviderSettings_signInWithApple
- Undocumented member.
$sel:facebook:SocialProviderSettings'
, socialProviderSettings_facebook
- Undocumented member.
$sel:google:SocialProviderSettings'
, socialProviderSettings_google
- Undocumented member.
UpdateBackendAuthForgotPasswordConfig
data UpdateBackendAuthForgotPasswordConfig Source #
Describes the forgot password policy for authenticating into the Amplify app.
See: newUpdateBackendAuthForgotPasswordConfig
smart constructor.
UpdateBackendAuthForgotPasswordConfig' (Maybe EmailSettings) (Maybe SmsSettings) (Maybe DeliveryMethod) |
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:emailSettings:UpdateBackendAuthForgotPasswordConfig'
, updateBackendAuthForgotPasswordConfig_emailSettings
- The configuration for the email sent when an app user forgets their
password.
$sel:smsSettings:UpdateBackendAuthForgotPasswordConfig'
, updateBackendAuthForgotPasswordConfig_smsSettings
- The configuration for the SMS message sent when an Amplify app user
forgets their password.
$sel:deliveryMethod:UpdateBackendAuthForgotPasswordConfig'
, updateBackendAuthForgotPasswordConfig_deliveryMethod
- Describes which mode to use (either SMS or email) to deliver messages to
app users that want to recover 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.
Instances
Eq UpdateBackendAuthIdentityPoolConfig Source # | |
Read UpdateBackendAuthIdentityPoolConfig Source # | |
Show UpdateBackendAuthIdentityPoolConfig Source # | |
Generic UpdateBackendAuthIdentityPoolConfig Source # | |
NFData UpdateBackendAuthIdentityPoolConfig Source # | |
Hashable UpdateBackendAuthIdentityPoolConfig Source # | |
ToJSON UpdateBackendAuthIdentityPoolConfig Source # | |
type Rep UpdateBackendAuthIdentityPoolConfig Source # | |
Defined in Amazonka.AmplifyBackend.Types.UpdateBackendAuthIdentityPoolConfig type Rep UpdateBackendAuthIdentityPoolConfig = D1 ('MetaData "UpdateBackendAuthIdentityPoolConfig" "Amazonka.AmplifyBackend.Types.UpdateBackendAuthIdentityPoolConfig" "libZSservicesZSamazonka-amplifybackendZSamazonka-amplifybackend" 'False) (C1 ('MetaCons "UpdateBackendAuthIdentityPoolConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "unauthenticatedLogin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) |
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.
UpdateBackendAuthMFAConfig
data UpdateBackendAuthMFAConfig Source #
Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.
See: newUpdateBackendAuthMFAConfig
smart constructor.
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:settings:UpdateBackendAuthMFAConfig'
, updateBackendAuthMFAConfig_settings
- The settings of your MFA configuration for the backend of your Amplify
project.
$sel:mfaMode:UpdateBackendAuthMFAConfig'
, updateBackendAuthMFAConfig_mfaMode
- The MFA mode 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.
UpdateBackendAuthOAuthConfig' (Maybe SocialProviderSettings) (Maybe Text) (Maybe [OAuthScopesElement]) (Maybe OAuthGrantType) (Maybe [Text]) (Maybe [Text]) |
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:socialProviderSettings:UpdateBackendAuthOAuthConfig'
, updateBackendAuthOAuthConfig_socialProviderSettings
- Describes third-party social federation configurations for allowing your
users to sign in with OAuth.
$sel:domainPrefix:UpdateBackendAuthOAuthConfig'
, updateBackendAuthOAuthConfig_domainPrefix
- The Amazon Cognito domain prefix used to create a hosted UI for
authentication.
$sel:oAuthScopes:UpdateBackendAuthOAuthConfig'
, updateBackendAuthOAuthConfig_oAuthScopes
- The list of OAuth-related flows that can allow users to authenticate
from your Amplify app.
$sel:oAuthGrantType:UpdateBackendAuthOAuthConfig'
, updateBackendAuthOAuthConfig_oAuthGrantType
- The OAuth grant type to allow app users to authenticate from your
Amplify app.
$sel:redirectSignOutURIs:UpdateBackendAuthOAuthConfig'
, updateBackendAuthOAuthConfig_redirectSignOutURIs
- Redirect URLs that OAuth uses when a user signs out of an Amplify app.
$sel:redirectSignInURIs:UpdateBackendAuthOAuthConfig'
, updateBackendAuthOAuthConfig_redirectSignInURIs
- Redirect URLs that OAuth uses when a user signs in to an Amplify app.
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.
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.
UpdateBackendAuthResourceConfig
data UpdateBackendAuthResourceConfig Source #
Defines the resource configuration when updating an authentication resource in your Amplify project.
See: newUpdateBackendAuthResourceConfig
smart constructor.
UpdateBackendAuthResourceConfig' (Maybe UpdateBackendAuthIdentityPoolConfig) AuthResources UpdateBackendAuthUserPoolConfig Service |
Instances
newUpdateBackendAuthResourceConfig Source #
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.
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.
UpdateBackendAuthUserPoolConfig' (Maybe UpdateBackendAuthPasswordPolicyConfig) (Maybe UpdateBackendAuthMFAConfig) (Maybe UpdateBackendAuthForgotPasswordConfig) (Maybe UpdateBackendAuthOAuthConfig) |
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:passwordPolicy:UpdateBackendAuthUserPoolConfig'
, updateBackendAuthUserPoolConfig_passwordPolicy
- Describes the 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:forgotPassword:UpdateBackendAuthUserPoolConfig'
, updateBackendAuthUserPoolConfig_forgotPassword
- Describes the forgot password policy 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.