String cognitoUserPoolId
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
String description
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
Double expirationTime
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
String openIDAuthTTL
The expiry time for the OpenID authentication mechanism.
String openIDClientId
The clientID for openID, if openID was used as an authentication setting to access your data models.
String openIDIatTTL
The expiry time for the OpenID authentication mechanism.
String openIDIssueURL
The openID issuer URL, if openID was used as an authentication setting to access your data models.
String openIDProviderName
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
String mode
Describes the authentication mode.
BackendAPIAppSyncAuthSettings settings
Describes settings for the authentication mode.
String resolutionStrategy
The strategy for conflict resolution.
List<E> additionalAuthTypes
Additional authentication methods used to interact with your data models.
String apiName
The API name used to interact with the data model, configured as a part of your Amplify project.
BackendAPIConflictResolution conflictResolution
The conflict resolution strategy for your data stored in the data models.
BackendAPIAuthType defaultAuthType
The default authentication type for interacting with the configured data models in your Amplify project.
String service
The service used to provision and interact with the data model.
String transformSchema
The definition of the data model in the annotated transform of the GraphQL schema.
String clientId
Describes the client_id (also called Services ID) that comes from Apple.
String keyId
Describes the key_id that comes from Apple.
String privateKey
Describes the private_key that comes from Apple.
String teamId
Describes the team_id that comes from Apple.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String createTime
The time when the job was created.
String error
If the request fails, this error is returned.
String jobId
The ID for the job.
String operation
The name of the operation.
String status
The current status of the request.
String updateTime
The time when the job was last updated.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String error
If the request fails, this error is returned.
String jobId
The ID for the job.
String operation
The name of the operation.
String status
The current status of the request.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
BackendAPIResourceConfig resourceConfig
The resource configuration for this request.
String resourceName
The name of this resource.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String error
If the request fails, this error is returned.
String jobId
The ID for the job.
String operation
The name of the operation.
String status
The current status of the request.
String deliveryMethod
(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.
EmailSettings emailSettings
(DEPRECATED) The configuration for the email sent when an app user forgets their password.
SmsSettings smsSettings
(DEPRECATED) The configuration for the SMS message sent when an app user forgets their password.
String domainPrefix
The domain prefix for your Amplify app.
String oAuthGrantType
The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
List<E> oAuthScopes
List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
List<E> redirectSignInURIs
The redirected URI for signing in to your Amplify app.
List<E> redirectSignOutURIs
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
SocialProviderSettings socialProviderSettings
The settings for using social providers to access your Amplify app.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
CreateBackendAuthResourceConfig resourceConfig
The resource configuration for this request object.
String resourceName
The name of this resource.
String authResources
Defines whether you want to configure only authentication or both authentication and authorization settings.
CreateBackendAuthIdentityPoolConfig identityPoolConfigs
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
String service
Defines the service name to use when configuring an authentication resource in your Amplify project.
CreateBackendAuthUserPoolConfig userPoolConfigs
Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String error
If the request fails, this error is returned.
String jobId
The ID for the job.
String operation
The name of the operation.
String status
The current status of the request.
CreateBackendAuthForgotPasswordConfig forgotPassword
(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
CreateBackendAuthMFAConfig mfa
Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
CreateBackendAuthOAuthConfig oAuth
Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
CreateBackendAuthPasswordPolicyConfig passwordPolicy
Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
List<E> requiredSignUpAttributes
The required attributes to sign up new users in the user pool.
String 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.
String userPoolName
The Amazon Cognito user pool name.
CreateBackendAuthVerificationMessageConfig verificationMessage
Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
String deliveryMethod
The type of verification message to send.
EmailSettings emailSettings
The settings for the email message.
SmsSettings smsSettings
The settings for the SMS message.
String appId
The app ID.
String appName
The name of the app.
String backendEnvironmentName
The name of the backend environment.
ResourceConfig resourceConfig
The resource configuration for creating a backend.
String resourceName
The name of the resource.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String error
If the request fails, this error is returned.
String jobId
The ID for the job.
String operation
The name of the operation.
String status
The current status of the request.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
CreateBackendStorageResourceConfig resourceConfig
The resource configuration for creating backend storage.
String resourceName
The name of the storage resource.
String bucketName
The name of the S3 bucket.
BackendStoragePermissions permissions
The authorization configuration for the storage S3 bucket.
String serviceName
The name of the storage service.
String appId
The app ID.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
BackendAPIResourceConfig resourceConfig
Defines the resource configuration for the data model in your Amplify project.
String resourceName
The name of this resource.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String error
If the request fails, this error is returned.
String jobId
The ID for the job.
String operation
The name of the operation.
String status
The current status of the request.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String error
If the request fails, this error is returned.
String jobId
The ID for the job.
String operation
The name of the operation.
String status
The current status of the request.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String error
If the request fails, this error is returned.
String jobId
The ID for the job.
String operation
The name of the operation.
String status
The current status of the request.
Boolean isSuccess
Indicates whether the request succeeded or failed.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String error
If the request fails, this error is returned.
String jobId
The ID for the job.
String operation
The name of the operation.
String status
The current status of the request.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
BackendAPIResourceConfig resourceConfig
Defines the resource configuration for the data model in your Amplify project.
String resourceName
The name of this resource.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String error
If the request fails, this error is returned.
BackendAPIResourceConfig resourceConfig
The resource configuration for this response object.
String resourceName
The name of this resource.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String error
If the request fails, this error is returned.
CreateBackendAuthResourceConfig resourceConfig
The resource configuration for authorization requests to the backend of your Amplify project.
String resourceName
The name of this resource.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String createTime
The time when the job was created.
String error
If the request fails, this error is returned.
String jobId
The ID for the job.
String operation
The name of the operation.
String status
The current status of the request.
String updateTime
The time when the job was last updated.
String amplifyFeatureFlags
A stringified version of the cli.json file for your Amplify project.
String amplifyMetaConfig
A stringified version of the current configs for your Amplify project.
String appId
The app ID.
String appName
The name of the app.
List<E> backendEnvironmentList
A list of backend environments in an array.
String backendEnvironmentName
The name of the backend environment.
String error
If the request failed, this is the returned error.
String bucketName
The name of the S3 bucket.
Boolean imported
Returns True if the storage resource has been imported.
BackendStoragePermissions permissions
The authorization configuration for the storage S3 bucket.
String serviceName
The name of the storage service.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
GetBackendStorageResourceConfig resourceConfig
The resource configuration for the backend storage resource.
String resourceName
The name of the storage resource.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String identityPoolId
The ID of the Amazon Cognito identity pool.
String nativeClientId
The ID of the Amazon Cognito native client.
String userPoolId
The ID of the Amazon Cognito user pool.
String webClientId
The ID of the Amazon Cognito web client.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String error
If the request fails, this error is returned.
String jobId
The ID for the job.
String operation
The name of the operation.
String status
The current status of the request.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String jobId
The ID for the job.
Integer maxResults
The maximum number of results that you want in the response.
String nextToken
The token for the next set of results.
String operation
Filters the list of response objects to include only those with the specified operation name.
String status
Filters the list of response objects to include only those with the specified status.
String nextToken
Reserved for future use.
String awsCognitoIdentityPoolId
The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.
String awsCognitoRegion
The AWS Region for the Amplify Admin UI login.
String awsUserPoolsId
The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.
String awsUserPoolsWebClientId
The web client ID for the Amazon Cognito user pools.
String resourceType
The type of resource that is not found.
String appId
The app ID.
String error
If the request fails, this error is returned.
String smsMessage
The contents of the SMS message.
BackendAuthSocialProviderConfig facebook
BackendAuthSocialProviderConfig google
BackendAuthSocialProviderConfig loginWithAmazon
BackendAuthAppleProviderConfig signInWithApple
String limitType
The type of limit that was exceeded.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
BackendAPIResourceConfig resourceConfig
Defines the resource configuration for the data model in your Amplify project.
String resourceName
The name of this resource.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String error
If the request fails, this error is returned.
String jobId
The ID for the job.
String operation
The name of the operation.
String status
The current status of the request.
String deliveryMethod
(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.
EmailSettings emailSettings
(DEPRECATED) The configuration for the email sent when an app user forgets their password.
SmsSettings smsSettings
(DEPRECATED) The configuration for the SMS message sent when an Amplify app user forgets their password.
Boolean unauthenticatedLogin
A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.
String domainPrefix
The Amazon Cognito domain prefix used to create a hosted UI for authentication.
String oAuthGrantType
The OAuth grant type to allow app users to authenticate from your Amplify app.
List<E> oAuthScopes
The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
List<E> redirectSignInURIs
Redirect URLs that OAuth uses when a user signs in to an Amplify app.
List<E> redirectSignOutURIs
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
SocialProviderSettings socialProviderSettings
Describes third-party social federation configurations for allowing your users to sign in with OAuth.
List<E> additionalConstraints
Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.
Double minimumLength
Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
UpdateBackendAuthResourceConfig resourceConfig
The resource configuration for this request object.
String resourceName
The name of this resource.
String authResources
Defines the service name to use when configuring an authentication resource in your Amplify project.
UpdateBackendAuthIdentityPoolConfig identityPoolConfigs
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
String service
Defines the service name to use when configuring an authentication resource in your Amplify project.
UpdateBackendAuthUserPoolConfig userPoolConfigs
Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String error
If the request fails, this error is returned.
String jobId
The ID for the job.
String operation
The name of the operation.
String status
The current status of the request.
UpdateBackendAuthForgotPasswordConfig forgotPassword
(DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
UpdateBackendAuthMFAConfig mfa
Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
UpdateBackendAuthOAuthConfig oAuth
Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
UpdateBackendAuthPasswordPolicyConfig passwordPolicy
Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
UpdateBackendAuthVerificationMessageConfig verificationMessage
Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
String deliveryMethod
The type of verification message to send.
EmailSettings emailSettings
The settings for the email message.
SmsSettings smsSettings
The settings for the SMS message.
String appId
The app ID.
LoginAuthConfigReqObj loginAuthConfig
Describes the Amazon Cognito configuration for Admin UI access.
String appId
The app ID.
String backendManagerAppId
The app ID for the backend manager.
String error
If the request fails, this error is returned.
LoginAuthConfigReqObj loginAuthConfig
Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String jobId
The ID for the job.
String operation
Filters the list of response objects to include only those with the specified operation name.
String status
Filters the list of response objects to include only those with the specified status.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
String createTime
The time when the job was created.
String error
If the request fails, this error is returned.
String jobId
The ID for the job.
String operation
The name of the operation.
String status
The current status of the request.
String updateTime
The time when the job was last updated.
String appId
The app ID.
String backendEnvironmentName
The name of the backend environment.
UpdateBackendStorageResourceConfig resourceConfig
The resource configuration for updating backend storage.
String resourceName
The name of the storage resource.
BackendStoragePermissions permissions
The authorization configuration for the storage S3 bucket.
String serviceName
The name of the storage service.
Copyright © 2025. All rights reserved.