5.0.0 • Published 3 years ago
@datafire/amazonaws_amplifybackend v5.0.0
@datafire/amazonaws_amplifybackend
Client library for AmplifyBackend
Installation and Usage
npm install --save @datafire/amazonaws_amplifybackend
let amazonaws_amplifybackend = require('@datafire/amazonaws_amplifybackend').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
.then(data => {
console.log(data);
});
Description
AWS Amplify Admin API
Actions
CreateBackend
amazonaws_amplifybackend.CreateBackend({
"appId": "",
"appName": "",
"backendEnvironmentName": ""
}, context)
Input
- input
object
- appId required
string
: The app ID. - appName required
string
: The name of the app. - backendEnvironmentName required
string
: The name of the backend environment. - resourceConfig
object
: Defines the resource configuration for the data model in your Amplify project. - resourceName
string
: The name of the resource.
- appId required
Output
- output CreateBackendResponse
CreateBackendAPI
amazonaws_amplifybackend.CreateBackendAPI({
"appId": "",
"backendEnvironmentName": "",
"resourceConfig": {},
"resourceName": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
: The name of the backend environment. - resourceConfig required
object
: The resource configuration for the data model, configured as a part of the Amplify project.- AdditionalAuthTypes
- items BackendAPIAuthType
- ApiName
- ConflictResolution
- ResolutionStrategy
- DefaultAuthType
- Mode
- Settings
- CognitoUserPoolId
- Description
- ExpirationTime
- OpenIDAuthTTL
- OpenIDClientId
- OpenIDIatTTL
- OpenIDIssueURL
- OpenIDProviderName
- Service
- TransformSchema
- AdditionalAuthTypes
- resourceName required
string
: The name of this resource.
- appId required
Output
- output CreateBackendAPIResponse
UpdateBackendAPI
amazonaws_amplifybackend.UpdateBackendAPI({
"appId": "",
"backendEnvironmentName": "",
"resourceName": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
- resourceConfig
object
: The resource configuration for the data model, configured as a part of the Amplify project.- AdditionalAuthTypes
- items BackendAPIAuthType
- ApiName
- ConflictResolution
- ResolutionStrategy
- DefaultAuthType
- Mode
- Settings
- CognitoUserPoolId
- Description
- ExpirationTime
- OpenIDAuthTTL
- OpenIDClientId
- OpenIDIatTTL
- OpenIDIssueURL
- OpenIDProviderName
- Service
- TransformSchema
- AdditionalAuthTypes
- resourceName required
string
: The name of this resource.
- appId required
Output
- output UpdateBackendAPIResponse
GetBackendAPI
amazonaws_amplifybackend.GetBackendAPI({
"appId": "",
"backendEnvironmentName": "",
"resourceName": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
- resourceConfig
object
: The resource configuration for the data model, configured as a part of the Amplify project.- AdditionalAuthTypes
- items BackendAPIAuthType
- ApiName
- ConflictResolution
- ResolutionStrategy
- DefaultAuthType
- Mode
- Settings
- CognitoUserPoolId
- Description
- ExpirationTime
- OpenIDAuthTTL
- OpenIDClientId
- OpenIDIatTTL
- OpenIDIssueURL
- OpenIDProviderName
- Service
- TransformSchema
- AdditionalAuthTypes
- resourceName required
string
: The name of this resource.
- appId required
Output
- output GetBackendAPIResponse
GenerateBackendAPIModels
amazonaws_amplifybackend.GenerateBackendAPIModels({
"appId": "",
"backendEnvironmentName": "",
"resourceName": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
- resourceName required
string
: The name of this resource.
- appId required
Output
GetBackendAPIModels
amazonaws_amplifybackend.GetBackendAPIModels({
"appId": "",
"backendEnvironmentName": "",
"resourceName": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
- resourceName required
string
: The name of this resource.
- appId required
Output
- output GetBackendAPIModelsResponse
DeleteBackendAPI
amazonaws_amplifybackend.DeleteBackendAPI({
"appId": "",
"backendEnvironmentName": "",
"resourceName": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
- resourceConfig
object
: The resource configuration for the data model, configured as a part of the Amplify project.- AdditionalAuthTypes
- items BackendAPIAuthType
- ApiName
- ConflictResolution
- ResolutionStrategy
- DefaultAuthType
- Mode
- Settings
- CognitoUserPoolId
- Description
- ExpirationTime
- OpenIDAuthTTL
- OpenIDClientId
- OpenIDIatTTL
- OpenIDIssueURL
- OpenIDProviderName
- Service
- TransformSchema
- AdditionalAuthTypes
- resourceName required
string
: The name of this resource.
- appId required
Output
- output DeleteBackendAPIResponse
CreateBackendAuth
amazonaws_amplifybackend.CreateBackendAuth({
"appId": "",
"backendEnvironmentName": "",
"resourceConfig": {},
"resourceName": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
: The name of the backend environment. - resourceConfig required
object
: Defines the resource configuration when creating an auth resource in your Amplify project.- AuthResources
- IdentityPoolConfigs
- IdentityPoolName required
- UnauthenticatedLogin required
- Service
- UserPoolConfigs
- ForgotPassword
- DeliveryMethod required
- EmailSettings
- EmailMessage
- EmailSubject
- SmsSettings
- SmsMessage
- Mfa
- MFAMode required
- Settings
- MfaTypes
- SmsMessage
- OAuth
- DomainPrefix
- OAuthGrantType required
- OAuthScopes required
- items OAuthScopesElement
- RedirectSignInURIs required
- items __string
- RedirectSignOutURIs required
- items __string
- SocialProviderSettings
- Facebook BackendAuthSocialProviderConfig
- Google BackendAuthSocialProviderConfig
- LoginWithAmazon BackendAuthSocialProviderConfig
- PasswordPolicy
- AdditionalConstraints
- MinimumLength required
- RequiredSignUpAttributes required
- SignInMethod required
- UserPoolName required
- ForgotPassword
- resourceName required
string
: The name of this resource.
- appId required
Output
- output CreateBackendAuthResponse
UpdateBackendAuth
amazonaws_amplifybackend.UpdateBackendAuth({
"appId": "",
"backendEnvironmentName": "",
"resourceConfig": {},
"resourceName": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
- resourceConfig required
object
: Defines the resource configuration when updating an authentication resource in your Amplify project.- AuthResources
- IdentityPoolConfigs
- UnauthenticatedLogin
- Service
- UserPoolConfigs
- ForgotPassword
- DeliveryMethod
- EmailSettings
- EmailMessage
- EmailSubject
- SmsSettings
- SmsMessage
- Mfa
- MFAMode
- Settings
- MfaTypes
- SmsMessage
- OAuth
- DomainPrefix
- OAuthGrantType
- OAuthScopes
- items OAuthScopesElement
- RedirectSignInURIs
- items __string
- RedirectSignOutURIs
- items __string
- SocialProviderSettings
- Facebook BackendAuthSocialProviderConfig
- Google BackendAuthSocialProviderConfig
- LoginWithAmazon BackendAuthSocialProviderConfig
- PasswordPolicy
- AdditionalConstraints
- MinimumLength
- ForgotPassword
- resourceName required
string
: The name of this resource.
- appId required
Output
- output UpdateBackendAuthResponse
GetBackendAuth
amazonaws_amplifybackend.GetBackendAuth({
"appId": "",
"backendEnvironmentName": "",
"resourceName": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
- resourceName required
string
: The name of this resource.
- appId required
Output
- output GetBackendAuthResponse
DeleteBackendAuth
amazonaws_amplifybackend.DeleteBackendAuth({
"appId": "",
"backendEnvironmentName": "",
"resourceName": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
- resourceName required
string
: The name of this resource.
- appId required
Output
- output DeleteBackendAuthResponse
CreateToken
amazonaws_amplifybackend.CreateToken({
"appId": ""
}, context)
Input
- input
object
- appId required
string
- appId required
Output
- output CreateTokenResponse
GetToken
amazonaws_amplifybackend.GetToken({
"appId": "",
"sessionId": ""
}, context)
Input
- input
object
- appId required
string
- sessionId required
string
- appId required
Output
- output GetTokenResponse
DeleteToken
amazonaws_amplifybackend.DeleteToken({
"appId": "",
"sessionId": ""
}, context)
Input
- input
object
- appId required
string
- sessionId required
string
- appId required
Output
- output DeleteTokenResponse
CreateBackendConfig
amazonaws_amplifybackend.CreateBackendConfig({
"appId": ""
}, context)
Input
- input
object
- appId required
string
- backendManagerAppId
string
: The app ID for the backend manager.
- appId required
Output
- output CreateBackendConfigResponse
RemoveBackendConfig
amazonaws_amplifybackend.RemoveBackendConfig({
"appId": ""
}, context)
Input
- input
object
- appId required
string
- appId required
Output
- output RemoveBackendConfigResponse
UpdateBackendConfig
amazonaws_amplifybackend.UpdateBackendConfig({
"appId": ""
}, context)
Input
- input
object
- appId required
string
- loginAuthConfig
object
: The request object for this operation.- AwsCognitoIdentityPoolId
- AwsCognitoRegion
- AwsUserPoolsId
- AwsUserPoolsWebClientId
- appId required
Output
- output UpdateBackendConfigResponse
GetBackend
amazonaws_amplifybackend.GetBackend({
"appId": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName
string
: The name of the backend environment.
- appId required
Output
- output GetBackendResponse
CloneBackend
amazonaws_amplifybackend.CloneBackend({
"appId": "",
"backendEnvironmentName": "",
"targetEnvironmentName": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
- targetEnvironmentName required
string
: The name of the destination backend environment to be created.
- appId required
Output
- output CloneBackendResponse
DeleteBackend
amazonaws_amplifybackend.DeleteBackend({
"appId": "",
"backendEnvironmentName": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
- appId required
Output
- output DeleteBackendResponse
ListBackendJobs
amazonaws_amplifybackend.ListBackendJobs({
"appId": "",
"backendEnvironmentName": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
- MaxResults
string
- NextToken
string
- jobId
string
: The ID for the job. - maxResults
integer
: The maximum number of results that you want in the response. - nextToken
string
: The token for the next set of results. - operation
string
: Filters the list of response objects to include only those with the specified operation name. - status
string
: Filters the list of response objects to include only those with the specified status.
- appId required
Output
- output ListBackendJobsResponse
GetBackendJob
amazonaws_amplifybackend.GetBackendJob({
"appId": "",
"backendEnvironmentName": "",
"jobId": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
- jobId required
string
- appId required
Output
- output GetBackendJobResponse
UpdateBackendJob
amazonaws_amplifybackend.UpdateBackendJob({
"appId": "",
"backendEnvironmentName": "",
"jobId": ""
}, context)
Input
- input
object
- appId required
string
- backendEnvironmentName required
string
- jobId required
string
- operation
string
: Filters the list of response objects to include only those with the specified operation name. - status
string
: Filters the list of response objects to include only those with the specified status.
- appId required
Output
- output UpdateBackendJobResponse
RemoveAllBackends
amazonaws_amplifybackend.RemoveAllBackends({
"appId": ""
}, context)
Input
- input
object
- appId required
string
- cleanAmplifyApp
boolean
: Cleans up the Amplify Console app if this value is set to true.
- appId required
Output
- output RemoveAllBackendsResponse
Definitions
AdditionalConstraintsElement
- AdditionalConstraintsElement
string
(values: REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE)
AuthResources
- AuthResources
string
(values: USER_POOL_ONLY, IDENTITY_POOL_AND_USER_POOL)
BackendAPIAppSyncAuthSettings
- BackendAPIAppSyncAuthSettings
object
: The authentication settings for accessing provisioned data models in your Amplify project.- CognitoUserPoolId
- Description
- ExpirationTime
- OpenIDAuthTTL
- OpenIDClientId
- OpenIDIatTTL
- OpenIDIssueURL
- OpenIDProviderName
BackendAPIAuthType
- BackendAPIAuthType
object
: Describes the auth types for your configured data models.- Mode
- Settings
- CognitoUserPoolId
- Description
- ExpirationTime
- OpenIDAuthTTL
- OpenIDClientId
- OpenIDIatTTL
- OpenIDIssueURL
- OpenIDProviderName
BackendAPIConflictResolution
- BackendAPIConflictResolution
object
: Describes the conflict resolution configuration for the data model configured in your Amplify project.- ResolutionStrategy
BackendAPIResourceConfig
- BackendAPIResourceConfig
object
: The resource configuration for the data model, configured as a part of the Amplify project.- AdditionalAuthTypes
- items BackendAPIAuthType
- ApiName
- ConflictResolution
- ResolutionStrategy
- DefaultAuthType
- Mode
- Settings
- CognitoUserPoolId
- Description
- ExpirationTime
- OpenIDAuthTTL
- OpenIDClientId
- OpenIDIatTTL
- OpenIDIssueURL
- OpenIDProviderName
- Service
- TransformSchema
- AdditionalAuthTypes
BackendAuthSocialProviderConfig
- BackendAuthSocialProviderConfig
object
: Describes third-party social federation configurations for allowing your app users to sign in using OAuth.- ClientId
- ClientSecret
BackendJobRespObj
- BackendJobRespObj
object
: The response object for this operation.- AppId required
- BackendEnvironmentName required
- CreateTime
- Error
- JobId
- Operation
- Status
- UpdateTime
BadRequestException
CloneBackendRequest
- CloneBackendRequest
object
: The request body for CloneBackend.- TargetEnvironmentName required
CloneBackendResponse
- CloneBackendResponse
object
- AppId
- BackendEnvironmentName
- Error
- JobId
- Operation
- Status
CreateBackendAPIRequest
- CreateBackendAPIRequest
object
: The request body for CreateBackendAPI.- BackendEnvironmentName required
- ResourceConfig required
- AdditionalAuthTypes
- items BackendAPIAuthType
- ApiName
- ConflictResolution
- ResolutionStrategy
- DefaultAuthType
- Mode
- Settings
- CognitoUserPoolId
- Description
- ExpirationTime
- OpenIDAuthTTL
- OpenIDClientId
- OpenIDIatTTL
- OpenIDIssueURL
- OpenIDProviderName
- Service
- TransformSchema
- AdditionalAuthTypes
- ResourceName required
CreateBackendAPIResponse
- CreateBackendAPIResponse
object
- AppId
- BackendEnvironmentName
- Error
- JobId
- Operation
- Status
CreateBackendAuthForgotPasswordConfig
- CreateBackendAuthForgotPasswordConfig
object
: Describes the forgot password policy for authenticating into the Amplify app.- DeliveryMethod required
- EmailSettings
- EmailMessage
- EmailSubject
- SmsSettings
- SmsMessage
CreateBackendAuthIdentityPoolConfig
- CreateBackendAuthIdentityPoolConfig
object
: Describes authorization configurations for the auth resources, configured as a part of your Amplify project.- IdentityPoolName required
- UnauthenticatedLogin required
CreateBackendAuthMFAConfig
- CreateBackendAuthMFAConfig
object
: Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.- MFAMode required
- Settings
- MfaTypes
- items MfaTypesElement
- SmsMessage
- MfaTypes
CreateBackendAuthOAuthConfig
- CreateBackendAuthOAuthConfig
object
: Creates the OAuth configuration for your Amplify project.- DomainPrefix
- OAuthGrantType required
- OAuthScopes required
- items OAuthScopesElement
- RedirectSignInURIs required
- items __string
- RedirectSignOutURIs required
- items __string
- SocialProviderSettings
- Facebook BackendAuthSocialProviderConfig
- Google BackendAuthSocialProviderConfig
- LoginWithAmazon BackendAuthSocialProviderConfig
CreateBackendAuthPasswordPolicyConfig
- CreateBackendAuthPasswordPolicyConfig
object
: The password policy configuration for the backend of your Amplify project.- AdditionalConstraints
- MinimumLength required
CreateBackendAuthRequest
- CreateBackendAuthRequest
object
: The request body for CreateBackendAuth.- BackendEnvironmentName required
- ResourceConfig required
- AuthResources required
- IdentityPoolConfigs
- IdentityPoolName required
- UnauthenticatedLogin required
- Service required
- UserPoolConfigs required
- ForgotPassword
- DeliveryMethod required
- EmailSettings
- EmailMessage
- EmailSubject
- SmsSettings
- SmsMessage
- Mfa
- MFAMode required
- Settings
- MfaTypes
- SmsMessage
- OAuth
- DomainPrefix
- OAuthGrantType required
- OAuthScopes required
- items OAuthScopesElement
- RedirectSignInURIs required
- items __string
- RedirectSignOutURIs required
- items __string
- SocialProviderSettings
- Facebook BackendAuthSocialProviderConfig
- Google BackendAuthSocialProviderConfig
- LoginWithAmazon BackendAuthSocialProviderConfig
- PasswordPolicy
- AdditionalConstraints
- MinimumLength required
- RequiredSignUpAttributes required
- SignInMethod required
- UserPoolName required
- ForgotPassword
- ResourceName required
CreateBackendAuthResourceConfig
- CreateBackendAuthResourceConfig
object
: Defines the resource configuration when creating an auth resource in your Amplify project.- AuthResources required
- IdentityPoolConfigs
- IdentityPoolName required
- UnauthenticatedLogin required
- Service required
- UserPoolConfigs required
- ForgotPassword
- DeliveryMethod required
- EmailSettings
- EmailMessage
- EmailSubject
- SmsSettings
- SmsMessage
- Mfa
- MFAMode required
- Settings
- MfaTypes
- items MfaTypesElement
- SmsMessage
- MfaTypes
- OAuth
- DomainPrefix
- OAuthGrantType required
- OAuthScopes required
- items OAuthScopesElement
- RedirectSignInURIs required
- items __string
- RedirectSignOutURIs required
- items __string
- SocialProviderSettings
- Facebook BackendAuthSocialProviderConfig
- Google BackendAuthSocialProviderConfig
- LoginWithAmazon BackendAuthSocialProviderConfig
- PasswordPolicy
- AdditionalConstraints
- MinimumLength required
- RequiredSignUpAttributes required
- SignInMethod required
- UserPoolName required
- ForgotPassword
CreateBackendAuthResponse
- CreateBackendAuthResponse
object
- AppId
- BackendEnvironmentName
- Error
- JobId
- Operation
- Status
CreateBackendAuthUserPoolConfig
- CreateBackendAuthUserPoolConfig
object
: Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.- ForgotPassword
- DeliveryMethod required
- EmailSettings
- EmailMessage
- EmailSubject
- SmsSettings
- SmsMessage
- Mfa
- MFAMode required
- Settings
- MfaTypes
- items MfaTypesElement
- SmsMessage
- MfaTypes
- OAuth
- DomainPrefix
- OAuthGrantType required
- OAuthScopes required
- items OAuthScopesElement
- RedirectSignInURIs required
- items __string
- RedirectSignOutURIs required
- items __string
- SocialProviderSettings
- Facebook BackendAuthSocialProviderConfig
- Google BackendAuthSocialProviderConfig
- LoginWithAmazon BackendAuthSocialProviderConfig
- PasswordPolicy
- AdditionalConstraints
- MinimumLength required
- RequiredSignUpAttributes required
- SignInMethod required
- UserPoolName required
- ForgotPassword
CreateBackendConfigRequest
- CreateBackendConfigRequest
object
: The request body for CreateBackendConfig.- BackendManagerAppId
CreateBackendConfigResponse
- CreateBackendConfigResponse
object
- AppId
- BackendEnvironmentName
- JobId
- Status
CreateBackendRequest
- CreateBackendRequest
object
: The request body for CreateBackend.- AppId required
- AppName required
- BackendEnvironmentName required
- ResourceConfig
- ResourceName
CreateBackendResponse
- CreateBackendResponse
object
- AppId
- BackendEnvironmentName
- Error
- JobId
- Operation
- Status
CreateTokenRequest
- CreateTokenRequest
object
CreateTokenResponse
- CreateTokenResponse
object
- AppId
- ChallengeCode
- SessionId
- Ttl
DeleteBackendAPIRequest
- DeleteBackendAPIRequest
object
: The request body for DeleteBackendAPI.- ResourceConfig
- AdditionalAuthTypes
- items BackendAPIAuthType
- ApiName
- ConflictResolution
- ResolutionStrategy
- DefaultAuthType
- Mode
- Settings
- CognitoUserPoolId
- Description
- ExpirationTime
- OpenIDAuthTTL
- OpenIDClientId
- OpenIDIatTTL
- OpenIDIssueURL
- OpenIDProviderName
- Service
- TransformSchema
- AdditionalAuthTypes
- ResourceName required
- ResourceConfig
DeleteBackendAPIResponse
- DeleteBackendAPIResponse
object
- AppId
- BackendEnvironmentName
- Error
- JobId
- Operation
- Status
DeleteBackendAuthRequest
- DeleteBackendAuthRequest
object
: The request body for DeleteBackendAuth.- ResourceName required
DeleteBackendAuthResponse
- DeleteBackendAuthResponse
object
- AppId
- BackendEnvironmentName
- Error
- JobId
- Operation
- Status
DeleteBackendRequest
- DeleteBackendRequest
object
DeleteBackendResponse
- DeleteBackendResponse
object
- AppId
- BackendEnvironmentName
- Error
- JobId
- Operation
- Status
DeleteTokenRequest
- DeleteTokenRequest
object
DeleteTokenResponse
- DeleteTokenResponse
object
- IsSuccess
DeliveryMethod
- DeliveryMethod
string
(values: EMAIL, SMS)
EmailSettings
- EmailSettings
object
: The configuration for the email sent when an app user forgets their password.- EmailMessage
- EmailSubject
GatewayTimeoutException
GenerateBackendAPIModelsRequest
- GenerateBackendAPIModelsRequest
object
: The request body for GenerateBackendAPIModels.- ResourceName required
GenerateBackendAPIModelsResponse
- GenerateBackendAPIModelsResponse
object
- AppId
- BackendEnvironmentName
- Error
- JobId
- Operation
- Status
GetBackendAPIModelsRequest
- GetBackendAPIModelsRequest
object
: The request body for GetBackendAPIModels.- ResourceName required
GetBackendAPIModelsResponse
- GetBackendAPIModelsResponse
object
- Models
- Status
GetBackendAPIRequest
- GetBackendAPIRequest
object
: The request body for GetBackendAPI.- ResourceConfig
- AdditionalAuthTypes
- items BackendAPIAuthType
- ApiName
- ConflictResolution
- ResolutionStrategy
- DefaultAuthType
- Mode
- Settings
- CognitoUserPoolId
- Description
- ExpirationTime
- OpenIDAuthTTL
- OpenIDClientId
- OpenIDIatTTL
- OpenIDIssueURL
- OpenIDProviderName
- Service
- TransformSchema
- AdditionalAuthTypes
- ResourceName required
- ResourceConfig
GetBackendAPIResponse
- GetBackendAPIResponse
object
- AppId
- BackendEnvironmentName
- Error
- ResourceConfig
- AdditionalAuthTypes
- items BackendAPIAuthType
- ApiName
- ConflictResolution
- ResolutionStrategy
- DefaultAuthType
- Mode
- Settings
- CognitoUserPoolId
- Description
- ExpirationTime
- OpenIDAuthTTL
- OpenIDClientId
- OpenIDIatTTL
- OpenIDIssueURL
- OpenIDProviderName
- Service
- TransformSchema
- AdditionalAuthTypes
- ResourceName
GetBackendAuthRequest
- GetBackendAuthRequest
object
: The request body for GetBackendAuth.- ResourceName required
GetBackendAuthResponse
- GetBackendAuthResponse
object
- AppId
- BackendEnvironmentName
- Error
- ResourceConfig
- AuthResources required
- IdentityPoolConfigs
- IdentityPoolName required
- UnauthenticatedLogin required
- Service required
- UserPoolConfigs required
- ForgotPassword
- DeliveryMethod required
- EmailSettings
- EmailMessage
- EmailSubject
- SmsSettings
- SmsMessage
- Mfa
- MFAMode required
- Settings
- MfaTypes
- SmsMessage
- OAuth
- DomainPrefix
- OAuthGrantType required
- OAuthScopes required
- items OAuthScopesElement
- RedirectSignInURIs required
- items __string
- RedirectSignOutURIs required
- items __string
- SocialProviderSettings
- Facebook BackendAuthSocialProviderConfig
- Google BackendAuthSocialProviderConfig
- LoginWithAmazon BackendAuthSocialProviderConfig
- PasswordPolicy
- AdditionalConstraints
- MinimumLength required
- RequiredSignUpAttributes required
- SignInMethod required
- UserPoolName required
- ForgotPassword
- ResourceName
GetBackendJobRequest
- GetBackendJobRequest
object
GetBackendJobResponse
- GetBackendJobResponse
object
- AppId
- BackendEnvironmentName
- CreateTime
- Error
- JobId
- Operation
- Status
- UpdateTime
GetBackendRequest
- GetBackendRequest
object
: The request body for GetBackend.- BackendEnvironmentName
GetBackendResponse
- GetBackendResponse
object
- AmplifyMetaConfig
- AppId
- AppName
- BackendEnvironmentList
- items __string
- BackendEnvironmentName
- Error
GetTokenRequest
- GetTokenRequest
object
GetTokenResponse
- GetTokenResponse
object
- AppId
- ChallengeCode
- SessionId
- Ttl
ListBackendJobsRequest
- ListBackendJobsRequest
object
: The request body for ListBackendJobs.- JobId
- MaxResults
- NextToken
- Operation
- Status
ListBackendJobsResponse
- ListBackendJobsResponse
object
- Jobs
- items BackendJobRespObj
- NextToken
- Jobs
ListOfAdditionalConstraintsElement
- ListOfAdditionalConstraintsElement
array
ListOfBackendAPIAuthType
- ListOfBackendAPIAuthType
array
- items BackendAPIAuthType
ListOfBackendJobRespObj
- ListOfBackendJobRespObj
array
- items BackendJobRespObj
ListOfMfaTypesElement
- ListOfMfaTypesElement
array
- items MfaTypesElement
ListOfOAuthScopesElement
- ListOfOAuthScopesElement
array
- items OAuthScopesElement
ListOfRequiredSignUpAttributesElement
- ListOfRequiredSignUpAttributesElement
array
ListOf__string
- ListOf__string
array
- items __string
LoginAuthConfigReqObj
- LoginAuthConfigReqObj
object
: The request object for this operation.- AwsCognitoIdentityPoolId
- AwsCognitoRegion
- AwsUserPoolsId
- AwsUserPoolsWebClientId
MFAMode
- MFAMode
string
(values: ON, OFF, OPTIONAL)
MfaTypesElement
- MfaTypesElement
string
(values: SMS, TOTP)
Mode
- Mode
string
(values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT)
NotFoundException
OAuthGrantType
- OAuthGrantType
string
(values: CODE, IMPLICIT)
OAuthScopesElement
- OAuthScopesElement
string
(values: PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN)
RemoveAllBackendsRequest
- RemoveAllBackendsRequest
object
: The request body for RemoveAllBackends.- CleanAmplifyApp
RemoveAllBackendsResponse
- RemoveAllBackendsResponse
object
- AppId
- Error
- JobId
- Operation
- Status
RemoveBackendConfigRequest
- RemoveBackendConfigRequest
object
RemoveBackendConfigResponse
- RemoveBackendConfigResponse
object
- Error
RequiredSignUpAttributesElement
- RequiredSignUpAttributesElement
string
(values: ADDRESS, BIRTHDATE, EMAIL, FAMILY_NAME, GENDER, GIVEN_NAME, LOCALE, MIDDLE_NAME, NAME, NICKNAME, PHONE_NUMBER, PICTURE, PREFERRED_USERNAME, PROFILE, UPDATED_AT, WEBSITE, ZONE_INFO)
ResolutionStrategy
- ResolutionStrategy
string
(values: OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE)
ResourceConfig
- ResourceConfig
object
: Defines the resource configuration for the data model in your Amplify project.
Service
- Service
string
(values: COGNITO)
Settings
- Settings
object
: The settings of your MFA configuration for the backend of your Amplify project.- MfaTypes
- items MfaTypesElement
- SmsMessage
- MfaTypes
SignInMethod
- SignInMethod
string
(values: EMAIL, EMAIL_AND_PHONE_NUMBER, PHONE_NUMBER, USERNAME)
SmsSettings
- SmsSettings
object
: SMS settings for authentication.- SmsMessage
SocialProviderSettings
- SocialProviderSettings
object
: The settings for using the social identity providers for access to your Amplify app.- Facebook BackendAuthSocialProviderConfig
- Google BackendAuthSocialProviderConfig
- LoginWithAmazon BackendAuthSocialProviderConfig
Status
- Status
string
(values: LATEST, STALE)
TooManyRequestsException
UpdateBackendAPIRequest
- UpdateBackendAPIRequest
object
: The request body for UpdateBackendAPI.- ResourceConfig
- AdditionalAuthTypes
- items BackendAPIAuthType
- ApiName
- ConflictResolution
- ResolutionStrategy
- DefaultAuthType
- Mode
- Settings
- CognitoUserPoolId
- Description
- ExpirationTime
- OpenIDAuthTTL
- OpenIDClientId
- OpenIDIatTTL
- OpenIDIssueURL
- OpenIDProviderName
- Service
- TransformSchema
- AdditionalAuthTypes
- ResourceName required
- ResourceConfig
UpdateBackendAPIResponse
- UpdateBackendAPIResponse
object
- AppId
- BackendEnvironmentName
- Error
- JobId
- Operation
- Status
UpdateBackendAuthForgotPasswordConfig
- UpdateBackendAuthForgotPasswordConfig
object
: Describes the forgot password policy for authenticating into the Amplify app.- DeliveryMethod
- EmailSettings
- EmailMessage
- EmailSubject
- SmsSettings
- SmsMessage
UpdateBackendAuthIdentityPoolConfig
- UpdateBackendAuthIdentityPoolConfig
object
: Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.- UnauthenticatedLogin
UpdateBackendAuthMFAConfig
- UpdateBackendAuthMFAConfig
object
: Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.- MFAMode
- Settings
- MfaTypes
- items MfaTypesElement
- SmsMessage
- MfaTypes
UpdateBackendAuthOAuthConfig
- UpdateBackendAuthOAuthConfig
object
: The OAuth configurations for authenticating users into your Amplify app.- DomainPrefix
- OAuthGrantType
- OAuthScopes
- items OAuthScopesElement
- RedirectSignInURIs
- items __string
- RedirectSignOutURIs
- items __string
- SocialProviderSettings
- Facebook BackendAuthSocialProviderConfig
- Google BackendAuthSocialProviderConfig
- LoginWithAmazon BackendAuthSocialProviderConfig
UpdateBackendAuthPasswordPolicyConfig
- UpdateBackendAuthPasswordPolicyConfig
object
: Describes the password policy for your Amazon Cognito user pool that's configured as a part of your Amplify project.- AdditionalConstraints
- MinimumLength
UpdateBackendAuthRequest
- UpdateBackendAuthRequest
object
: The request body for UpdateBackendAuth.- ResourceConfig required
- AuthResources required
- IdentityPoolConfigs
- UnauthenticatedLogin
- Service required
- UserPoolConfigs required
- ForgotPassword
- DeliveryMethod
- EmailSettings
- EmailMessage
- EmailSubject
- SmsSettings
- SmsMessage
- Mfa
- MFAMode
- Settings
- MfaTypes
- SmsMessage
- OAuth
- DomainPrefix
- OAuthGrantType
- OAuthScopes
- items OAuthScopesElement
- RedirectSignInURIs
- items __string
- RedirectSignOutURIs
- items __string
- SocialProviderSettings
- Facebook BackendAuthSocialProviderConfig
- Google BackendAuthSocialProviderConfig
- LoginWithAmazon BackendAuthSocialProviderConfig
- PasswordPolicy
- AdditionalConstraints
- MinimumLength
- ForgotPassword
- ResourceName required
- ResourceConfig required
UpdateBackendAuthResourceConfig
- UpdateBackendAuthResourceConfig
object
: Defines the resource configuration when updating an authentication resource in your Amplify project.- AuthResources required
- IdentityPoolConfigs
- UnauthenticatedLogin
- Service required
- UserPoolConfigs required
- ForgotPassword
- DeliveryMethod
- EmailSettings
- EmailMessage
- EmailSubject
- SmsSettings
- SmsMessage
- Mfa
- MFAMode
- Settings
- MfaTypes
- items MfaTypesElement
- SmsMessage
- MfaTypes
- OAuth
- DomainPrefix
- OAuthGrantType
- OAuthScopes
- items OAuthScopesElement
- RedirectSignInURIs
- items __string
- RedirectSignOutURIs
- items __string
- SocialProviderSettings
- Facebook BackendAuthSocialProviderConfig
- Google BackendAuthSocialProviderConfig
- LoginWithAmazon BackendAuthSocialProviderConfig
- PasswordPolicy
- AdditionalConstraints
- MinimumLength
- ForgotPassword
UpdateBackendAuthResponse
- UpdateBackendAuthResponse
object
- AppId
- BackendEnvironmentName
- Error
- JobId
- Operation
- Status
UpdateBackendAuthUserPoolConfig
- UpdateBackendAuthUserPoolConfig
object
: Describes the Amazon Cognito user pool configuration to configure the authorization resource for your Amplify project on an update.- ForgotPassword
- DeliveryMethod
- EmailSettings
- EmailMessage
- EmailSubject
- SmsSettings
- SmsMessage
- Mfa
- MFAMode
- Settings
- MfaTypes
- items MfaTypesElement
- SmsMessage
- MfaTypes
- OAuth
- DomainPrefix
- OAuthGrantType
- OAuthScopes
- items OAuthScopesElement
- RedirectSignInURIs
- items __string
- RedirectSignOutURIs
- items __string
- SocialProviderSettings
- Facebook BackendAuthSocialProviderConfig
- Google BackendAuthSocialProviderConfig
- LoginWithAmazon BackendAuthSocialProviderConfig
- PasswordPolicy
- AdditionalConstraints
- MinimumLength
- ForgotPassword
UpdateBackendConfigRequest
- UpdateBackendConfigRequest
object
: The request body for UpdateBackendConfig.- LoginAuthConfig
- AwsCognitoIdentityPoolId
- AwsCognitoRegion
- AwsUserPoolsId
- AwsUserPoolsWebClientId
- LoginAuthConfig
UpdateBackendConfigResponse
- UpdateBackendConfigResponse
object
- AppId
- BackendManagerAppId
- Error
- LoginAuthConfig
- AwsCognitoIdentityPoolId
- AwsCognitoRegion
- AwsUserPoolsId
- AwsUserPoolsWebClientId
UpdateBackendJobRequest
- UpdateBackendJobRequest
object
: The request body for GetBackendJob.- Operation
- Status
UpdateBackendJobResponse
- UpdateBackendJobResponse
object
- AppId
- BackendEnvironmentName
- CreateTime
- Error
- JobId
- Operation
- Status
- UpdateTime
__boolean
- __boolean
boolean
__double
- __double
number
__integerMin1Max25
- __integerMin1Max25
integer
__string
- __string
string
5.0.0
3 years ago