import {Request} from '../lib/request'; import {Response} from '../lib/response'; import {AWSError} from '../lib/error'; import {Service} from '../lib/service'; import {ServiceConfigurationOptions} from '../lib/service'; import {ConfigBase as Config} from '../lib/config-base'; interface Blob {} declare class AmplifyBackend extends Service { /** * Constructs a service object. This object has one method for each API operation. */ constructor(options?: AmplifyBackend.Types.ClientConfiguration) config: Config & AmplifyBackend.Types.ClientConfiguration; /** * This operation clones an existing backend. */ cloneBackend(params: AmplifyBackend.Types.CloneBackendRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CloneBackendResponse) => void): Request; /** * This operation clones an existing backend. */ cloneBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.CloneBackendResponse) => void): Request; /** * This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation. */ createBackend(params: AmplifyBackend.Types.CreateBackendRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendResponse) => void): Request; /** * This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation. */ createBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendResponse) => void): Request; /** * Creates a new backend API resource. */ createBackendAPI(params: AmplifyBackend.Types.CreateBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAPIResponse) => void): Request; /** * Creates a new backend API resource. */ createBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAPIResponse) => void): Request; /** * Creates a new backend authentication resource. */ createBackendAuth(params: AmplifyBackend.Types.CreateBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAuthResponse) => void): Request; /** * Creates a new backend authentication resource. */ createBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAuthResponse) => void): Request; /** * Creates a config object for a backend. */ createBackendConfig(params: AmplifyBackend.Types.CreateBackendConfigRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendConfigResponse) => void): Request; /** * Creates a config object for a backend. */ createBackendConfig(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendConfigResponse) => void): Request; /** * Creates a backend storage resource. */ createBackendStorage(params: AmplifyBackend.Types.CreateBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendStorageResponse) => void): Request; /** * Creates a backend storage resource. */ createBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendStorageResponse) => void): Request; /** * Generates a one-time challenge code to authenticate a user into your Amplify Admin UI. */ createToken(params: AmplifyBackend.Types.CreateTokenRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateTokenResponse) => void): Request; /** * Generates a one-time challenge code to authenticate a user into your Amplify Admin UI. */ createToken(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateTokenResponse) => void): Request; /** * Removes an existing environment from your Amplify project. */ deleteBackend(params: AmplifyBackend.Types.DeleteBackendRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendResponse) => void): Request; /** * Removes an existing environment from your Amplify project. */ deleteBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendResponse) => void): Request; /** * Deletes an existing backend API resource. */ deleteBackendAPI(params: AmplifyBackend.Types.DeleteBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAPIResponse) => void): Request; /** * Deletes an existing backend API resource. */ deleteBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAPIResponse) => void): Request; /** * Deletes an existing backend authentication resource. */ deleteBackendAuth(params: AmplifyBackend.Types.DeleteBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAuthResponse) => void): Request; /** * Deletes an existing backend authentication resource. */ deleteBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAuthResponse) => void): Request; /** * Removes the specified backend storage resource. */ deleteBackendStorage(params: AmplifyBackend.Types.DeleteBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendStorageResponse) => void): Request; /** * Removes the specified backend storage resource. */ deleteBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendStorageResponse) => void): Request; /** * Deletes the challenge token based on the given appId and sessionId. */ deleteToken(params: AmplifyBackend.Types.DeleteTokenRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteTokenResponse) => void): Request; /** * Deletes the challenge token based on the given appId and sessionId. */ deleteToken(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteTokenResponse) => void): Request; /** * Generates a model schema for an existing backend API resource. */ generateBackendAPIModels(params: AmplifyBackend.Types.GenerateBackendAPIModelsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GenerateBackendAPIModelsResponse) => void): Request; /** * Generates a model schema for an existing backend API resource. */ generateBackendAPIModels(callback?: (err: AWSError, data: AmplifyBackend.Types.GenerateBackendAPIModelsResponse) => void): Request; /** * Provides project-level details for your Amplify UI project. */ getBackend(params: AmplifyBackend.Types.GetBackendRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendResponse) => void): Request; /** * Provides project-level details for your Amplify UI project. */ getBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendResponse) => void): Request; /** * Gets the details for a backend API. */ getBackendAPI(params: AmplifyBackend.Types.GetBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIResponse) => void): Request; /** * Gets the details for a backend API. */ getBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIResponse) => void): Request; /** * Gets a model introspection schema for an existing backend API resource. */ getBackendAPIModels(params: AmplifyBackend.Types.GetBackendAPIModelsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIModelsResponse) => void): Request; /** * Gets a model introspection schema for an existing backend API resource. */ getBackendAPIModels(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIModelsResponse) => void): Request; /** * Gets a backend auth details. */ getBackendAuth(params: AmplifyBackend.Types.GetBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAuthResponse) => void): Request; /** * Gets a backend auth details. */ getBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAuthResponse) => void): Request; /** * Returns information about a specific job. */ getBackendJob(params: AmplifyBackend.Types.GetBackendJobRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendJobResponse) => void): Request; /** * Returns information about a specific job. */ getBackendJob(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendJobResponse) => void): Request; /** * Gets details for a backend storage resource. */ getBackendStorage(params: AmplifyBackend.Types.GetBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendStorageResponse) => void): Request; /** * Gets details for a backend storage resource. */ getBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendStorageResponse) => void): Request; /** * Gets the challenge token based on the given appId and sessionId. */ getToken(params: AmplifyBackend.Types.GetTokenRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetTokenResponse) => void): Request; /** * Gets the challenge token based on the given appId and sessionId. */ getToken(callback?: (err: AWSError, data: AmplifyBackend.Types.GetTokenResponse) => void): Request; /** * Imports an existing backend authentication resource. */ importBackendAuth(params: AmplifyBackend.Types.ImportBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.ImportBackendAuthResponse) => void): Request; /** * Imports an existing backend authentication resource. */ importBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.ImportBackendAuthResponse) => void): Request; /** * Imports an existing backend storage resource. */ importBackendStorage(params: AmplifyBackend.Types.ImportBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.ImportBackendStorageResponse) => void): Request; /** * Imports an existing backend storage resource. */ importBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.ImportBackendStorageResponse) => void): Request; /** * Lists the jobs for the backend of an Amplify app. */ listBackendJobs(params: AmplifyBackend.Types.ListBackendJobsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.ListBackendJobsResponse) => void): Request; /** * Lists the jobs for the backend of an Amplify app. */ listBackendJobs(callback?: (err: AWSError, data: AmplifyBackend.Types.ListBackendJobsResponse) => void): Request; /** * The list of S3 buckets in your account. */ listS3Buckets(params: AmplifyBackend.Types.ListS3BucketsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.ListS3BucketsResponse) => void): Request; /** * The list of S3 buckets in your account. */ listS3Buckets(callback?: (err: AWSError, data: AmplifyBackend.Types.ListS3BucketsResponse) => void): Request; /** * Removes all backend environments from your Amplify project. */ removeAllBackends(params: AmplifyBackend.Types.RemoveAllBackendsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveAllBackendsResponse) => void): Request; /** * Removes all backend environments from your Amplify project. */ removeAllBackends(callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveAllBackendsResponse) => void): Request; /** * Removes the AWS resources required to access the Amplify Admin UI. */ removeBackendConfig(params: AmplifyBackend.Types.RemoveBackendConfigRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveBackendConfigResponse) => void): Request; /** * Removes the AWS resources required to access the Amplify Admin UI. */ removeBackendConfig(callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveBackendConfigResponse) => void): Request; /** * Updates an existing backend API resource. */ updateBackendAPI(params: AmplifyBackend.Types.UpdateBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAPIResponse) => void): Request; /** * Updates an existing backend API resource. */ updateBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAPIResponse) => void): Request; /** * Updates an existing backend authentication resource. */ updateBackendAuth(params: AmplifyBackend.Types.UpdateBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAuthResponse) => void): Request; /** * Updates an existing backend authentication resource. */ updateBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAuthResponse) => void): Request; /** * Updates the AWS resources required to access the Amplify Admin UI. */ updateBackendConfig(params: AmplifyBackend.Types.UpdateBackendConfigRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendConfigResponse) => void): Request; /** * Updates the AWS resources required to access the Amplify Admin UI. */ updateBackendConfig(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendConfigResponse) => void): Request; /** * Updates a specific job. */ updateBackendJob(params: AmplifyBackend.Types.UpdateBackendJobRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendJobResponse) => void): Request; /** * Updates a specific job. */ updateBackendJob(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendJobResponse) => void): Request; /** * Updates an existing backend storage resource. */ updateBackendStorage(params: AmplifyBackend.Types.UpdateBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendStorageResponse) => void): Request; /** * Updates an existing backend storage resource. */ updateBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendStorageResponse) => void): Request; } declare namespace AmplifyBackend { export type AuthResources = "USER_POOL_ONLY"|"IDENTITY_POOL_AND_USER_POOL"|string; export interface BackendAPIAppSyncAuthSettings { /** * The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models. */ CognitoUserPoolId?: __string; /** * The API key description for API_KEY, if it was used as an authentication mechanism to access your data models. */ Description?: __string; /** * The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models. */ ExpirationTime?: __double; /** * The expiry time for the OpenID authentication mechanism. */ OpenIDAuthTTL?: __string; /** * The clientID for openID, if openID was used as an authentication setting to access your data models. */ OpenIDClientId?: __string; /** * The expiry time for the OpenID authentication mechanism. */ OpenIDIatTTL?: __string; /** * The openID issuer URL, if openID was used as an authentication setting to access your data models. */ OpenIDIssueURL?: __string; /** * The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models. */ OpenIDProviderName?: __string; } export interface BackendAPIAuthType { /** * Describes the authentication mode. */ Mode?: Mode; /** * Describes settings for the authentication mode. */ Settings?: BackendAPIAppSyncAuthSettings; } export interface BackendAPIConflictResolution { /** * The strategy for conflict resolution. */ ResolutionStrategy?: ResolutionStrategy; } export interface BackendAPIResourceConfig { /** * Additional authentication methods used to interact with your data models. */ AdditionalAuthTypes?: ListOfBackendAPIAuthType; /** * The API name used to interact with the data model, configured as a part of your Amplify project. */ ApiName?: __string; /** * The conflict resolution strategy for your data stored in the data models. */ ConflictResolution?: BackendAPIConflictResolution; /** * The default authentication type for interacting with the configured data models in your Amplify project. */ DefaultAuthType?: BackendAPIAuthType; /** * The service used to provision and interact with the data model. */ Service?: __string; /** * The definition of the data model in the annotated transform of the GraphQL schema. */ TransformSchema?: __string; } export interface BackendAuthAppleProviderConfig { /** * Describes the client_id (also called Services ID) that comes from Apple. */ ClientId?: __string; /** * Describes the key_id that comes from Apple. */ KeyId?: __string; /** * Describes the private_key that comes from Apple. */ PrivateKey?: __string; /** * Describes the team_id that comes from Apple. */ TeamId?: __string; } export interface BackendAuthSocialProviderConfig { /** * Describes the client_id, which can be obtained from the third-party social federation provider. */ ClientId?: __string; /** * Describes the client_secret, which can be obtained from third-party social federation providers. */ ClientSecret?: __string; } export interface BackendJobRespObj { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The time when the job was created. */ CreateTime?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; /** * The time when the job was last updated. */ UpdateTime?: __string; } export interface BackendStoragePermissions { /** * Lists all authenticated user read, write, and delete permissions for your S3 bucket. */ Authenticated: ListOfAuthenticatedElement; /** * Lists all unauthenticated user read, write, and delete permissions for your S3 bucket. */ UnAuthenticated?: ListOfUnAuthenticatedElement; } export interface CloneBackendRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The name of the destination backend environment to be created. */ TargetEnvironmentName: __string; } export interface CloneBackendResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; } export interface CreateBackendAPIRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The resource configuration for this request. */ ResourceConfig: BackendAPIResourceConfig; /** * The name of this resource. */ ResourceName: __string; } export interface CreateBackendAPIResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; } export interface CreateBackendAuthForgotPasswordConfig { /** * (DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password. */ DeliveryMethod: DeliveryMethod; /** * (DEPRECATED) The configuration for the email sent when an app user forgets their password. */ EmailSettings?: EmailSettings; /** * (DEPRECATED) The configuration for the SMS message sent when an app user forgets their password. */ SmsSettings?: SmsSettings; } export interface CreateBackendAuthIdentityPoolConfig { /** * Name of the Amazon Cognito identity pool used for authorization. */ IdentityPoolName: __string; /** * Set to true or false based on whether you want to enable guest authorization to your Amplify app. */ UnauthenticatedLogin: __boolean; } export interface CreateBackendAuthMFAConfig { /** * Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project. */ MFAMode: MFAMode; /** * Describes the configuration settings and methods for your Amplify app users to use MFA. */ Settings?: Settings; } export interface CreateBackendAuthOAuthConfig { /** * The domain prefix for your Amplify app. */ DomainPrefix?: __string; /** * The OAuth grant type that you use to allow app users to authenticate from your Amplify app. */ OAuthGrantType: OAuthGrantType; /** * List of OAuth-related flows used to allow your app users to authenticate from your Amplify app. */ OAuthScopes: ListOfOAuthScopesElement; /** * The redirected URI for signing in to your Amplify app. */ RedirectSignInURIs: ListOf__string; /** * Redirect URLs that OAuth uses when a user signs out of an Amplify app. */ RedirectSignOutURIs: ListOf__string; /** * The settings for using social providers to access your Amplify app. */ SocialProviderSettings?: SocialProviderSettings; } export interface CreateBackendAuthPasswordPolicyConfig { /** * Additional constraints for the password used to access the backend of your Amplify project. */ AdditionalConstraints?: ListOfAdditionalConstraintsElement; /** * The minimum length of the password used to access the backend of your Amplify project. */ MinimumLength: __double; } export interface CreateBackendAuthRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The resource configuration for this request object. */ ResourceConfig: CreateBackendAuthResourceConfig; /** * The name of this resource. */ ResourceName: __string; } export interface CreateBackendAuthResourceConfig { /** * Defines whether you want to configure only authentication or both authentication and authorization settings. */ AuthResources: AuthResources; /** * Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project. */ IdentityPoolConfigs?: CreateBackendAuthIdentityPoolConfig; /** * Defines the service name to use when configuring an authentication resource in your Amplify project. */ Service: Service; /** * Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project. */ UserPoolConfigs: CreateBackendAuthUserPoolConfig; } export interface CreateBackendAuthResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; } export interface CreateBackendAuthUserPoolConfig { /** * (DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project. */ ForgotPassword?: CreateBackendAuthForgotPasswordConfig; /** * Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project. */ Mfa?: CreateBackendAuthMFAConfig; /** * Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project. */ OAuth?: CreateBackendAuthOAuthConfig; /** * Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project. */ PasswordPolicy?: CreateBackendAuthPasswordPolicyConfig; /** * The required attributes to sign up new users in the user pool. */ RequiredSignUpAttributes: ListOfRequiredSignUpAttributesElement; /** * 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. */ SignInMethod: SignInMethod; /** * The Amazon Cognito user pool name. */ UserPoolName: __string; /** * Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project. */ VerificationMessage?: CreateBackendAuthVerificationMessageConfig; } export interface CreateBackendAuthVerificationMessageConfig { /** * The type of verification message to send. */ DeliveryMethod: DeliveryMethod; /** * The settings for the email message. */ EmailSettings?: EmailSettings; /** * The settings for the SMS message. */ SmsSettings?: SmsSettings; } export interface CreateBackendConfigRequest { /** * The app ID. */ AppId: __string; /** * The app ID for the backend manager. */ BackendManagerAppId?: __string; } export interface CreateBackendConfigResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * The ID for the job. */ JobId?: __string; /** * The current status of the request. */ Status?: __string; } export interface CreateBackendRequest { /** * The app ID. */ AppId: __string; /** * The name of the app. */ AppName: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The resource configuration for creating a backend. */ ResourceConfig?: ResourceConfig; /** * The name of the resource. */ ResourceName?: __string; } export interface CreateBackendResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; } export interface CreateBackendStorageRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The resource configuration for creating backend storage. */ ResourceConfig: CreateBackendStorageResourceConfig; /** * The name of the storage resource. */ ResourceName: __string; } export interface CreateBackendStorageResourceConfig { /** * The name of the S3 bucket. */ BucketName?: __string; /** * The authorization configuration for the storage S3 bucket. */ Permissions: BackendStoragePermissions; /** * The name of the storage service. */ ServiceName: ServiceName; } export interface CreateBackendStorageResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * The ID for the job. */ JobId?: __string; /** * The current status of the request. */ Status?: __string; } export interface CreateTokenRequest { /** * The app ID. */ AppId: __string; } export interface CreateTokenResponse { /** * The app ID. */ AppId?: __string; /** * One-time challenge code for authenticating into the Amplify Admin UI. */ ChallengeCode?: __string; /** * A unique ID provided when creating a new challenge token. */ SessionId?: __string; /** * The expiry time for the one-time generated token code. */ Ttl?: __string; } export interface DeleteBackendAPIRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * Defines the resource configuration for the data model in your Amplify project. */ ResourceConfig?: BackendAPIResourceConfig; /** * The name of this resource. */ ResourceName: __string; } export interface DeleteBackendAPIResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; } export interface DeleteBackendAuthRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The name of this resource. */ ResourceName: __string; } export interface DeleteBackendAuthResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; } export interface DeleteBackendRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; } export interface DeleteBackendResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; } export interface DeleteBackendStorageRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The name of the storage resource. */ ResourceName: __string; /** * The name of the storage service. */ ServiceName: ServiceName; } export interface DeleteBackendStorageResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * The ID for the job. */ JobId?: __string; /** * The current status of the request. */ Status?: __string; } export interface DeleteTokenRequest { /** * The app ID. */ AppId: __string; /** * The session ID. */ SessionId: __string; } export interface DeleteTokenResponse { /** * Indicates whether the request succeeded or failed. */ IsSuccess?: __boolean; } export type DeliveryMethod = "EMAIL"|"SMS"|string; export interface EmailSettings { /** * The contents of the email message. */ EmailMessage?: __string; /** * The contents of the subject line of the email message. */ EmailSubject?: __string; } export interface GenerateBackendAPIModelsRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The name of this resource. */ ResourceName: __string; } export interface GenerateBackendAPIModelsResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; } export interface GetBackendAPIModelsRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The name of this resource. */ ResourceName: __string; } export interface GetBackendAPIModelsResponse { /** * Stringified JSON of the datastore model. */ Models?: __string; /** * The current status of the request. */ Status?: Status; /** * Stringified JSON of the model introspection schema for an existing backend API resource. */ ModelIntrospectionSchema?: __string; } export interface GetBackendAPIRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * Defines the resource configuration for the data model in your Amplify project. */ ResourceConfig?: BackendAPIResourceConfig; /** * The name of this resource. */ ResourceName: __string; } export interface GetBackendAPIResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The resource configuration for this response object. */ ResourceConfig?: BackendAPIResourceConfig; /** * The name of this resource. */ ResourceName?: __string; } export interface GetBackendAuthRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The name of this resource. */ ResourceName: __string; } export interface GetBackendAuthResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The resource configuration for authorization requests to the backend of your Amplify project. */ ResourceConfig?: CreateBackendAuthResourceConfig; /** * The name of this resource. */ ResourceName?: __string; } export interface GetBackendJobRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The ID for the job. */ JobId: __string; } export interface GetBackendJobResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * The time when the job was created. */ CreateTime?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; /** * The time when the job was last updated. */ UpdateTime?: __string; } export interface GetBackendRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; } export interface GetBackendResponse { /** * A stringified version of the cli.json file for your Amplify project. */ AmplifyFeatureFlags?: __string; /** * A stringified version of the current configs for your Amplify project. */ AmplifyMetaConfig?: __string; /** * The app ID. */ AppId?: __string; /** * The name of the app. */ AppName?: __string; /** * A list of backend environments in an array. */ BackendEnvironmentList?: ListOf__string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * If the request failed, this is the returned error. */ Error?: __string; } export interface GetBackendStorageRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The name of the storage resource. */ ResourceName: __string; } export interface GetBackendStorageResourceConfig { /** * The name of the S3 bucket. */ BucketName?: __string; /** * Returns True if the storage resource has been imported. */ Imported: __boolean; /** * The authorization configuration for the storage S3 bucket. */ Permissions?: BackendStoragePermissions; /** * The name of the storage service. */ ServiceName: ServiceName; } export interface GetBackendStorageResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * The resource configuration for the backend storage resource. */ ResourceConfig?: GetBackendStorageResourceConfig; /** * The name of the storage resource. */ ResourceName?: __string; } export interface GetTokenRequest { /** * The app ID. */ AppId: __string; /** * The session ID. */ SessionId: __string; } export interface GetTokenResponse { /** * The app ID. */ AppId?: __string; /** * The one-time challenge code for authenticating into the Amplify Admin UI. */ ChallengeCode?: __string; /** * A unique ID provided when creating a new challenge token. */ SessionId?: __string; /** * The expiry time for the one-time generated token code. */ Ttl?: __string; } export interface ImportBackendAuthRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The ID of the Amazon Cognito identity pool. */ IdentityPoolId?: __string; /** * The ID of the Amazon Cognito native client. */ NativeClientId: __string; /** * The ID of the Amazon Cognito user pool. */ UserPoolId: __string; /** * The ID of the Amazon Cognito web client. */ WebClientId: __string; } export interface ImportBackendAuthResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; } export interface ImportBackendStorageRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The name of the S3 bucket. */ BucketName?: __string; /** * The name of the storage service. */ ServiceName: ServiceName; } export interface ImportBackendStorageResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * The ID for the job. */ JobId?: __string; /** * The current status of the request. */ Status?: __string; } export interface ListBackendJobsRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The ID for the job. */ JobId?: __string; /** * The maximum number of results that you want in the response. */ MaxResults?: __integerMin1Max25; /** * The token for the next set of results. */ NextToken?: __string; /** * Filters the list of response objects to include only those with the specified operation name. */ Operation?: __string; /** * Filters the list of response objects to include only those with the specified status. */ Status?: __string; } export interface ListBackendJobsResponse { /** * An array of jobs and their properties. */ Jobs?: ListOfBackendJobRespObj; /** * The token for the next set of results. */ NextToken?: __string; } export interface ListS3BucketsRequest { /** * Reserved for future use. */ NextToken?: __string; } export interface ListS3BucketsResponse { /** * The list of S3 buckets. */ Buckets?: ListOfS3BucketInfo; /** * Reserved for future use. */ NextToken?: __string; } export interface LoginAuthConfigReqObj { /** * The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization. */ AwsCognitoIdentityPoolId?: __string; /** * The AWS Region for the Amplify Admin UI login. */ AwsCognitoRegion?: __string; /** * The Amazon Cognito user pool ID used for Amplify Admin UI login authentication. */ AwsUserPoolsId?: __string; /** * The web client ID for the Amazon Cognito user pools. */ AwsUserPoolsWebClientId?: __string; } export type MFAMode = "ON"|"OFF"|"OPTIONAL"|string; export type Mode = "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|string; export type OAuthGrantType = "CODE"|"IMPLICIT"|string; export interface RemoveAllBackendsRequest { /** * The app ID. */ AppId: __string; /** * Cleans up the Amplify Console app if this value is set to true. */ CleanAmplifyApp?: __boolean; } export interface RemoveAllBackendsResponse { /** * The app ID. */ AppId?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; } export interface RemoveBackendConfigRequest { /** * The app ID. */ AppId: __string; } export interface RemoveBackendConfigResponse { /** * If the request fails, this error is returned. */ Error?: __string; } export type ResolutionStrategy = "OPTIMISTIC_CONCURRENCY"|"LAMBDA"|"AUTOMERGE"|"NONE"|string; export interface ResourceConfig { } export interface S3BucketInfo { /** * The creation date of the S3 bucket. */ CreationDate?: __string; /** * The name of the S3 bucket. */ Name?: __string; } export type Service = "COGNITO"|string; export type ServiceName = "S3"|string; export interface Settings { /** * The supported MFA types. */ MfaTypes?: ListOfMfaTypesElement; /** * The body of the SMS message. */ SmsMessage?: __string; } export type SignInMethod = "EMAIL"|"EMAIL_AND_PHONE_NUMBER"|"PHONE_NUMBER"|"USERNAME"|string; export interface SmsSettings { /** * The contents of the SMS message. */ SmsMessage?: __string; } export interface SocialProviderSettings { Facebook?: BackendAuthSocialProviderConfig; Google?: BackendAuthSocialProviderConfig; LoginWithAmazon?: BackendAuthSocialProviderConfig; SignInWithApple?: BackendAuthAppleProviderConfig; } export type Status = "LATEST"|"STALE"|string; export interface UpdateBackendAPIRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * Defines the resource configuration for the data model in your Amplify project. */ ResourceConfig?: BackendAPIResourceConfig; /** * The name of this resource. */ ResourceName: __string; } export interface UpdateBackendAPIResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; } export interface UpdateBackendAuthForgotPasswordConfig { /** * (DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password. */ DeliveryMethod?: DeliveryMethod; /** * (DEPRECATED) The configuration for the email sent when an app user forgets their password. */ EmailSettings?: EmailSettings; /** * (DEPRECATED) The configuration for the SMS message sent when an Amplify app user forgets their password. */ SmsSettings?: SmsSettings; } export interface UpdateBackendAuthIdentityPoolConfig { /** * A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app. */ UnauthenticatedLogin?: __boolean; } export interface UpdateBackendAuthMFAConfig { /** * The MFA mode for the backend of your Amplify project. */ MFAMode?: MFAMode; /** * The settings of your MFA configuration for the backend of your Amplify project. */ Settings?: Settings; } export interface UpdateBackendAuthOAuthConfig { /** * The Amazon Cognito domain prefix used to create a hosted UI for authentication. */ DomainPrefix?: __string; /** * The OAuth grant type to allow app users to authenticate from your Amplify app. */ OAuthGrantType?: OAuthGrantType; /** * The list of OAuth-related flows that can allow users to authenticate from your Amplify app. */ OAuthScopes?: ListOfOAuthScopesElement; /** * Redirect URLs that OAuth uses when a user signs in to an Amplify app. */ RedirectSignInURIs?: ListOf__string; /** * Redirect URLs that OAuth uses when a user signs out of an Amplify app. */ RedirectSignOutURIs?: ListOf__string; /** * Describes third-party social federation configurations for allowing your users to sign in with OAuth. */ SocialProviderSettings?: SocialProviderSettings; } export interface UpdateBackendAuthPasswordPolicyConfig { /** * Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project. */ AdditionalConstraints?: ListOfAdditionalConstraintsElement; /** * Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project. */ MinimumLength?: __double; } export interface UpdateBackendAuthRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The resource configuration for this request object. */ ResourceConfig: UpdateBackendAuthResourceConfig; /** * The name of this resource. */ ResourceName: __string; } export interface UpdateBackendAuthResourceConfig { /** * Defines the service name to use when configuring an authentication resource in your Amplify project. */ AuthResources: AuthResources; /** * Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project. */ IdentityPoolConfigs?: UpdateBackendAuthIdentityPoolConfig; /** * Defines the service name to use when configuring an authentication resource in your Amplify project. */ Service: Service; /** * Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project. */ UserPoolConfigs: UpdateBackendAuthUserPoolConfig; } export interface UpdateBackendAuthResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; } export interface UpdateBackendAuthUserPoolConfig { /** * (DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project. */ ForgotPassword?: UpdateBackendAuthForgotPasswordConfig; /** * Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project. */ Mfa?: UpdateBackendAuthMFAConfig; /** * Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project. */ OAuth?: UpdateBackendAuthOAuthConfig; /** * Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project. */ PasswordPolicy?: UpdateBackendAuthPasswordPolicyConfig; /** * Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project. */ VerificationMessage?: UpdateBackendAuthVerificationMessageConfig; } export interface UpdateBackendAuthVerificationMessageConfig { /** * The type of verification message to send. */ DeliveryMethod: DeliveryMethod; /** * The settings for the email message. */ EmailSettings?: EmailSettings; /** * The settings for the SMS message. */ SmsSettings?: SmsSettings; } export interface UpdateBackendConfigRequest { /** * The app ID. */ AppId: __string; /** * Describes the Amazon Cognito configuration for Admin UI access. */ LoginAuthConfig?: LoginAuthConfigReqObj; } export interface UpdateBackendConfigResponse { /** * The app ID. */ AppId?: __string; /** * The app ID for the backend manager. */ BackendManagerAppId?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with. */ LoginAuthConfig?: LoginAuthConfigReqObj; } export interface UpdateBackendJobRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The ID for the job. */ JobId: __string; /** * Filters the list of response objects to include only those with the specified operation name. */ Operation?: __string; /** * Filters the list of response objects to include only those with the specified status. */ Status?: __string; } export interface UpdateBackendJobResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * The time when the job was created. */ CreateTime?: __string; /** * If the request fails, this error is returned. */ Error?: __string; /** * The ID for the job. */ JobId?: __string; /** * The name of the operation. */ Operation?: __string; /** * The current status of the request. */ Status?: __string; /** * The time when the job was last updated. */ UpdateTime?: __string; } export interface UpdateBackendStorageRequest { /** * The app ID. */ AppId: __string; /** * The name of the backend environment. */ BackendEnvironmentName: __string; /** * The resource configuration for updating backend storage. */ ResourceConfig: UpdateBackendStorageResourceConfig; /** * The name of the storage resource. */ ResourceName: __string; } export interface UpdateBackendStorageResourceConfig { /** * The authorization configuration for the storage S3 bucket. */ Permissions: BackendStoragePermissions; /** * The name of the storage service. */ ServiceName: ServiceName; } export interface UpdateBackendStorageResponse { /** * The app ID. */ AppId?: __string; /** * The name of the backend environment. */ BackendEnvironmentName?: __string; /** * The ID for the job. */ JobId?: __string; /** * The current status of the request. */ Status?: __string; } export type AdditionalConstraintsElement = "REQUIRE_DIGIT"|"REQUIRE_LOWERCASE"|"REQUIRE_SYMBOL"|"REQUIRE_UPPERCASE"|string; export type AuthenticatedElement = "READ"|"CREATE_AND_UPDATE"|"DELETE"|string; export type MfaTypesElement = "SMS"|"TOTP"|string; export type OAuthScopesElement = "PHONE"|"EMAIL"|"OPENID"|"PROFILE"|"AWS_COGNITO_SIGNIN_USER_ADMIN"|string; export type RequiredSignUpAttributesElement = "ADDRESS"|"BIRTHDATE"|"EMAIL"|"FAMILY_NAME"|"GENDER"|"GIVEN_NAME"|"LOCALE"|"MIDDLE_NAME"|"NAME"|"NICKNAME"|"PHONE_NUMBER"|"PICTURE"|"PREFERRED_USERNAME"|"PROFILE"|"UPDATED_AT"|"WEBSITE"|"ZONE_INFO"|string; export type UnAuthenticatedElement = "READ"|"CREATE_AND_UPDATE"|"DELETE"|string; export type __boolean = boolean; export type __double = number; export type __integerMin1Max25 = number; export type ListOfBackendAPIAuthType = BackendAPIAuthType[]; export type ListOfBackendJobRespObj = BackendJobRespObj[]; export type ListOfS3BucketInfo = S3BucketInfo[]; export type ListOfAdditionalConstraintsElement = AdditionalConstraintsElement[]; export type ListOfAuthenticatedElement = AuthenticatedElement[]; export type ListOfMfaTypesElement = MfaTypesElement[]; export type ListOfOAuthScopesElement = OAuthScopesElement[]; export type ListOfRequiredSignUpAttributesElement = RequiredSignUpAttributesElement[]; export type ListOfUnAuthenticatedElement = UnAuthenticatedElement[]; export type ListOf__string = __string[]; export type __string = string; /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ export type apiVersion = "2020-08-11"|"latest"|string; export interface ClientApiVersions { /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ apiVersion?: apiVersion; } export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; /** * Contains interfaces for use with the AmplifyBackend client. */ export import Types = AmplifyBackend; } export = AmplifyBackend;