amplifybackend.d.ts 60 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class AmplifyBackend extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: AmplifyBackend.Types.ClientConfiguration)
  13. config: Config & AmplifyBackend.Types.ClientConfiguration;
  14. /**
  15. * This operation clones an existing backend.
  16. */
  17. cloneBackend(params: AmplifyBackend.Types.CloneBackendRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CloneBackendResponse) => void): Request<AmplifyBackend.Types.CloneBackendResponse, AWSError>;
  18. /**
  19. * This operation clones an existing backend.
  20. */
  21. cloneBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.CloneBackendResponse) => void): Request<AmplifyBackend.Types.CloneBackendResponse, AWSError>;
  22. /**
  23. * This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.
  24. */
  25. createBackend(params: AmplifyBackend.Types.CreateBackendRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendResponse) => void): Request<AmplifyBackend.Types.CreateBackendResponse, AWSError>;
  26. /**
  27. * This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.
  28. */
  29. createBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendResponse) => void): Request<AmplifyBackend.Types.CreateBackendResponse, AWSError>;
  30. /**
  31. * Creates a new backend API resource.
  32. */
  33. createBackendAPI(params: AmplifyBackend.Types.CreateBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAPIResponse) => void): Request<AmplifyBackend.Types.CreateBackendAPIResponse, AWSError>;
  34. /**
  35. * Creates a new backend API resource.
  36. */
  37. createBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAPIResponse) => void): Request<AmplifyBackend.Types.CreateBackendAPIResponse, AWSError>;
  38. /**
  39. * Creates a new backend authentication resource.
  40. */
  41. createBackendAuth(params: AmplifyBackend.Types.CreateBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAuthResponse) => void): Request<AmplifyBackend.Types.CreateBackendAuthResponse, AWSError>;
  42. /**
  43. * Creates a new backend authentication resource.
  44. */
  45. createBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendAuthResponse) => void): Request<AmplifyBackend.Types.CreateBackendAuthResponse, AWSError>;
  46. /**
  47. * Creates a config object for a backend.
  48. */
  49. createBackendConfig(params: AmplifyBackend.Types.CreateBackendConfigRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendConfigResponse) => void): Request<AmplifyBackend.Types.CreateBackendConfigResponse, AWSError>;
  50. /**
  51. * Creates a config object for a backend.
  52. */
  53. createBackendConfig(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendConfigResponse) => void): Request<AmplifyBackend.Types.CreateBackendConfigResponse, AWSError>;
  54. /**
  55. * Creates a backend storage resource.
  56. */
  57. createBackendStorage(params: AmplifyBackend.Types.CreateBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendStorageResponse) => void): Request<AmplifyBackend.Types.CreateBackendStorageResponse, AWSError>;
  58. /**
  59. * Creates a backend storage resource.
  60. */
  61. createBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateBackendStorageResponse) => void): Request<AmplifyBackend.Types.CreateBackendStorageResponse, AWSError>;
  62. /**
  63. * Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
  64. */
  65. createToken(params: AmplifyBackend.Types.CreateTokenRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.CreateTokenResponse) => void): Request<AmplifyBackend.Types.CreateTokenResponse, AWSError>;
  66. /**
  67. * Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
  68. */
  69. createToken(callback?: (err: AWSError, data: AmplifyBackend.Types.CreateTokenResponse) => void): Request<AmplifyBackend.Types.CreateTokenResponse, AWSError>;
  70. /**
  71. * Removes an existing environment from your Amplify project.
  72. */
  73. deleteBackend(params: AmplifyBackend.Types.DeleteBackendRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendResponse) => void): Request<AmplifyBackend.Types.DeleteBackendResponse, AWSError>;
  74. /**
  75. * Removes an existing environment from your Amplify project.
  76. */
  77. deleteBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendResponse) => void): Request<AmplifyBackend.Types.DeleteBackendResponse, AWSError>;
  78. /**
  79. * Deletes an existing backend API resource.
  80. */
  81. deleteBackendAPI(params: AmplifyBackend.Types.DeleteBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAPIResponse) => void): Request<AmplifyBackend.Types.DeleteBackendAPIResponse, AWSError>;
  82. /**
  83. * Deletes an existing backend API resource.
  84. */
  85. deleteBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAPIResponse) => void): Request<AmplifyBackend.Types.DeleteBackendAPIResponse, AWSError>;
  86. /**
  87. * Deletes an existing backend authentication resource.
  88. */
  89. deleteBackendAuth(params: AmplifyBackend.Types.DeleteBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAuthResponse) => void): Request<AmplifyBackend.Types.DeleteBackendAuthResponse, AWSError>;
  90. /**
  91. * Deletes an existing backend authentication resource.
  92. */
  93. deleteBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendAuthResponse) => void): Request<AmplifyBackend.Types.DeleteBackendAuthResponse, AWSError>;
  94. /**
  95. * Removes the specified backend storage resource.
  96. */
  97. deleteBackendStorage(params: AmplifyBackend.Types.DeleteBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendStorageResponse) => void): Request<AmplifyBackend.Types.DeleteBackendStorageResponse, AWSError>;
  98. /**
  99. * Removes the specified backend storage resource.
  100. */
  101. deleteBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteBackendStorageResponse) => void): Request<AmplifyBackend.Types.DeleteBackendStorageResponse, AWSError>;
  102. /**
  103. * Deletes the challenge token based on the given appId and sessionId.
  104. */
  105. deleteToken(params: AmplifyBackend.Types.DeleteTokenRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteTokenResponse) => void): Request<AmplifyBackend.Types.DeleteTokenResponse, AWSError>;
  106. /**
  107. * Deletes the challenge token based on the given appId and sessionId.
  108. */
  109. deleteToken(callback?: (err: AWSError, data: AmplifyBackend.Types.DeleteTokenResponse) => void): Request<AmplifyBackend.Types.DeleteTokenResponse, AWSError>;
  110. /**
  111. * Generates a model schema for an existing backend API resource.
  112. */
  113. generateBackendAPIModels(params: AmplifyBackend.Types.GenerateBackendAPIModelsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GenerateBackendAPIModelsResponse) => void): Request<AmplifyBackend.Types.GenerateBackendAPIModelsResponse, AWSError>;
  114. /**
  115. * Generates a model schema for an existing backend API resource.
  116. */
  117. generateBackendAPIModels(callback?: (err: AWSError, data: AmplifyBackend.Types.GenerateBackendAPIModelsResponse) => void): Request<AmplifyBackend.Types.GenerateBackendAPIModelsResponse, AWSError>;
  118. /**
  119. * Provides project-level details for your Amplify UI project.
  120. */
  121. getBackend(params: AmplifyBackend.Types.GetBackendRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendResponse) => void): Request<AmplifyBackend.Types.GetBackendResponse, AWSError>;
  122. /**
  123. * Provides project-level details for your Amplify UI project.
  124. */
  125. getBackend(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendResponse) => void): Request<AmplifyBackend.Types.GetBackendResponse, AWSError>;
  126. /**
  127. * Gets the details for a backend API.
  128. */
  129. getBackendAPI(params: AmplifyBackend.Types.GetBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIResponse) => void): Request<AmplifyBackend.Types.GetBackendAPIResponse, AWSError>;
  130. /**
  131. * Gets the details for a backend API.
  132. */
  133. getBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIResponse) => void): Request<AmplifyBackend.Types.GetBackendAPIResponse, AWSError>;
  134. /**
  135. * Gets a model introspection schema for an existing backend API resource.
  136. */
  137. getBackendAPIModels(params: AmplifyBackend.Types.GetBackendAPIModelsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIModelsResponse) => void): Request<AmplifyBackend.Types.GetBackendAPIModelsResponse, AWSError>;
  138. /**
  139. * Gets a model introspection schema for an existing backend API resource.
  140. */
  141. getBackendAPIModels(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAPIModelsResponse) => void): Request<AmplifyBackend.Types.GetBackendAPIModelsResponse, AWSError>;
  142. /**
  143. * Gets a backend auth details.
  144. */
  145. getBackendAuth(params: AmplifyBackend.Types.GetBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAuthResponse) => void): Request<AmplifyBackend.Types.GetBackendAuthResponse, AWSError>;
  146. /**
  147. * Gets a backend auth details.
  148. */
  149. getBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendAuthResponse) => void): Request<AmplifyBackend.Types.GetBackendAuthResponse, AWSError>;
  150. /**
  151. * Returns information about a specific job.
  152. */
  153. getBackendJob(params: AmplifyBackend.Types.GetBackendJobRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendJobResponse) => void): Request<AmplifyBackend.Types.GetBackendJobResponse, AWSError>;
  154. /**
  155. * Returns information about a specific job.
  156. */
  157. getBackendJob(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendJobResponse) => void): Request<AmplifyBackend.Types.GetBackendJobResponse, AWSError>;
  158. /**
  159. * Gets details for a backend storage resource.
  160. */
  161. getBackendStorage(params: AmplifyBackend.Types.GetBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendStorageResponse) => void): Request<AmplifyBackend.Types.GetBackendStorageResponse, AWSError>;
  162. /**
  163. * Gets details for a backend storage resource.
  164. */
  165. getBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.GetBackendStorageResponse) => void): Request<AmplifyBackend.Types.GetBackendStorageResponse, AWSError>;
  166. /**
  167. * Gets the challenge token based on the given appId and sessionId.
  168. */
  169. getToken(params: AmplifyBackend.Types.GetTokenRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.GetTokenResponse) => void): Request<AmplifyBackend.Types.GetTokenResponse, AWSError>;
  170. /**
  171. * Gets the challenge token based on the given appId and sessionId.
  172. */
  173. getToken(callback?: (err: AWSError, data: AmplifyBackend.Types.GetTokenResponse) => void): Request<AmplifyBackend.Types.GetTokenResponse, AWSError>;
  174. /**
  175. * Imports an existing backend authentication resource.
  176. */
  177. importBackendAuth(params: AmplifyBackend.Types.ImportBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.ImportBackendAuthResponse) => void): Request<AmplifyBackend.Types.ImportBackendAuthResponse, AWSError>;
  178. /**
  179. * Imports an existing backend authentication resource.
  180. */
  181. importBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.ImportBackendAuthResponse) => void): Request<AmplifyBackend.Types.ImportBackendAuthResponse, AWSError>;
  182. /**
  183. * Imports an existing backend storage resource.
  184. */
  185. importBackendStorage(params: AmplifyBackend.Types.ImportBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.ImportBackendStorageResponse) => void): Request<AmplifyBackend.Types.ImportBackendStorageResponse, AWSError>;
  186. /**
  187. * Imports an existing backend storage resource.
  188. */
  189. importBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.ImportBackendStorageResponse) => void): Request<AmplifyBackend.Types.ImportBackendStorageResponse, AWSError>;
  190. /**
  191. * Lists the jobs for the backend of an Amplify app.
  192. */
  193. listBackendJobs(params: AmplifyBackend.Types.ListBackendJobsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.ListBackendJobsResponse) => void): Request<AmplifyBackend.Types.ListBackendJobsResponse, AWSError>;
  194. /**
  195. * Lists the jobs for the backend of an Amplify app.
  196. */
  197. listBackendJobs(callback?: (err: AWSError, data: AmplifyBackend.Types.ListBackendJobsResponse) => void): Request<AmplifyBackend.Types.ListBackendJobsResponse, AWSError>;
  198. /**
  199. * The list of S3 buckets in your account.
  200. */
  201. listS3Buckets(params: AmplifyBackend.Types.ListS3BucketsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.ListS3BucketsResponse) => void): Request<AmplifyBackend.Types.ListS3BucketsResponse, AWSError>;
  202. /**
  203. * The list of S3 buckets in your account.
  204. */
  205. listS3Buckets(callback?: (err: AWSError, data: AmplifyBackend.Types.ListS3BucketsResponse) => void): Request<AmplifyBackend.Types.ListS3BucketsResponse, AWSError>;
  206. /**
  207. * Removes all backend environments from your Amplify project.
  208. */
  209. removeAllBackends(params: AmplifyBackend.Types.RemoveAllBackendsRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveAllBackendsResponse) => void): Request<AmplifyBackend.Types.RemoveAllBackendsResponse, AWSError>;
  210. /**
  211. * Removes all backend environments from your Amplify project.
  212. */
  213. removeAllBackends(callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveAllBackendsResponse) => void): Request<AmplifyBackend.Types.RemoveAllBackendsResponse, AWSError>;
  214. /**
  215. * Removes the AWS resources required to access the Amplify Admin UI.
  216. */
  217. removeBackendConfig(params: AmplifyBackend.Types.RemoveBackendConfigRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveBackendConfigResponse) => void): Request<AmplifyBackend.Types.RemoveBackendConfigResponse, AWSError>;
  218. /**
  219. * Removes the AWS resources required to access the Amplify Admin UI.
  220. */
  221. removeBackendConfig(callback?: (err: AWSError, data: AmplifyBackend.Types.RemoveBackendConfigResponse) => void): Request<AmplifyBackend.Types.RemoveBackendConfigResponse, AWSError>;
  222. /**
  223. * Updates an existing backend API resource.
  224. */
  225. updateBackendAPI(params: AmplifyBackend.Types.UpdateBackendAPIRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAPIResponse) => void): Request<AmplifyBackend.Types.UpdateBackendAPIResponse, AWSError>;
  226. /**
  227. * Updates an existing backend API resource.
  228. */
  229. updateBackendAPI(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAPIResponse) => void): Request<AmplifyBackend.Types.UpdateBackendAPIResponse, AWSError>;
  230. /**
  231. * Updates an existing backend authentication resource.
  232. */
  233. updateBackendAuth(params: AmplifyBackend.Types.UpdateBackendAuthRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAuthResponse) => void): Request<AmplifyBackend.Types.UpdateBackendAuthResponse, AWSError>;
  234. /**
  235. * Updates an existing backend authentication resource.
  236. */
  237. updateBackendAuth(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendAuthResponse) => void): Request<AmplifyBackend.Types.UpdateBackendAuthResponse, AWSError>;
  238. /**
  239. * Updates the AWS resources required to access the Amplify Admin UI.
  240. */
  241. updateBackendConfig(params: AmplifyBackend.Types.UpdateBackendConfigRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendConfigResponse) => void): Request<AmplifyBackend.Types.UpdateBackendConfigResponse, AWSError>;
  242. /**
  243. * Updates the AWS resources required to access the Amplify Admin UI.
  244. */
  245. updateBackendConfig(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendConfigResponse) => void): Request<AmplifyBackend.Types.UpdateBackendConfigResponse, AWSError>;
  246. /**
  247. * Updates a specific job.
  248. */
  249. updateBackendJob(params: AmplifyBackend.Types.UpdateBackendJobRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendJobResponse) => void): Request<AmplifyBackend.Types.UpdateBackendJobResponse, AWSError>;
  250. /**
  251. * Updates a specific job.
  252. */
  253. updateBackendJob(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendJobResponse) => void): Request<AmplifyBackend.Types.UpdateBackendJobResponse, AWSError>;
  254. /**
  255. * Updates an existing backend storage resource.
  256. */
  257. updateBackendStorage(params: AmplifyBackend.Types.UpdateBackendStorageRequest, callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendStorageResponse) => void): Request<AmplifyBackend.Types.UpdateBackendStorageResponse, AWSError>;
  258. /**
  259. * Updates an existing backend storage resource.
  260. */
  261. updateBackendStorage(callback?: (err: AWSError, data: AmplifyBackend.Types.UpdateBackendStorageResponse) => void): Request<AmplifyBackend.Types.UpdateBackendStorageResponse, AWSError>;
  262. }
  263. declare namespace AmplifyBackend {
  264. export type AuthResources = "USER_POOL_ONLY"|"IDENTITY_POOL_AND_USER_POOL"|string;
  265. export interface BackendAPIAppSyncAuthSettings {
  266. /**
  267. * The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
  268. */
  269. CognitoUserPoolId?: __string;
  270. /**
  271. * The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
  272. */
  273. Description?: __string;
  274. /**
  275. * The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
  276. */
  277. ExpirationTime?: __double;
  278. /**
  279. * The expiry time for the OpenID authentication mechanism.
  280. */
  281. OpenIDAuthTTL?: __string;
  282. /**
  283. * The clientID for openID, if openID was used as an authentication setting to access your data models.
  284. */
  285. OpenIDClientId?: __string;
  286. /**
  287. * The expiry time for the OpenID authentication mechanism.
  288. */
  289. OpenIDIatTTL?: __string;
  290. /**
  291. * The openID issuer URL, if openID was used as an authentication setting to access your data models.
  292. */
  293. OpenIDIssueURL?: __string;
  294. /**
  295. * The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
  296. */
  297. OpenIDProviderName?: __string;
  298. }
  299. export interface BackendAPIAuthType {
  300. /**
  301. * Describes the authentication mode.
  302. */
  303. Mode?: Mode;
  304. /**
  305. * Describes settings for the authentication mode.
  306. */
  307. Settings?: BackendAPIAppSyncAuthSettings;
  308. }
  309. export interface BackendAPIConflictResolution {
  310. /**
  311. * The strategy for conflict resolution.
  312. */
  313. ResolutionStrategy?: ResolutionStrategy;
  314. }
  315. export interface BackendAPIResourceConfig {
  316. /**
  317. * Additional authentication methods used to interact with your data models.
  318. */
  319. AdditionalAuthTypes?: ListOfBackendAPIAuthType;
  320. /**
  321. * The API name used to interact with the data model, configured as a part of your Amplify project.
  322. */
  323. ApiName?: __string;
  324. /**
  325. * The conflict resolution strategy for your data stored in the data models.
  326. */
  327. ConflictResolution?: BackendAPIConflictResolution;
  328. /**
  329. * The default authentication type for interacting with the configured data models in your Amplify project.
  330. */
  331. DefaultAuthType?: BackendAPIAuthType;
  332. /**
  333. * The service used to provision and interact with the data model.
  334. */
  335. Service?: __string;
  336. /**
  337. * The definition of the data model in the annotated transform of the GraphQL schema.
  338. */
  339. TransformSchema?: __string;
  340. }
  341. export interface BackendAuthAppleProviderConfig {
  342. /**
  343. * Describes the client_id (also called Services ID) that comes from Apple.
  344. */
  345. ClientId?: __string;
  346. /**
  347. * Describes the key_id that comes from Apple.
  348. */
  349. KeyId?: __string;
  350. /**
  351. * Describes the private_key that comes from Apple.
  352. */
  353. PrivateKey?: __string;
  354. /**
  355. * Describes the team_id that comes from Apple.
  356. */
  357. TeamId?: __string;
  358. }
  359. export interface BackendAuthSocialProviderConfig {
  360. /**
  361. * Describes the client_id, which can be obtained from the third-party social federation provider.
  362. */
  363. ClientId?: __string;
  364. /**
  365. * Describes the client_secret, which can be obtained from third-party social federation providers.
  366. */
  367. ClientSecret?: __string;
  368. }
  369. export interface BackendJobRespObj {
  370. /**
  371. * The app ID.
  372. */
  373. AppId: __string;
  374. /**
  375. * The name of the backend environment.
  376. */
  377. BackendEnvironmentName: __string;
  378. /**
  379. * The time when the job was created.
  380. */
  381. CreateTime?: __string;
  382. /**
  383. * If the request fails, this error is returned.
  384. */
  385. Error?: __string;
  386. /**
  387. * The ID for the job.
  388. */
  389. JobId?: __string;
  390. /**
  391. * The name of the operation.
  392. */
  393. Operation?: __string;
  394. /**
  395. * The current status of the request.
  396. */
  397. Status?: __string;
  398. /**
  399. * The time when the job was last updated.
  400. */
  401. UpdateTime?: __string;
  402. }
  403. export interface BackendStoragePermissions {
  404. /**
  405. * Lists all authenticated user read, write, and delete permissions for your S3 bucket.
  406. */
  407. Authenticated: ListOfAuthenticatedElement;
  408. /**
  409. * Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.
  410. */
  411. UnAuthenticated?: ListOfUnAuthenticatedElement;
  412. }
  413. export interface CloneBackendRequest {
  414. /**
  415. * The app ID.
  416. */
  417. AppId: __string;
  418. /**
  419. * The name of the backend environment.
  420. */
  421. BackendEnvironmentName: __string;
  422. /**
  423. * The name of the destination backend environment to be created.
  424. */
  425. TargetEnvironmentName: __string;
  426. }
  427. export interface CloneBackendResponse {
  428. /**
  429. * The app ID.
  430. */
  431. AppId?: __string;
  432. /**
  433. * The name of the backend environment.
  434. */
  435. BackendEnvironmentName?: __string;
  436. /**
  437. * If the request fails, this error is returned.
  438. */
  439. Error?: __string;
  440. /**
  441. * The ID for the job.
  442. */
  443. JobId?: __string;
  444. /**
  445. * The name of the operation.
  446. */
  447. Operation?: __string;
  448. /**
  449. * The current status of the request.
  450. */
  451. Status?: __string;
  452. }
  453. export interface CreateBackendAPIRequest {
  454. /**
  455. * The app ID.
  456. */
  457. AppId: __string;
  458. /**
  459. * The name of the backend environment.
  460. */
  461. BackendEnvironmentName: __string;
  462. /**
  463. * The resource configuration for this request.
  464. */
  465. ResourceConfig: BackendAPIResourceConfig;
  466. /**
  467. * The name of this resource.
  468. */
  469. ResourceName: __string;
  470. }
  471. export interface CreateBackendAPIResponse {
  472. /**
  473. * The app ID.
  474. */
  475. AppId?: __string;
  476. /**
  477. * The name of the backend environment.
  478. */
  479. BackendEnvironmentName?: __string;
  480. /**
  481. * If the request fails, this error is returned.
  482. */
  483. Error?: __string;
  484. /**
  485. * The ID for the job.
  486. */
  487. JobId?: __string;
  488. /**
  489. * The name of the operation.
  490. */
  491. Operation?: __string;
  492. /**
  493. * The current status of the request.
  494. */
  495. Status?: __string;
  496. }
  497. export interface CreateBackendAuthForgotPasswordConfig {
  498. /**
  499. * (DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.
  500. */
  501. DeliveryMethod: DeliveryMethod;
  502. /**
  503. * (DEPRECATED) The configuration for the email sent when an app user forgets their password.
  504. */
  505. EmailSettings?: EmailSettings;
  506. /**
  507. * (DEPRECATED) The configuration for the SMS message sent when an app user forgets their password.
  508. */
  509. SmsSettings?: SmsSettings;
  510. }
  511. export interface CreateBackendAuthIdentityPoolConfig {
  512. /**
  513. * Name of the Amazon Cognito identity pool used for authorization.
  514. */
  515. IdentityPoolName: __string;
  516. /**
  517. * Set to true or false based on whether you want to enable guest authorization to your Amplify app.
  518. */
  519. UnauthenticatedLogin: __boolean;
  520. }
  521. export interface CreateBackendAuthMFAConfig {
  522. /**
  523. * Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.
  524. */
  525. MFAMode: MFAMode;
  526. /**
  527. * Describes the configuration settings and methods for your Amplify app users to use MFA.
  528. */
  529. Settings?: Settings;
  530. }
  531. export interface CreateBackendAuthOAuthConfig {
  532. /**
  533. * The domain prefix for your Amplify app.
  534. */
  535. DomainPrefix?: __string;
  536. /**
  537. * The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
  538. */
  539. OAuthGrantType: OAuthGrantType;
  540. /**
  541. * List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
  542. */
  543. OAuthScopes: ListOfOAuthScopesElement;
  544. /**
  545. * The redirected URI for signing in to your Amplify app.
  546. */
  547. RedirectSignInURIs: ListOf__string;
  548. /**
  549. * Redirect URLs that OAuth uses when a user signs out of an Amplify app.
  550. */
  551. RedirectSignOutURIs: ListOf__string;
  552. /**
  553. * The settings for using social providers to access your Amplify app.
  554. */
  555. SocialProviderSettings?: SocialProviderSettings;
  556. }
  557. export interface CreateBackendAuthPasswordPolicyConfig {
  558. /**
  559. * Additional constraints for the password used to access the backend of your Amplify project.
  560. */
  561. AdditionalConstraints?: ListOfAdditionalConstraintsElement;
  562. /**
  563. * The minimum length of the password used to access the backend of your Amplify project.
  564. */
  565. MinimumLength: __double;
  566. }
  567. export interface CreateBackendAuthRequest {
  568. /**
  569. * The app ID.
  570. */
  571. AppId: __string;
  572. /**
  573. * The name of the backend environment.
  574. */
  575. BackendEnvironmentName: __string;
  576. /**
  577. * The resource configuration for this request object.
  578. */
  579. ResourceConfig: CreateBackendAuthResourceConfig;
  580. /**
  581. * The name of this resource.
  582. */
  583. ResourceName: __string;
  584. }
  585. export interface CreateBackendAuthResourceConfig {
  586. /**
  587. * Defines whether you want to configure only authentication or both authentication and authorization settings.
  588. */
  589. AuthResources: AuthResources;
  590. /**
  591. * Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
  592. */
  593. IdentityPoolConfigs?: CreateBackendAuthIdentityPoolConfig;
  594. /**
  595. * Defines the service name to use when configuring an authentication resource in your Amplify project.
  596. */
  597. Service: Service;
  598. /**
  599. * Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
  600. */
  601. UserPoolConfigs: CreateBackendAuthUserPoolConfig;
  602. }
  603. export interface CreateBackendAuthResponse {
  604. /**
  605. * The app ID.
  606. */
  607. AppId?: __string;
  608. /**
  609. * The name of the backend environment.
  610. */
  611. BackendEnvironmentName?: __string;
  612. /**
  613. * If the request fails, this error is returned.
  614. */
  615. Error?: __string;
  616. /**
  617. * The ID for the job.
  618. */
  619. JobId?: __string;
  620. /**
  621. * The name of the operation.
  622. */
  623. Operation?: __string;
  624. /**
  625. * The current status of the request.
  626. */
  627. Status?: __string;
  628. }
  629. export interface CreateBackendAuthUserPoolConfig {
  630. /**
  631. * (DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
  632. */
  633. ForgotPassword?: CreateBackendAuthForgotPasswordConfig;
  634. /**
  635. * Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
  636. */
  637. Mfa?: CreateBackendAuthMFAConfig;
  638. /**
  639. * Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
  640. */
  641. OAuth?: CreateBackendAuthOAuthConfig;
  642. /**
  643. * Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
  644. */
  645. PasswordPolicy?: CreateBackendAuthPasswordPolicyConfig;
  646. /**
  647. * The required attributes to sign up new users in the user pool.
  648. */
  649. RequiredSignUpAttributes: ListOfRequiredSignUpAttributesElement;
  650. /**
  651. * 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.
  652. */
  653. SignInMethod: SignInMethod;
  654. /**
  655. * The Amazon Cognito user pool name.
  656. */
  657. UserPoolName: __string;
  658. /**
  659. * Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
  660. */
  661. VerificationMessage?: CreateBackendAuthVerificationMessageConfig;
  662. }
  663. export interface CreateBackendAuthVerificationMessageConfig {
  664. /**
  665. * The type of verification message to send.
  666. */
  667. DeliveryMethod: DeliveryMethod;
  668. /**
  669. * The settings for the email message.
  670. */
  671. EmailSettings?: EmailSettings;
  672. /**
  673. * The settings for the SMS message.
  674. */
  675. SmsSettings?: SmsSettings;
  676. }
  677. export interface CreateBackendConfigRequest {
  678. /**
  679. * The app ID.
  680. */
  681. AppId: __string;
  682. /**
  683. * The app ID for the backend manager.
  684. */
  685. BackendManagerAppId?: __string;
  686. }
  687. export interface CreateBackendConfigResponse {
  688. /**
  689. * The app ID.
  690. */
  691. AppId?: __string;
  692. /**
  693. * The name of the backend environment.
  694. */
  695. BackendEnvironmentName?: __string;
  696. /**
  697. * The ID for the job.
  698. */
  699. JobId?: __string;
  700. /**
  701. * The current status of the request.
  702. */
  703. Status?: __string;
  704. }
  705. export interface CreateBackendRequest {
  706. /**
  707. * The app ID.
  708. */
  709. AppId: __string;
  710. /**
  711. * The name of the app.
  712. */
  713. AppName: __string;
  714. /**
  715. * The name of the backend environment.
  716. */
  717. BackendEnvironmentName: __string;
  718. /**
  719. * The resource configuration for creating a backend.
  720. */
  721. ResourceConfig?: ResourceConfig;
  722. /**
  723. * The name of the resource.
  724. */
  725. ResourceName?: __string;
  726. }
  727. export interface CreateBackendResponse {
  728. /**
  729. * The app ID.
  730. */
  731. AppId?: __string;
  732. /**
  733. * The name of the backend environment.
  734. */
  735. BackendEnvironmentName?: __string;
  736. /**
  737. * If the request fails, this error is returned.
  738. */
  739. Error?: __string;
  740. /**
  741. * The ID for the job.
  742. */
  743. JobId?: __string;
  744. /**
  745. * The name of the operation.
  746. */
  747. Operation?: __string;
  748. /**
  749. * The current status of the request.
  750. */
  751. Status?: __string;
  752. }
  753. export interface CreateBackendStorageRequest {
  754. /**
  755. * The app ID.
  756. */
  757. AppId: __string;
  758. /**
  759. * The name of the backend environment.
  760. */
  761. BackendEnvironmentName: __string;
  762. /**
  763. * The resource configuration for creating backend storage.
  764. */
  765. ResourceConfig: CreateBackendStorageResourceConfig;
  766. /**
  767. * The name of the storage resource.
  768. */
  769. ResourceName: __string;
  770. }
  771. export interface CreateBackendStorageResourceConfig {
  772. /**
  773. * The name of the S3 bucket.
  774. */
  775. BucketName?: __string;
  776. /**
  777. * The authorization configuration for the storage S3 bucket.
  778. */
  779. Permissions: BackendStoragePermissions;
  780. /**
  781. * The name of the storage service.
  782. */
  783. ServiceName: ServiceName;
  784. }
  785. export interface CreateBackendStorageResponse {
  786. /**
  787. * The app ID.
  788. */
  789. AppId?: __string;
  790. /**
  791. * The name of the backend environment.
  792. */
  793. BackendEnvironmentName?: __string;
  794. /**
  795. * The ID for the job.
  796. */
  797. JobId?: __string;
  798. /**
  799. * The current status of the request.
  800. */
  801. Status?: __string;
  802. }
  803. export interface CreateTokenRequest {
  804. /**
  805. * The app ID.
  806. */
  807. AppId: __string;
  808. }
  809. export interface CreateTokenResponse {
  810. /**
  811. * The app ID.
  812. */
  813. AppId?: __string;
  814. /**
  815. * One-time challenge code for authenticating into the Amplify Admin UI.
  816. */
  817. ChallengeCode?: __string;
  818. /**
  819. * A unique ID provided when creating a new challenge token.
  820. */
  821. SessionId?: __string;
  822. /**
  823. * The expiry time for the one-time generated token code.
  824. */
  825. Ttl?: __string;
  826. }
  827. export interface DeleteBackendAPIRequest {
  828. /**
  829. * The app ID.
  830. */
  831. AppId: __string;
  832. /**
  833. * The name of the backend environment.
  834. */
  835. BackendEnvironmentName: __string;
  836. /**
  837. * Defines the resource configuration for the data model in your Amplify project.
  838. */
  839. ResourceConfig?: BackendAPIResourceConfig;
  840. /**
  841. * The name of this resource.
  842. */
  843. ResourceName: __string;
  844. }
  845. export interface DeleteBackendAPIResponse {
  846. /**
  847. * The app ID.
  848. */
  849. AppId?: __string;
  850. /**
  851. * The name of the backend environment.
  852. */
  853. BackendEnvironmentName?: __string;
  854. /**
  855. * If the request fails, this error is returned.
  856. */
  857. Error?: __string;
  858. /**
  859. * The ID for the job.
  860. */
  861. JobId?: __string;
  862. /**
  863. * The name of the operation.
  864. */
  865. Operation?: __string;
  866. /**
  867. * The current status of the request.
  868. */
  869. Status?: __string;
  870. }
  871. export interface DeleteBackendAuthRequest {
  872. /**
  873. * The app ID.
  874. */
  875. AppId: __string;
  876. /**
  877. * The name of the backend environment.
  878. */
  879. BackendEnvironmentName: __string;
  880. /**
  881. * The name of this resource.
  882. */
  883. ResourceName: __string;
  884. }
  885. export interface DeleteBackendAuthResponse {
  886. /**
  887. * The app ID.
  888. */
  889. AppId?: __string;
  890. /**
  891. * The name of the backend environment.
  892. */
  893. BackendEnvironmentName?: __string;
  894. /**
  895. * If the request fails, this error is returned.
  896. */
  897. Error?: __string;
  898. /**
  899. * The ID for the job.
  900. */
  901. JobId?: __string;
  902. /**
  903. * The name of the operation.
  904. */
  905. Operation?: __string;
  906. /**
  907. * The current status of the request.
  908. */
  909. Status?: __string;
  910. }
  911. export interface DeleteBackendRequest {
  912. /**
  913. * The app ID.
  914. */
  915. AppId: __string;
  916. /**
  917. * The name of the backend environment.
  918. */
  919. BackendEnvironmentName: __string;
  920. }
  921. export interface DeleteBackendResponse {
  922. /**
  923. * The app ID.
  924. */
  925. AppId?: __string;
  926. /**
  927. * The name of the backend environment.
  928. */
  929. BackendEnvironmentName?: __string;
  930. /**
  931. * If the request fails, this error is returned.
  932. */
  933. Error?: __string;
  934. /**
  935. * The ID for the job.
  936. */
  937. JobId?: __string;
  938. /**
  939. * The name of the operation.
  940. */
  941. Operation?: __string;
  942. /**
  943. * The current status of the request.
  944. */
  945. Status?: __string;
  946. }
  947. export interface DeleteBackendStorageRequest {
  948. /**
  949. * The app ID.
  950. */
  951. AppId: __string;
  952. /**
  953. * The name of the backend environment.
  954. */
  955. BackendEnvironmentName: __string;
  956. /**
  957. * The name of the storage resource.
  958. */
  959. ResourceName: __string;
  960. /**
  961. * The name of the storage service.
  962. */
  963. ServiceName: ServiceName;
  964. }
  965. export interface DeleteBackendStorageResponse {
  966. /**
  967. * The app ID.
  968. */
  969. AppId?: __string;
  970. /**
  971. * The name of the backend environment.
  972. */
  973. BackendEnvironmentName?: __string;
  974. /**
  975. * The ID for the job.
  976. */
  977. JobId?: __string;
  978. /**
  979. * The current status of the request.
  980. */
  981. Status?: __string;
  982. }
  983. export interface DeleteTokenRequest {
  984. /**
  985. * The app ID.
  986. */
  987. AppId: __string;
  988. /**
  989. * The session ID.
  990. */
  991. SessionId: __string;
  992. }
  993. export interface DeleteTokenResponse {
  994. /**
  995. * Indicates whether the request succeeded or failed.
  996. */
  997. IsSuccess?: __boolean;
  998. }
  999. export type DeliveryMethod = "EMAIL"|"SMS"|string;
  1000. export interface EmailSettings {
  1001. /**
  1002. * The contents of the email message.
  1003. */
  1004. EmailMessage?: __string;
  1005. /**
  1006. * The contents of the subject line of the email message.
  1007. */
  1008. EmailSubject?: __string;
  1009. }
  1010. export interface GenerateBackendAPIModelsRequest {
  1011. /**
  1012. * The app ID.
  1013. */
  1014. AppId: __string;
  1015. /**
  1016. * The name of the backend environment.
  1017. */
  1018. BackendEnvironmentName: __string;
  1019. /**
  1020. * The name of this resource.
  1021. */
  1022. ResourceName: __string;
  1023. }
  1024. export interface GenerateBackendAPIModelsResponse {
  1025. /**
  1026. * The app ID.
  1027. */
  1028. AppId?: __string;
  1029. /**
  1030. * The name of the backend environment.
  1031. */
  1032. BackendEnvironmentName?: __string;
  1033. /**
  1034. * If the request fails, this error is returned.
  1035. */
  1036. Error?: __string;
  1037. /**
  1038. * The ID for the job.
  1039. */
  1040. JobId?: __string;
  1041. /**
  1042. * The name of the operation.
  1043. */
  1044. Operation?: __string;
  1045. /**
  1046. * The current status of the request.
  1047. */
  1048. Status?: __string;
  1049. }
  1050. export interface GetBackendAPIModelsRequest {
  1051. /**
  1052. * The app ID.
  1053. */
  1054. AppId: __string;
  1055. /**
  1056. * The name of the backend environment.
  1057. */
  1058. BackendEnvironmentName: __string;
  1059. /**
  1060. * The name of this resource.
  1061. */
  1062. ResourceName: __string;
  1063. }
  1064. export interface GetBackendAPIModelsResponse {
  1065. /**
  1066. * Stringified JSON of the datastore model.
  1067. */
  1068. Models?: __string;
  1069. /**
  1070. * The current status of the request.
  1071. */
  1072. Status?: Status;
  1073. /**
  1074. * Stringified JSON of the model introspection schema for an existing backend API resource.
  1075. */
  1076. ModelIntrospectionSchema?: __string;
  1077. }
  1078. export interface GetBackendAPIRequest {
  1079. /**
  1080. * The app ID.
  1081. */
  1082. AppId: __string;
  1083. /**
  1084. * The name of the backend environment.
  1085. */
  1086. BackendEnvironmentName: __string;
  1087. /**
  1088. * Defines the resource configuration for the data model in your Amplify project.
  1089. */
  1090. ResourceConfig?: BackendAPIResourceConfig;
  1091. /**
  1092. * The name of this resource.
  1093. */
  1094. ResourceName: __string;
  1095. }
  1096. export interface GetBackendAPIResponse {
  1097. /**
  1098. * The app ID.
  1099. */
  1100. AppId?: __string;
  1101. /**
  1102. * The name of the backend environment.
  1103. */
  1104. BackendEnvironmentName?: __string;
  1105. /**
  1106. * If the request fails, this error is returned.
  1107. */
  1108. Error?: __string;
  1109. /**
  1110. * The resource configuration for this response object.
  1111. */
  1112. ResourceConfig?: BackendAPIResourceConfig;
  1113. /**
  1114. * The name of this resource.
  1115. */
  1116. ResourceName?: __string;
  1117. }
  1118. export interface GetBackendAuthRequest {
  1119. /**
  1120. * The app ID.
  1121. */
  1122. AppId: __string;
  1123. /**
  1124. * The name of the backend environment.
  1125. */
  1126. BackendEnvironmentName: __string;
  1127. /**
  1128. * The name of this resource.
  1129. */
  1130. ResourceName: __string;
  1131. }
  1132. export interface GetBackendAuthResponse {
  1133. /**
  1134. * The app ID.
  1135. */
  1136. AppId?: __string;
  1137. /**
  1138. * The name of the backend environment.
  1139. */
  1140. BackendEnvironmentName?: __string;
  1141. /**
  1142. * If the request fails, this error is returned.
  1143. */
  1144. Error?: __string;
  1145. /**
  1146. * The resource configuration for authorization requests to the backend of your Amplify project.
  1147. */
  1148. ResourceConfig?: CreateBackendAuthResourceConfig;
  1149. /**
  1150. * The name of this resource.
  1151. */
  1152. ResourceName?: __string;
  1153. }
  1154. export interface GetBackendJobRequest {
  1155. /**
  1156. * The app ID.
  1157. */
  1158. AppId: __string;
  1159. /**
  1160. * The name of the backend environment.
  1161. */
  1162. BackendEnvironmentName: __string;
  1163. /**
  1164. * The ID for the job.
  1165. */
  1166. JobId: __string;
  1167. }
  1168. export interface GetBackendJobResponse {
  1169. /**
  1170. * The app ID.
  1171. */
  1172. AppId?: __string;
  1173. /**
  1174. * The name of the backend environment.
  1175. */
  1176. BackendEnvironmentName?: __string;
  1177. /**
  1178. * The time when the job was created.
  1179. */
  1180. CreateTime?: __string;
  1181. /**
  1182. * If the request fails, this error is returned.
  1183. */
  1184. Error?: __string;
  1185. /**
  1186. * The ID for the job.
  1187. */
  1188. JobId?: __string;
  1189. /**
  1190. * The name of the operation.
  1191. */
  1192. Operation?: __string;
  1193. /**
  1194. * The current status of the request.
  1195. */
  1196. Status?: __string;
  1197. /**
  1198. * The time when the job was last updated.
  1199. */
  1200. UpdateTime?: __string;
  1201. }
  1202. export interface GetBackendRequest {
  1203. /**
  1204. * The app ID.
  1205. */
  1206. AppId: __string;
  1207. /**
  1208. * The name of the backend environment.
  1209. */
  1210. BackendEnvironmentName?: __string;
  1211. }
  1212. export interface GetBackendResponse {
  1213. /**
  1214. * A stringified version of the cli.json file for your Amplify project.
  1215. */
  1216. AmplifyFeatureFlags?: __string;
  1217. /**
  1218. * A stringified version of the current configs for your Amplify project.
  1219. */
  1220. AmplifyMetaConfig?: __string;
  1221. /**
  1222. * The app ID.
  1223. */
  1224. AppId?: __string;
  1225. /**
  1226. * The name of the app.
  1227. */
  1228. AppName?: __string;
  1229. /**
  1230. * A list of backend environments in an array.
  1231. */
  1232. BackendEnvironmentList?: ListOf__string;
  1233. /**
  1234. * The name of the backend environment.
  1235. */
  1236. BackendEnvironmentName?: __string;
  1237. /**
  1238. * If the request failed, this is the returned error.
  1239. */
  1240. Error?: __string;
  1241. }
  1242. export interface GetBackendStorageRequest {
  1243. /**
  1244. * The app ID.
  1245. */
  1246. AppId: __string;
  1247. /**
  1248. * The name of the backend environment.
  1249. */
  1250. BackendEnvironmentName: __string;
  1251. /**
  1252. * The name of the storage resource.
  1253. */
  1254. ResourceName: __string;
  1255. }
  1256. export interface GetBackendStorageResourceConfig {
  1257. /**
  1258. * The name of the S3 bucket.
  1259. */
  1260. BucketName?: __string;
  1261. /**
  1262. * Returns True if the storage resource has been imported.
  1263. */
  1264. Imported: __boolean;
  1265. /**
  1266. * The authorization configuration for the storage S3 bucket.
  1267. */
  1268. Permissions?: BackendStoragePermissions;
  1269. /**
  1270. * The name of the storage service.
  1271. */
  1272. ServiceName: ServiceName;
  1273. }
  1274. export interface GetBackendStorageResponse {
  1275. /**
  1276. * The app ID.
  1277. */
  1278. AppId?: __string;
  1279. /**
  1280. * The name of the backend environment.
  1281. */
  1282. BackendEnvironmentName?: __string;
  1283. /**
  1284. * The resource configuration for the backend storage resource.
  1285. */
  1286. ResourceConfig?: GetBackendStorageResourceConfig;
  1287. /**
  1288. * The name of the storage resource.
  1289. */
  1290. ResourceName?: __string;
  1291. }
  1292. export interface GetTokenRequest {
  1293. /**
  1294. * The app ID.
  1295. */
  1296. AppId: __string;
  1297. /**
  1298. * The session ID.
  1299. */
  1300. SessionId: __string;
  1301. }
  1302. export interface GetTokenResponse {
  1303. /**
  1304. * The app ID.
  1305. */
  1306. AppId?: __string;
  1307. /**
  1308. * The one-time challenge code for authenticating into the Amplify Admin UI.
  1309. */
  1310. ChallengeCode?: __string;
  1311. /**
  1312. * A unique ID provided when creating a new challenge token.
  1313. */
  1314. SessionId?: __string;
  1315. /**
  1316. * The expiry time for the one-time generated token code.
  1317. */
  1318. Ttl?: __string;
  1319. }
  1320. export interface ImportBackendAuthRequest {
  1321. /**
  1322. * The app ID.
  1323. */
  1324. AppId: __string;
  1325. /**
  1326. * The name of the backend environment.
  1327. */
  1328. BackendEnvironmentName: __string;
  1329. /**
  1330. * The ID of the Amazon Cognito identity pool.
  1331. */
  1332. IdentityPoolId?: __string;
  1333. /**
  1334. * The ID of the Amazon Cognito native client.
  1335. */
  1336. NativeClientId: __string;
  1337. /**
  1338. * The ID of the Amazon Cognito user pool.
  1339. */
  1340. UserPoolId: __string;
  1341. /**
  1342. * The ID of the Amazon Cognito web client.
  1343. */
  1344. WebClientId: __string;
  1345. }
  1346. export interface ImportBackendAuthResponse {
  1347. /**
  1348. * The app ID.
  1349. */
  1350. AppId?: __string;
  1351. /**
  1352. * The name of the backend environment.
  1353. */
  1354. BackendEnvironmentName?: __string;
  1355. /**
  1356. * If the request fails, this error is returned.
  1357. */
  1358. Error?: __string;
  1359. /**
  1360. * The ID for the job.
  1361. */
  1362. JobId?: __string;
  1363. /**
  1364. * The name of the operation.
  1365. */
  1366. Operation?: __string;
  1367. /**
  1368. * The current status of the request.
  1369. */
  1370. Status?: __string;
  1371. }
  1372. export interface ImportBackendStorageRequest {
  1373. /**
  1374. * The app ID.
  1375. */
  1376. AppId: __string;
  1377. /**
  1378. * The name of the backend environment.
  1379. */
  1380. BackendEnvironmentName: __string;
  1381. /**
  1382. * The name of the S3 bucket.
  1383. */
  1384. BucketName?: __string;
  1385. /**
  1386. * The name of the storage service.
  1387. */
  1388. ServiceName: ServiceName;
  1389. }
  1390. export interface ImportBackendStorageResponse {
  1391. /**
  1392. * The app ID.
  1393. */
  1394. AppId?: __string;
  1395. /**
  1396. * The name of the backend environment.
  1397. */
  1398. BackendEnvironmentName?: __string;
  1399. /**
  1400. * The ID for the job.
  1401. */
  1402. JobId?: __string;
  1403. /**
  1404. * The current status of the request.
  1405. */
  1406. Status?: __string;
  1407. }
  1408. export interface ListBackendJobsRequest {
  1409. /**
  1410. * The app ID.
  1411. */
  1412. AppId: __string;
  1413. /**
  1414. * The name of the backend environment.
  1415. */
  1416. BackendEnvironmentName: __string;
  1417. /**
  1418. * The ID for the job.
  1419. */
  1420. JobId?: __string;
  1421. /**
  1422. * The maximum number of results that you want in the response.
  1423. */
  1424. MaxResults?: __integerMin1Max25;
  1425. /**
  1426. * The token for the next set of results.
  1427. */
  1428. NextToken?: __string;
  1429. /**
  1430. * Filters the list of response objects to include only those with the specified operation name.
  1431. */
  1432. Operation?: __string;
  1433. /**
  1434. * Filters the list of response objects to include only those with the specified status.
  1435. */
  1436. Status?: __string;
  1437. }
  1438. export interface ListBackendJobsResponse {
  1439. /**
  1440. * An array of jobs and their properties.
  1441. */
  1442. Jobs?: ListOfBackendJobRespObj;
  1443. /**
  1444. * The token for the next set of results.
  1445. */
  1446. NextToken?: __string;
  1447. }
  1448. export interface ListS3BucketsRequest {
  1449. /**
  1450. * Reserved for future use.
  1451. */
  1452. NextToken?: __string;
  1453. }
  1454. export interface ListS3BucketsResponse {
  1455. /**
  1456. * The list of S3 buckets.
  1457. */
  1458. Buckets?: ListOfS3BucketInfo;
  1459. /**
  1460. * Reserved for future use.
  1461. */
  1462. NextToken?: __string;
  1463. }
  1464. export interface LoginAuthConfigReqObj {
  1465. /**
  1466. * The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.
  1467. */
  1468. AwsCognitoIdentityPoolId?: __string;
  1469. /**
  1470. * The AWS Region for the Amplify Admin UI login.
  1471. */
  1472. AwsCognitoRegion?: __string;
  1473. /**
  1474. * The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.
  1475. */
  1476. AwsUserPoolsId?: __string;
  1477. /**
  1478. * The web client ID for the Amazon Cognito user pools.
  1479. */
  1480. AwsUserPoolsWebClientId?: __string;
  1481. }
  1482. export type MFAMode = "ON"|"OFF"|"OPTIONAL"|string;
  1483. export type Mode = "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|string;
  1484. export type OAuthGrantType = "CODE"|"IMPLICIT"|string;
  1485. export interface RemoveAllBackendsRequest {
  1486. /**
  1487. * The app ID.
  1488. */
  1489. AppId: __string;
  1490. /**
  1491. * Cleans up the Amplify Console app if this value is set to true.
  1492. */
  1493. CleanAmplifyApp?: __boolean;
  1494. }
  1495. export interface RemoveAllBackendsResponse {
  1496. /**
  1497. * The app ID.
  1498. */
  1499. AppId?: __string;
  1500. /**
  1501. * If the request fails, this error is returned.
  1502. */
  1503. Error?: __string;
  1504. /**
  1505. * The ID for the job.
  1506. */
  1507. JobId?: __string;
  1508. /**
  1509. * The name of the operation.
  1510. */
  1511. Operation?: __string;
  1512. /**
  1513. * The current status of the request.
  1514. */
  1515. Status?: __string;
  1516. }
  1517. export interface RemoveBackendConfigRequest {
  1518. /**
  1519. * The app ID.
  1520. */
  1521. AppId: __string;
  1522. }
  1523. export interface RemoveBackendConfigResponse {
  1524. /**
  1525. * If the request fails, this error is returned.
  1526. */
  1527. Error?: __string;
  1528. }
  1529. export type ResolutionStrategy = "OPTIMISTIC_CONCURRENCY"|"LAMBDA"|"AUTOMERGE"|"NONE"|string;
  1530. export interface ResourceConfig {
  1531. }
  1532. export interface S3BucketInfo {
  1533. /**
  1534. * The creation date of the S3 bucket.
  1535. */
  1536. CreationDate?: __string;
  1537. /**
  1538. * The name of the S3 bucket.
  1539. */
  1540. Name?: __string;
  1541. }
  1542. export type Service = "COGNITO"|string;
  1543. export type ServiceName = "S3"|string;
  1544. export interface Settings {
  1545. /**
  1546. * The supported MFA types.
  1547. */
  1548. MfaTypes?: ListOfMfaTypesElement;
  1549. /**
  1550. * The body of the SMS message.
  1551. */
  1552. SmsMessage?: __string;
  1553. }
  1554. export type SignInMethod = "EMAIL"|"EMAIL_AND_PHONE_NUMBER"|"PHONE_NUMBER"|"USERNAME"|string;
  1555. export interface SmsSettings {
  1556. /**
  1557. * The contents of the SMS message.
  1558. */
  1559. SmsMessage?: __string;
  1560. }
  1561. export interface SocialProviderSettings {
  1562. Facebook?: BackendAuthSocialProviderConfig;
  1563. Google?: BackendAuthSocialProviderConfig;
  1564. LoginWithAmazon?: BackendAuthSocialProviderConfig;
  1565. SignInWithApple?: BackendAuthAppleProviderConfig;
  1566. }
  1567. export type Status = "LATEST"|"STALE"|string;
  1568. export interface UpdateBackendAPIRequest {
  1569. /**
  1570. * The app ID.
  1571. */
  1572. AppId: __string;
  1573. /**
  1574. * The name of the backend environment.
  1575. */
  1576. BackendEnvironmentName: __string;
  1577. /**
  1578. * Defines the resource configuration for the data model in your Amplify project.
  1579. */
  1580. ResourceConfig?: BackendAPIResourceConfig;
  1581. /**
  1582. * The name of this resource.
  1583. */
  1584. ResourceName: __string;
  1585. }
  1586. export interface UpdateBackendAPIResponse {
  1587. /**
  1588. * The app ID.
  1589. */
  1590. AppId?: __string;
  1591. /**
  1592. * The name of the backend environment.
  1593. */
  1594. BackendEnvironmentName?: __string;
  1595. /**
  1596. * If the request fails, this error is returned.
  1597. */
  1598. Error?: __string;
  1599. /**
  1600. * The ID for the job.
  1601. */
  1602. JobId?: __string;
  1603. /**
  1604. * The name of the operation.
  1605. */
  1606. Operation?: __string;
  1607. /**
  1608. * The current status of the request.
  1609. */
  1610. Status?: __string;
  1611. }
  1612. export interface UpdateBackendAuthForgotPasswordConfig {
  1613. /**
  1614. * (DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.
  1615. */
  1616. DeliveryMethod?: DeliveryMethod;
  1617. /**
  1618. * (DEPRECATED) The configuration for the email sent when an app user forgets their password.
  1619. */
  1620. EmailSettings?: EmailSettings;
  1621. /**
  1622. * (DEPRECATED) The configuration for the SMS message sent when an Amplify app user forgets their password.
  1623. */
  1624. SmsSettings?: SmsSettings;
  1625. }
  1626. export interface UpdateBackendAuthIdentityPoolConfig {
  1627. /**
  1628. * A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.
  1629. */
  1630. UnauthenticatedLogin?: __boolean;
  1631. }
  1632. export interface UpdateBackendAuthMFAConfig {
  1633. /**
  1634. * The MFA mode for the backend of your Amplify project.
  1635. */
  1636. MFAMode?: MFAMode;
  1637. /**
  1638. * The settings of your MFA configuration for the backend of your Amplify project.
  1639. */
  1640. Settings?: Settings;
  1641. }
  1642. export interface UpdateBackendAuthOAuthConfig {
  1643. /**
  1644. * The Amazon Cognito domain prefix used to create a hosted UI for authentication.
  1645. */
  1646. DomainPrefix?: __string;
  1647. /**
  1648. * The OAuth grant type to allow app users to authenticate from your Amplify app.
  1649. */
  1650. OAuthGrantType?: OAuthGrantType;
  1651. /**
  1652. * The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
  1653. */
  1654. OAuthScopes?: ListOfOAuthScopesElement;
  1655. /**
  1656. * Redirect URLs that OAuth uses when a user signs in to an Amplify app.
  1657. */
  1658. RedirectSignInURIs?: ListOf__string;
  1659. /**
  1660. * Redirect URLs that OAuth uses when a user signs out of an Amplify app.
  1661. */
  1662. RedirectSignOutURIs?: ListOf__string;
  1663. /**
  1664. * Describes third-party social federation configurations for allowing your users to sign in with OAuth.
  1665. */
  1666. SocialProviderSettings?: SocialProviderSettings;
  1667. }
  1668. export interface UpdateBackendAuthPasswordPolicyConfig {
  1669. /**
  1670. * Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.
  1671. */
  1672. AdditionalConstraints?: ListOfAdditionalConstraintsElement;
  1673. /**
  1674. * Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.
  1675. */
  1676. MinimumLength?: __double;
  1677. }
  1678. export interface UpdateBackendAuthRequest {
  1679. /**
  1680. * The app ID.
  1681. */
  1682. AppId: __string;
  1683. /**
  1684. * The name of the backend environment.
  1685. */
  1686. BackendEnvironmentName: __string;
  1687. /**
  1688. * The resource configuration for this request object.
  1689. */
  1690. ResourceConfig: UpdateBackendAuthResourceConfig;
  1691. /**
  1692. * The name of this resource.
  1693. */
  1694. ResourceName: __string;
  1695. }
  1696. export interface UpdateBackendAuthResourceConfig {
  1697. /**
  1698. * Defines the service name to use when configuring an authentication resource in your Amplify project.
  1699. */
  1700. AuthResources: AuthResources;
  1701. /**
  1702. * Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
  1703. */
  1704. IdentityPoolConfigs?: UpdateBackendAuthIdentityPoolConfig;
  1705. /**
  1706. * Defines the service name to use when configuring an authentication resource in your Amplify project.
  1707. */
  1708. Service: Service;
  1709. /**
  1710. * Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
  1711. */
  1712. UserPoolConfigs: UpdateBackendAuthUserPoolConfig;
  1713. }
  1714. export interface UpdateBackendAuthResponse {
  1715. /**
  1716. * The app ID.
  1717. */
  1718. AppId?: __string;
  1719. /**
  1720. * The name of the backend environment.
  1721. */
  1722. BackendEnvironmentName?: __string;
  1723. /**
  1724. * If the request fails, this error is returned.
  1725. */
  1726. Error?: __string;
  1727. /**
  1728. * The ID for the job.
  1729. */
  1730. JobId?: __string;
  1731. /**
  1732. * The name of the operation.
  1733. */
  1734. Operation?: __string;
  1735. /**
  1736. * The current status of the request.
  1737. */
  1738. Status?: __string;
  1739. }
  1740. export interface UpdateBackendAuthUserPoolConfig {
  1741. /**
  1742. * (DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
  1743. */
  1744. ForgotPassword?: UpdateBackendAuthForgotPasswordConfig;
  1745. /**
  1746. * Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
  1747. */
  1748. Mfa?: UpdateBackendAuthMFAConfig;
  1749. /**
  1750. * Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
  1751. */
  1752. OAuth?: UpdateBackendAuthOAuthConfig;
  1753. /**
  1754. * Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
  1755. */
  1756. PasswordPolicy?: UpdateBackendAuthPasswordPolicyConfig;
  1757. /**
  1758. * Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
  1759. */
  1760. VerificationMessage?: UpdateBackendAuthVerificationMessageConfig;
  1761. }
  1762. export interface UpdateBackendAuthVerificationMessageConfig {
  1763. /**
  1764. * The type of verification message to send.
  1765. */
  1766. DeliveryMethod: DeliveryMethod;
  1767. /**
  1768. * The settings for the email message.
  1769. */
  1770. EmailSettings?: EmailSettings;
  1771. /**
  1772. * The settings for the SMS message.
  1773. */
  1774. SmsSettings?: SmsSettings;
  1775. }
  1776. export interface UpdateBackendConfigRequest {
  1777. /**
  1778. * The app ID.
  1779. */
  1780. AppId: __string;
  1781. /**
  1782. * Describes the Amazon Cognito configuration for Admin UI access.
  1783. */
  1784. LoginAuthConfig?: LoginAuthConfigReqObj;
  1785. }
  1786. export interface UpdateBackendConfigResponse {
  1787. /**
  1788. * The app ID.
  1789. */
  1790. AppId?: __string;
  1791. /**
  1792. * The app ID for the backend manager.
  1793. */
  1794. BackendManagerAppId?: __string;
  1795. /**
  1796. * If the request fails, this error is returned.
  1797. */
  1798. Error?: __string;
  1799. /**
  1800. * Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.
  1801. */
  1802. LoginAuthConfig?: LoginAuthConfigReqObj;
  1803. }
  1804. export interface UpdateBackendJobRequest {
  1805. /**
  1806. * The app ID.
  1807. */
  1808. AppId: __string;
  1809. /**
  1810. * The name of the backend environment.
  1811. */
  1812. BackendEnvironmentName: __string;
  1813. /**
  1814. * The ID for the job.
  1815. */
  1816. JobId: __string;
  1817. /**
  1818. * Filters the list of response objects to include only those with the specified operation name.
  1819. */
  1820. Operation?: __string;
  1821. /**
  1822. * Filters the list of response objects to include only those with the specified status.
  1823. */
  1824. Status?: __string;
  1825. }
  1826. export interface UpdateBackendJobResponse {
  1827. /**
  1828. * The app ID.
  1829. */
  1830. AppId?: __string;
  1831. /**
  1832. * The name of the backend environment.
  1833. */
  1834. BackendEnvironmentName?: __string;
  1835. /**
  1836. * The time when the job was created.
  1837. */
  1838. CreateTime?: __string;
  1839. /**
  1840. * If the request fails, this error is returned.
  1841. */
  1842. Error?: __string;
  1843. /**
  1844. * The ID for the job.
  1845. */
  1846. JobId?: __string;
  1847. /**
  1848. * The name of the operation.
  1849. */
  1850. Operation?: __string;
  1851. /**
  1852. * The current status of the request.
  1853. */
  1854. Status?: __string;
  1855. /**
  1856. * The time when the job was last updated.
  1857. */
  1858. UpdateTime?: __string;
  1859. }
  1860. export interface UpdateBackendStorageRequest {
  1861. /**
  1862. * The app ID.
  1863. */
  1864. AppId: __string;
  1865. /**
  1866. * The name of the backend environment.
  1867. */
  1868. BackendEnvironmentName: __string;
  1869. /**
  1870. * The resource configuration for updating backend storage.
  1871. */
  1872. ResourceConfig: UpdateBackendStorageResourceConfig;
  1873. /**
  1874. * The name of the storage resource.
  1875. */
  1876. ResourceName: __string;
  1877. }
  1878. export interface UpdateBackendStorageResourceConfig {
  1879. /**
  1880. * The authorization configuration for the storage S3 bucket.
  1881. */
  1882. Permissions: BackendStoragePermissions;
  1883. /**
  1884. * The name of the storage service.
  1885. */
  1886. ServiceName: ServiceName;
  1887. }
  1888. export interface UpdateBackendStorageResponse {
  1889. /**
  1890. * The app ID.
  1891. */
  1892. AppId?: __string;
  1893. /**
  1894. * The name of the backend environment.
  1895. */
  1896. BackendEnvironmentName?: __string;
  1897. /**
  1898. * The ID for the job.
  1899. */
  1900. JobId?: __string;
  1901. /**
  1902. * The current status of the request.
  1903. */
  1904. Status?: __string;
  1905. }
  1906. export type AdditionalConstraintsElement = "REQUIRE_DIGIT"|"REQUIRE_LOWERCASE"|"REQUIRE_SYMBOL"|"REQUIRE_UPPERCASE"|string;
  1907. export type AuthenticatedElement = "READ"|"CREATE_AND_UPDATE"|"DELETE"|string;
  1908. export type MfaTypesElement = "SMS"|"TOTP"|string;
  1909. export type OAuthScopesElement = "PHONE"|"EMAIL"|"OPENID"|"PROFILE"|"AWS_COGNITO_SIGNIN_USER_ADMIN"|string;
  1910. 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;
  1911. export type UnAuthenticatedElement = "READ"|"CREATE_AND_UPDATE"|"DELETE"|string;
  1912. export type __boolean = boolean;
  1913. export type __double = number;
  1914. export type __integerMin1Max25 = number;
  1915. export type ListOfBackendAPIAuthType = BackendAPIAuthType[];
  1916. export type ListOfBackendJobRespObj = BackendJobRespObj[];
  1917. export type ListOfS3BucketInfo = S3BucketInfo[];
  1918. export type ListOfAdditionalConstraintsElement = AdditionalConstraintsElement[];
  1919. export type ListOfAuthenticatedElement = AuthenticatedElement[];
  1920. export type ListOfMfaTypesElement = MfaTypesElement[];
  1921. export type ListOfOAuthScopesElement = OAuthScopesElement[];
  1922. export type ListOfRequiredSignUpAttributesElement = RequiredSignUpAttributesElement[];
  1923. export type ListOfUnAuthenticatedElement = UnAuthenticatedElement[];
  1924. export type ListOf__string = __string[];
  1925. export type __string = string;
  1926. /**
  1927. * 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.
  1928. */
  1929. export type apiVersion = "2020-08-11"|"latest"|string;
  1930. export interface ClientApiVersions {
  1931. /**
  1932. * 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.
  1933. */
  1934. apiVersion?: apiVersion;
  1935. }
  1936. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  1937. /**
  1938. * Contains interfaces for use with the AmplifyBackend client.
  1939. */
  1940. export import Types = AmplifyBackend;
  1941. }
  1942. export = AmplifyBackend;