1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942 |
- 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<AmplifyBackend.Types.CloneBackendResponse, AWSError>;
- /**
- * This operation clones an existing backend.
- */
- cloneBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.CloneBackendResponse) => void): Request<AmplifyBackend.Types.CloneBackendResponse, AWSError>;
- /**
- * 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<AmplifyBackend.Types.CreateBackendResponse, AWSError>;
- /**
- * 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<AmplifyBackend.Types.CreateBackendResponse, AWSError>;
- /**
- * Creates a new backend API resource.
- */
- createBackendAPI(params: AmplifyBackend.Types.CreateBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAPIResponse) => void): Request<AmplifyBackend.Types.CreateBackendAPIResponse, AWSError>;
- /**
- * Creates a new backend API resource.
- */
- createBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAPIResponse) => void): Request<AmplifyBackend.Types.CreateBackendAPIResponse, AWSError>;
- /**
- * Creates a new backend authentication resource.
- */
- createBackendAuth(params: AmplifyBackend.Types.CreateBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAuthResponse) => void): Request<AmplifyBackend.Types.CreateBackendAuthResponse, AWSError>;
- /**
- * Creates a new backend authentication resource.
- */
- createBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAuthResponse) => void): Request<AmplifyBackend.Types.CreateBackendAuthResponse, AWSError>;
- /**
- * Creates a config object for a backend.
- */
- createBackendConfig(params: AmplifyBackend.Types.CreateBackendConfigRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendConfigResponse) => void): Request<AmplifyBackend.Types.CreateBackendConfigResponse, AWSError>;
- /**
- * Creates a config object for a backend.
- */
- createBackendConfig(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendConfigResponse) => void): Request<AmplifyBackend.Types.CreateBackendConfigResponse, AWSError>;
- /**
- * Creates a backend storage resource.
- */
- createBackendStorage(params: AmplifyBackend.Types.CreateBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendStorageResponse) => void): Request<AmplifyBackend.Types.CreateBackendStorageResponse, AWSError>;
- /**
- * Creates a backend storage resource.
- */
- createBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendStorageResponse) => void): Request<AmplifyBackend.Types.CreateBackendStorageResponse, AWSError>;
- /**
- * 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<AmplifyBackend.Types.CreateTokenResponse, AWSError>;
- /**
- * 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<AmplifyBackend.Types.CreateTokenResponse, AWSError>;
- /**
- * Removes an existing environment from your Amplify project.
- */
- deleteBackend(params: AmplifyBackend.Types.DeleteBackendRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendResponse) => void): Request<AmplifyBackend.Types.DeleteBackendResponse, AWSError>;
- /**
- * Removes an existing environment from your Amplify project.
- */
- deleteBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendResponse) => void): Request<AmplifyBackend.Types.DeleteBackendResponse, AWSError>;
- /**
- * Deletes an existing backend API resource.
- */
- deleteBackendAPI(params: AmplifyBackend.Types.DeleteBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAPIResponse) => void): Request<AmplifyBackend.Types.DeleteBackendAPIResponse, AWSError>;
- /**
- * Deletes an existing backend API resource.
- */
- deleteBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAPIResponse) => void): Request<AmplifyBackend.Types.DeleteBackendAPIResponse, AWSError>;
- /**
- * Deletes an existing backend authentication resource.
- */
- deleteBackendAuth(params: AmplifyBackend.Types.DeleteBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAuthResponse) => void): Request<AmplifyBackend.Types.DeleteBackendAuthResponse, AWSError>;
- /**
- * Deletes an existing backend authentication resource.
- */
- deleteBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAuthResponse) => void): Request<AmplifyBackend.Types.DeleteBackendAuthResponse, AWSError>;
- /**
- * Removes the specified backend storage resource.
- */
- deleteBackendStorage(params: AmplifyBackend.Types.DeleteBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendStorageResponse) => void): Request<AmplifyBackend.Types.DeleteBackendStorageResponse, AWSError>;
- /**
- * Removes the specified backend storage resource.
- */
- deleteBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendStorageResponse) => void): Request<AmplifyBackend.Types.DeleteBackendStorageResponse, AWSError>;
- /**
- * 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<AmplifyBackend.Types.DeleteTokenResponse, AWSError>;
- /**
- * Deletes the challenge token based on the given appId and sessionId.
- */
- deleteToken(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteTokenResponse) => void): Request<AmplifyBackend.Types.DeleteTokenResponse, AWSError>;
- /**
- * Generates a model schema for an existing backend API resource.
- */
- generateBackendAPIModels(params: AmplifyBackend.Types.GenerateBackendAPIModelsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GenerateBackendAPIModelsResponse) => void): Request<AmplifyBackend.Types.GenerateBackendAPIModelsResponse, AWSError>;
- /**
- * Generates a model schema for an existing backend API resource.
- */
- generateBackendAPIModels(callback?: (err: AWSError, data: AmplifyBackend.Types.GenerateBackendAPIModelsResponse) => void): Request<AmplifyBackend.Types.GenerateBackendAPIModelsResponse, AWSError>;
- /**
- * Provides project-level details for your Amplify UI project.
- */
- getBackend(params: AmplifyBackend.Types.GetBackendRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendResponse) => void): Request<AmplifyBackend.Types.GetBackendResponse, AWSError>;
- /**
- * Provides project-level details for your Amplify UI project.
- */
- getBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendResponse) => void): Request<AmplifyBackend.Types.GetBackendResponse, AWSError>;
- /**
- * Gets the details for a backend API.
- */
- getBackendAPI(params: AmplifyBackend.Types.GetBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIResponse) => void): Request<AmplifyBackend.Types.GetBackendAPIResponse, AWSError>;
- /**
- * Gets the details for a backend API.
- */
- getBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIResponse) => void): Request<AmplifyBackend.Types.GetBackendAPIResponse, AWSError>;
- /**
- * 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<AmplifyBackend.Types.GetBackendAPIModelsResponse, AWSError>;
- /**
- * Gets a model introspection schema for an existing backend API resource.
- */
- getBackendAPIModels(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIModelsResponse) => void): Request<AmplifyBackend.Types.GetBackendAPIModelsResponse, AWSError>;
- /**
- * Gets a backend auth details.
- */
- getBackendAuth(params: AmplifyBackend.Types.GetBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAuthResponse) => void): Request<AmplifyBackend.Types.GetBackendAuthResponse, AWSError>;
- /**
- * Gets a backend auth details.
- */
- getBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAuthResponse) => void): Request<AmplifyBackend.Types.GetBackendAuthResponse, AWSError>;
- /**
- * Returns information about a specific job.
- */
- getBackendJob(params: AmplifyBackend.Types.GetBackendJobRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendJobResponse) => void): Request<AmplifyBackend.Types.GetBackendJobResponse, AWSError>;
- /**
- * Returns information about a specific job.
- */
- getBackendJob(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendJobResponse) => void): Request<AmplifyBackend.Types.GetBackendJobResponse, AWSError>;
- /**
- * Gets details for a backend storage resource.
- */
- getBackendStorage(params: AmplifyBackend.Types.GetBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendStorageResponse) => void): Request<AmplifyBackend.Types.GetBackendStorageResponse, AWSError>;
- /**
- * Gets details for a backend storage resource.
- */
- getBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendStorageResponse) => void): Request<AmplifyBackend.Types.GetBackendStorageResponse, AWSError>;
- /**
- * 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<AmplifyBackend.Types.GetTokenResponse, AWSError>;
- /**
- * Gets the challenge token based on the given appId and sessionId.
- */
- getToken(callback?: (err: AWSError, data: AmplifyBackend.Types.GetTokenResponse) => void): Request<AmplifyBackend.Types.GetTokenResponse, AWSError>;
- /**
- * Imports an existing backend authentication resource.
- */
- importBackendAuth(params: AmplifyBackend.Types.ImportBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.ImportBackendAuthResponse) => void): Request<AmplifyBackend.Types.ImportBackendAuthResponse, AWSError>;
- /**
- * Imports an existing backend authentication resource.
- */
- importBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.ImportBackendAuthResponse) => void): Request<AmplifyBackend.Types.ImportBackendAuthResponse, AWSError>;
- /**
- * Imports an existing backend storage resource.
- */
- importBackendStorage(params: AmplifyBackend.Types.ImportBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.ImportBackendStorageResponse) => void): Request<AmplifyBackend.Types.ImportBackendStorageResponse, AWSError>;
- /**
- * Imports an existing backend storage resource.
- */
- importBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.ImportBackendStorageResponse) => void): Request<AmplifyBackend.Types.ImportBackendStorageResponse, AWSError>;
- /**
- * Lists the jobs for the backend of an Amplify app.
- */
- listBackendJobs(params: AmplifyBackend.Types.ListBackendJobsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.ListBackendJobsResponse) => void): Request<AmplifyBackend.Types.ListBackendJobsResponse, AWSError>;
- /**
- * Lists the jobs for the backend of an Amplify app.
- */
- listBackendJobs(callback?: (err: AWSError, data: AmplifyBackend.Types.ListBackendJobsResponse) => void): Request<AmplifyBackend.Types.ListBackendJobsResponse, AWSError>;
- /**
- * The list of S3 buckets in your account.
- */
- listS3Buckets(params: AmplifyBackend.Types.ListS3BucketsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.ListS3BucketsResponse) => void): Request<AmplifyBackend.Types.ListS3BucketsResponse, AWSError>;
- /**
- * The list of S3 buckets in your account.
- */
- listS3Buckets(callback?: (err: AWSError, data: AmplifyBackend.Types.ListS3BucketsResponse) => void): Request<AmplifyBackend.Types.ListS3BucketsResponse, AWSError>;
- /**
- * Removes all backend environments from your Amplify project.
- */
- removeAllBackends(params: AmplifyBackend.Types.RemoveAllBackendsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveAllBackendsResponse) => void): Request<AmplifyBackend.Types.RemoveAllBackendsResponse, AWSError>;
- /**
- * Removes all backend environments from your Amplify project.
- */
- removeAllBackends(callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveAllBackendsResponse) => void): Request<AmplifyBackend.Types.RemoveAllBackendsResponse, AWSError>;
- /**
- * 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<AmplifyBackend.Types.RemoveBackendConfigResponse, AWSError>;
- /**
- * Removes the AWS resources required to access the Amplify Admin UI.
- */
- removeBackendConfig(callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveBackendConfigResponse) => void): Request<AmplifyBackend.Types.RemoveBackendConfigResponse, AWSError>;
- /**
- * Updates an existing backend API resource.
- */
- updateBackendAPI(params: AmplifyBackend.Types.UpdateBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAPIResponse) => void): Request<AmplifyBackend.Types.UpdateBackendAPIResponse, AWSError>;
- /**
- * Updates an existing backend API resource.
- */
- updateBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAPIResponse) => void): Request<AmplifyBackend.Types.UpdateBackendAPIResponse, AWSError>;
- /**
- * Updates an existing backend authentication resource.
- */
- updateBackendAuth(params: AmplifyBackend.Types.UpdateBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAuthResponse) => void): Request<AmplifyBackend.Types.UpdateBackendAuthResponse, AWSError>;
- /**
- * Updates an existing backend authentication resource.
- */
- updateBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAuthResponse) => void): Request<AmplifyBackend.Types.UpdateBackendAuthResponse, AWSError>;
- /**
- * 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<AmplifyBackend.Types.UpdateBackendConfigResponse, AWSError>;
- /**
- * Updates the AWS resources required to access the Amplify Admin UI.
- */
- updateBackendConfig(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendConfigResponse) => void): Request<AmplifyBackend.Types.UpdateBackendConfigResponse, AWSError>;
- /**
- * Updates a specific job.
- */
- updateBackendJob(params: AmplifyBackend.Types.UpdateBackendJobRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendJobResponse) => void): Request<AmplifyBackend.Types.UpdateBackendJobResponse, AWSError>;
- /**
- * Updates a specific job.
- */
- updateBackendJob(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendJobResponse) => void): Request<AmplifyBackend.Types.UpdateBackendJobResponse, AWSError>;
- /**
- * Updates an existing backend storage resource.
- */
- updateBackendStorage(params: AmplifyBackend.Types.UpdateBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendStorageResponse) => void): Request<AmplifyBackend.Types.UpdateBackendStorageResponse, AWSError>;
- /**
- * Updates an existing backend storage resource.
- */
- updateBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendStorageResponse) => void): Request<AmplifyBackend.Types.UpdateBackendStorageResponse, AWSError>;
- }
- 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;
|