@aws-sdk/client-amplifybackend 3.529.1 → 3.535.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. package/dist-types/AmplifyBackend.d.ts +2 -1
  2. package/dist-types/AmplifyBackendClient.d.ts +1 -1
  3. package/dist-types/commands/CloneBackendCommand.d.ts +2 -1
  4. package/dist-types/commands/CreateBackendAPICommand.d.ts +2 -1
  5. package/dist-types/commands/CreateBackendAuthCommand.d.ts +2 -1
  6. package/dist-types/commands/CreateBackendCommand.d.ts +2 -1
  7. package/dist-types/commands/CreateBackendConfigCommand.d.ts +2 -1
  8. package/dist-types/commands/CreateBackendStorageCommand.d.ts +2 -1
  9. package/dist-types/commands/CreateTokenCommand.d.ts +2 -1
  10. package/dist-types/commands/DeleteBackendAPICommand.d.ts +2 -1
  11. package/dist-types/commands/DeleteBackendAuthCommand.d.ts +2 -1
  12. package/dist-types/commands/DeleteBackendCommand.d.ts +2 -1
  13. package/dist-types/commands/DeleteBackendStorageCommand.d.ts +2 -1
  14. package/dist-types/commands/DeleteTokenCommand.d.ts +2 -1
  15. package/dist-types/commands/GenerateBackendAPIModelsCommand.d.ts +2 -1
  16. package/dist-types/commands/GetBackendAPICommand.d.ts +2 -1
  17. package/dist-types/commands/GetBackendAPIModelsCommand.d.ts +2 -1
  18. package/dist-types/commands/GetBackendAuthCommand.d.ts +2 -1
  19. package/dist-types/commands/GetBackendCommand.d.ts +2 -1
  20. package/dist-types/commands/GetBackendJobCommand.d.ts +2 -1
  21. package/dist-types/commands/GetBackendStorageCommand.d.ts +2 -1
  22. package/dist-types/commands/GetTokenCommand.d.ts +2 -1
  23. package/dist-types/commands/ImportBackendAuthCommand.d.ts +2 -1
  24. package/dist-types/commands/ImportBackendStorageCommand.d.ts +2 -1
  25. package/dist-types/commands/ListBackendJobsCommand.d.ts +2 -1
  26. package/dist-types/commands/ListS3BucketsCommand.d.ts +2 -1
  27. package/dist-types/commands/RemoveAllBackendsCommand.d.ts +2 -1
  28. package/dist-types/commands/RemoveBackendConfigCommand.d.ts +2 -1
  29. package/dist-types/commands/UpdateBackendAPICommand.d.ts +2 -1
  30. package/dist-types/commands/UpdateBackendAuthCommand.d.ts +2 -1
  31. package/dist-types/commands/UpdateBackendConfigCommand.d.ts +2 -1
  32. package/dist-types/commands/UpdateBackendJobCommand.d.ts +2 -1
  33. package/dist-types/commands/UpdateBackendStorageCommand.d.ts +2 -1
  34. package/dist-types/models/models_0.d.ts +432 -432
  35. package/dist-types/runtimeConfig.browser.d.ts +2 -2
  36. package/dist-types/runtimeConfig.d.ts +2 -2
  37. package/dist-types/runtimeConfig.native.d.ts +2 -2
  38. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  39. package/dist-types/ts3.4/AmplifyBackend.d.ts +1 -0
  40. package/dist-types/ts3.4/commands/CloneBackendCommand.d.ts +9 -0
  41. package/dist-types/ts3.4/commands/CreateBackendAPICommand.d.ts +9 -0
  42. package/dist-types/ts3.4/commands/CreateBackendAuthCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/CreateBackendCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/CreateBackendConfigCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/CreateBackendStorageCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/CreateTokenCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/DeleteBackendAPICommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/DeleteBackendAuthCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/DeleteBackendCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/DeleteBackendStorageCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/DeleteTokenCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/GenerateBackendAPIModelsCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/GetBackendAPICommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/GetBackendAPIModelsCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/GetBackendAuthCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/GetBackendCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/GetBackendJobCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/GetBackendStorageCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/GetTokenCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/ImportBackendAuthCommand.d.ts +9 -0
  61. package/dist-types/ts3.4/commands/ImportBackendStorageCommand.d.ts +9 -0
  62. package/dist-types/ts3.4/commands/ListBackendJobsCommand.d.ts +9 -0
  63. package/dist-types/ts3.4/commands/ListS3BucketsCommand.d.ts +9 -0
  64. package/dist-types/ts3.4/commands/RemoveAllBackendsCommand.d.ts +9 -0
  65. package/dist-types/ts3.4/commands/RemoveBackendConfigCommand.d.ts +9 -0
  66. package/dist-types/ts3.4/commands/UpdateBackendAPICommand.d.ts +9 -0
  67. package/dist-types/ts3.4/commands/UpdateBackendAuthCommand.d.ts +9 -0
  68. package/dist-types/ts3.4/commands/UpdateBackendConfigCommand.d.ts +9 -0
  69. package/dist-types/ts3.4/commands/UpdateBackendJobCommand.d.ts +9 -0
  70. package/dist-types/ts3.4/commands/UpdateBackendStorageCommand.d.ts +9 -0
  71. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
  72. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
  73. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
  74. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
  75. package/package.json +40 -40
@@ -15,15 +15,15 @@ export declare const AdditionalConstraintsElement: {
15
15
  */
16
16
  export type AdditionalConstraintsElement = (typeof AdditionalConstraintsElement)[keyof typeof AdditionalConstraintsElement];
17
17
  /**
18
- * @public
19
18
  * <p>An error returned if a request is not formed properly.</p>
19
+ * @public
20
20
  */
21
21
  export declare class BadRequestException extends __BaseException {
22
22
  readonly name: "BadRequestException";
23
23
  readonly $fault: "client";
24
24
  /**
25
- * @public
26
25
  * <p>An error message to inform that the request failed.</p>
26
+ * @public
27
27
  */
28
28
  Message?: string;
29
29
  /**
@@ -32,23 +32,23 @@ export declare class BadRequestException extends __BaseException {
32
32
  constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
33
33
  }
34
34
  /**
35
- * @public
36
35
  * <p>The request body for CloneBackend.</p>
36
+ * @public
37
37
  */
38
38
  export interface CloneBackendRequest {
39
39
  /**
40
- * @public
41
40
  * <p>The app ID.</p>
41
+ * @public
42
42
  */
43
43
  AppId: string | undefined;
44
44
  /**
45
- * @public
46
45
  * <p>The name of the backend environment.</p>
46
+ * @public
47
47
  */
48
48
  BackendEnvironmentName: string | undefined;
49
49
  /**
50
- * @public
51
50
  * <p>The name of the destination backend environment to be created.</p>
51
+ * @public
52
52
  */
53
53
  TargetEnvironmentName: string | undefined;
54
54
  }
@@ -57,46 +57,46 @@ export interface CloneBackendRequest {
57
57
  */
58
58
  export interface CloneBackendResponse {
59
59
  /**
60
- * @public
61
60
  * <p>The app ID.</p>
61
+ * @public
62
62
  */
63
63
  AppId?: string;
64
64
  /**
65
- * @public
66
65
  * <p>The name of the backend environment.</p>
66
+ * @public
67
67
  */
68
68
  BackendEnvironmentName?: string;
69
69
  /**
70
- * @public
71
70
  * <p>If the request fails, this error is returned.</p>
71
+ * @public
72
72
  */
73
73
  Error?: string;
74
74
  /**
75
- * @public
76
75
  * <p>The ID for the job.</p>
76
+ * @public
77
77
  */
78
78
  JobId?: string;
79
79
  /**
80
- * @public
81
80
  * <p>The name of the operation.</p>
81
+ * @public
82
82
  */
83
83
  Operation?: string;
84
84
  /**
85
- * @public
86
85
  * <p>The current status of the request.</p>
86
+ * @public
87
87
  */
88
88
  Status?: string;
89
89
  }
90
90
  /**
91
- * @public
92
91
  * <p>An error returned if there's a temporary issue with the service.</p>
92
+ * @public
93
93
  */
94
94
  export declare class GatewayTimeoutException extends __BaseException {
95
95
  readonly name: "GatewayTimeoutException";
96
96
  readonly $fault: "server";
97
97
  /**
98
- * @public
99
98
  * <p>An error message to inform that the request failed.</p>
99
+ * @public
100
100
  */
101
101
  Message?: string;
102
102
  /**
@@ -105,20 +105,20 @@ export declare class GatewayTimeoutException extends __BaseException {
105
105
  constructor(opts: __ExceptionOptionType<GatewayTimeoutException, __BaseException>);
106
106
  }
107
107
  /**
108
- * @public
109
108
  * <p>An error returned when a specific resource type is not found.</p>
109
+ * @public
110
110
  */
111
111
  export declare class NotFoundException extends __BaseException {
112
112
  readonly name: "NotFoundException";
113
113
  readonly $fault: "client";
114
114
  /**
115
- * @public
116
115
  * <p>An error message to inform that the request has failed.</p>
116
+ * @public
117
117
  */
118
118
  Message?: string;
119
119
  /**
120
- * @public
121
120
  * <p>The type of resource that is not found.</p>
121
+ * @public
122
122
  */
123
123
  ResourceType?: string;
124
124
  /**
@@ -127,20 +127,20 @@ export declare class NotFoundException extends __BaseException {
127
127
  constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
128
128
  }
129
129
  /**
130
- * @public
131
130
  * <p>An error that is returned when a limit of a specific type has been exceeded.</p>
131
+ * @public
132
132
  */
133
133
  export declare class TooManyRequestsException extends __BaseException {
134
134
  readonly name: "TooManyRequestsException";
135
135
  readonly $fault: "client";
136
136
  /**
137
- * @public
138
137
  * <p>The type of limit that was exceeded.</p>
138
+ * @public
139
139
  */
140
140
  LimitType?: string;
141
141
  /**
142
- * @public
143
142
  * <p>An error message to inform that the request has failed.</p>
143
+ * @public
144
144
  */
145
145
  Message?: string;
146
146
  /**
@@ -149,39 +149,39 @@ export declare class TooManyRequestsException extends __BaseException {
149
149
  constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
150
150
  }
151
151
  /**
152
- * @public
153
152
  * <p>Defines the resource configuration for the data model in your Amplify project.</p>
153
+ * @public
154
154
  */
155
155
  export interface ResourceConfig {
156
156
  }
157
157
  /**
158
- * @public
159
158
  * <p>The request body for CreateBackend.</p>
159
+ * @public
160
160
  */
161
161
  export interface CreateBackendRequest {
162
162
  /**
163
- * @public
164
163
  * <p>The app ID.</p>
164
+ * @public
165
165
  */
166
166
  AppId: string | undefined;
167
167
  /**
168
- * @public
169
168
  * <p>The name of the app.</p>
169
+ * @public
170
170
  */
171
171
  AppName: string | undefined;
172
172
  /**
173
- * @public
174
173
  * <p>The name of the backend environment.</p>
174
+ * @public
175
175
  */
176
176
  BackendEnvironmentName: string | undefined;
177
177
  /**
178
- * @public
179
178
  * <p>The resource configuration for creating a backend.</p>
179
+ * @public
180
180
  */
181
181
  ResourceConfig?: ResourceConfig;
182
182
  /**
183
- * @public
184
183
  * <p>The name of the resource.</p>
184
+ * @public
185
185
  */
186
186
  ResourceName?: string;
187
187
  }
@@ -190,33 +190,33 @@ export interface CreateBackendRequest {
190
190
  */
191
191
  export interface CreateBackendResponse {
192
192
  /**
193
- * @public
194
193
  * <p>The app ID.</p>
194
+ * @public
195
195
  */
196
196
  AppId?: string;
197
197
  /**
198
- * @public
199
198
  * <p>The name of the backend environment.</p>
199
+ * @public
200
200
  */
201
201
  BackendEnvironmentName?: string;
202
202
  /**
203
- * @public
204
203
  * <p>If the request fails, this error is returned.</p>
204
+ * @public
205
205
  */
206
206
  Error?: string;
207
207
  /**
208
- * @public
209
208
  * <p>The ID for the job.</p>
209
+ * @public
210
210
  */
211
211
  JobId?: string;
212
212
  /**
213
- * @public
214
213
  * <p>The name of the operation.</p>
214
+ * @public
215
215
  */
216
216
  Operation?: string;
217
217
  /**
218
- * @public
219
218
  * <p>The current status of the request.</p>
219
+ * @public
220
220
  */
221
221
  Status?: string;
222
222
  }
@@ -235,64 +235,64 @@ export declare const Mode: {
235
235
  */
236
236
  export type Mode = (typeof Mode)[keyof typeof Mode];
237
237
  /**
238
- * @public
239
238
  * <p>The authentication settings for accessing provisioned data models in your Amplify project.</p>
239
+ * @public
240
240
  */
241
241
  export interface BackendAPIAppSyncAuthSettings {
242
242
  /**
243
- * @public
244
243
  * <p>The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.</p>
244
+ * @public
245
245
  */
246
246
  CognitoUserPoolId?: string;
247
247
  /**
248
- * @public
249
248
  * <p>The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.</p>
249
+ * @public
250
250
  */
251
251
  Description?: string;
252
252
  /**
253
- * @public
254
253
  * <p>The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.</p>
254
+ * @public
255
255
  */
256
256
  ExpirationTime?: number;
257
257
  /**
258
- * @public
259
258
  * <p>The expiry time for the OpenID authentication mechanism.</p>
259
+ * @public
260
260
  */
261
261
  OpenIDAuthTTL?: string;
262
262
  /**
263
- * @public
264
263
  * <p>The clientID for openID, if openID was used as an authentication setting to access your data models.</p>
264
+ * @public
265
265
  */
266
266
  OpenIDClientId?: string;
267
267
  /**
268
- * @public
269
268
  * <p>The expiry time for the OpenID authentication mechanism.</p>
269
+ * @public
270
270
  */
271
271
  OpenIDIatTTL?: string;
272
272
  /**
273
- * @public
274
273
  * <p>The openID issuer URL, if openID was used as an authentication setting to access your data models.</p>
274
+ * @public
275
275
  */
276
276
  OpenIDIssueURL?: string;
277
277
  /**
278
- * @public
279
278
  * <p>The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.</p>
279
+ * @public
280
280
  */
281
281
  OpenIDProviderName?: string;
282
282
  }
283
283
  /**
284
- * @public
285
284
  * <p>Describes the auth types for your configured data models.</p>
285
+ * @public
286
286
  */
287
287
  export interface BackendAPIAuthType {
288
288
  /**
289
- * @public
290
289
  * <p>Describes the authentication mode.</p>
290
+ * @public
291
291
  */
292
292
  Mode?: Mode;
293
293
  /**
294
- * @public
295
294
  * <p>Describes settings for the authentication mode.</p>
295
+ * @public
296
296
  */
297
297
  Settings?: BackendAPIAppSyncAuthSettings;
298
298
  }
@@ -311,75 +311,75 @@ export declare const ResolutionStrategy: {
311
311
  */
312
312
  export type ResolutionStrategy = (typeof ResolutionStrategy)[keyof typeof ResolutionStrategy];
313
313
  /**
314
- * @public
315
314
  * <p>Describes the conflict resolution configuration for your data model configured in your Amplify project.</p>
315
+ * @public
316
316
  */
317
317
  export interface BackendAPIConflictResolution {
318
318
  /**
319
- * @public
320
319
  * <p>The strategy for conflict resolution.</p>
320
+ * @public
321
321
  */
322
322
  ResolutionStrategy?: ResolutionStrategy;
323
323
  }
324
324
  /**
325
- * @public
326
325
  * <p>The resource config for the data model, configured as a part of the Amplify project.</p>
326
+ * @public
327
327
  */
328
328
  export interface BackendAPIResourceConfig {
329
329
  /**
330
- * @public
331
330
  * <p>Additional authentication methods used to interact with your data models.</p>
331
+ * @public
332
332
  */
333
333
  AdditionalAuthTypes?: BackendAPIAuthType[];
334
334
  /**
335
- * @public
336
335
  * <p>The API name used to interact with the data model, configured as a part of your Amplify project.</p>
336
+ * @public
337
337
  */
338
338
  ApiName?: string;
339
339
  /**
340
- * @public
341
340
  * <p>The conflict resolution strategy for your data stored in the data models.</p>
341
+ * @public
342
342
  */
343
343
  ConflictResolution?: BackendAPIConflictResolution;
344
344
  /**
345
- * @public
346
345
  * <p>The default authentication type for interacting with the configured data models in your Amplify project.</p>
346
+ * @public
347
347
  */
348
348
  DefaultAuthType?: BackendAPIAuthType;
349
349
  /**
350
- * @public
351
350
  * <p>The service used to provision and interact with the data model.</p>
351
+ * @public
352
352
  */
353
353
  Service?: string;
354
354
  /**
355
- * @public
356
355
  * <p>The definition of the data model in the annotated transform of the GraphQL schema.</p>
356
+ * @public
357
357
  */
358
358
  TransformSchema?: string;
359
359
  }
360
360
  /**
361
- * @public
362
361
  * <p>The request body for CreateBackendAPI.</p>
362
+ * @public
363
363
  */
364
364
  export interface CreateBackendAPIRequest {
365
365
  /**
366
- * @public
367
366
  * <p>The app ID.</p>
367
+ * @public
368
368
  */
369
369
  AppId: string | undefined;
370
370
  /**
371
- * @public
372
371
  * <p>The name of the backend environment.</p>
372
+ * @public
373
373
  */
374
374
  BackendEnvironmentName: string | undefined;
375
375
  /**
376
- * @public
377
376
  * <p>The resource configuration for this request.</p>
377
+ * @public
378
378
  */
379
379
  ResourceConfig: BackendAPIResourceConfig | undefined;
380
380
  /**
381
- * @public
382
381
  * <p>The name of this resource.</p>
382
+ * @public
383
383
  */
384
384
  ResourceName: string | undefined;
385
385
  }
@@ -388,33 +388,33 @@ export interface CreateBackendAPIRequest {
388
388
  */
389
389
  export interface CreateBackendAPIResponse {
390
390
  /**
391
- * @public
392
391
  * <p>The app ID.</p>
392
+ * @public
393
393
  */
394
394
  AppId?: string;
395
395
  /**
396
- * @public
397
396
  * <p>The name of the backend environment.</p>
397
+ * @public
398
398
  */
399
399
  BackendEnvironmentName?: string;
400
400
  /**
401
- * @public
402
401
  * <p>If the request fails, this error is returned.</p>
402
+ * @public
403
403
  */
404
404
  Error?: string;
405
405
  /**
406
- * @public
407
406
  * <p>The ID for the job.</p>
407
+ * @public
408
408
  */
409
409
  JobId?: string;
410
410
  /**
411
- * @public
412
411
  * <p>The name of the operation.</p>
412
+ * @public
413
413
  */
414
414
  Operation?: string;
415
415
  /**
416
- * @public
417
416
  * <p>The current status of the request.</p>
417
+ * @public
418
418
  */
419
419
  Status?: string;
420
420
  }
@@ -431,18 +431,18 @@ export declare const AuthResources: {
431
431
  */
432
432
  export type AuthResources = (typeof AuthResources)[keyof typeof AuthResources];
433
433
  /**
434
- * @public
435
434
  * <p>Describes authorization configurations for the auth resources, configured as a part of your Amplify project.</p>
435
+ * @public
436
436
  */
437
437
  export interface CreateBackendAuthIdentityPoolConfig {
438
438
  /**
439
- * @public
440
439
  * <p>Name of the Amazon Cognito identity pool used for authorization.</p>
440
+ * @public
441
441
  */
442
442
  IdentityPoolName: string | undefined;
443
443
  /**
444
- * @public
445
444
  * <p>Set to true or false based on whether you want to enable guest authorization to your Amplify app.</p>
445
+ * @public
446
446
  */
447
447
  UnauthenticatedLogin: boolean | undefined;
448
448
  }
@@ -470,50 +470,50 @@ export declare const DeliveryMethod: {
470
470
  */
471
471
  export type DeliveryMethod = (typeof DeliveryMethod)[keyof typeof DeliveryMethod];
472
472
  /**
473
- * @public
474
473
  * <p>The configuration for the email sent when an app user forgets their password.</p>
474
+ * @public
475
475
  */
476
476
  export interface EmailSettings {
477
477
  /**
478
- * @public
479
478
  * <p>The contents of the email message.</p>
479
+ * @public
480
480
  */
481
481
  EmailMessage?: string;
482
482
  /**
483
- * @public
484
483
  * <p>The contents of the subject line of the email message.</p>
484
+ * @public
485
485
  */
486
486
  EmailSubject?: string;
487
487
  }
488
488
  /**
489
- * @public
490
489
  * <p>SMS settings for authentication.</p>
490
+ * @public
491
491
  */
492
492
  export interface SmsSettings {
493
493
  /**
494
- * @public
495
494
  * <p>The contents of the SMS message.</p>
495
+ * @public
496
496
  */
497
497
  SmsMessage?: string;
498
498
  }
499
499
  /**
500
- * @public
501
500
  * <p><b>(DEPRECATED)</b> Describes the forgot password policy for authenticating into the Amplify app.</p>
501
+ * @public
502
502
  */
503
503
  export interface CreateBackendAuthForgotPasswordConfig {
504
504
  /**
505
- * @public
506
505
  * <p><b>(DEPRECATED)</b> Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.</p>
506
+ * @public
507
507
  */
508
508
  DeliveryMethod: DeliveryMethod | undefined;
509
509
  /**
510
- * @public
511
510
  * <p><b>(DEPRECATED)</b> The configuration for the email sent when an app user forgets their password.</p>
511
+ * @public
512
512
  */
513
513
  EmailSettings?: EmailSettings;
514
514
  /**
515
- * @public
516
515
  * <p><b>(DEPRECATED)</b> The configuration for the SMS message sent when an app user forgets their password.</p>
516
+ * @public
517
517
  */
518
518
  SmsSettings?: SmsSettings;
519
519
  }
@@ -543,34 +543,34 @@ export declare const MfaTypesElement: {
543
543
  */
544
544
  export type MfaTypesElement = (typeof MfaTypesElement)[keyof typeof MfaTypesElement];
545
545
  /**
546
- * @public
547
546
  * <p>The settings of your MFA configuration for the backend of your Amplify project.</p>
547
+ * @public
548
548
  */
549
549
  export interface Settings {
550
550
  /**
551
- * @public
552
551
  * <p>The supported MFA types.</p>
552
+ * @public
553
553
  */
554
554
  MfaTypes?: MfaTypesElement[];
555
555
  /**
556
- * @public
557
556
  * <p>The body of the SMS message.</p>
557
+ * @public
558
558
  */
559
559
  SmsMessage?: string;
560
560
  }
561
561
  /**
562
- * @public
563
562
  * <p>Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.</p>
563
+ * @public
564
564
  */
565
565
  export interface CreateBackendAuthMFAConfig {
566
566
  /**
567
- * @public
568
567
  * <p>Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.</p>
568
+ * @public
569
569
  */
570
570
  MFAMode: MFAMode | undefined;
571
571
  /**
572
- * @public
573
572
  * <p>Describes the configuration settings and methods for your Amplify app users to use MFA.</p>
573
+ * @public
574
574
  */
575
575
  Settings?: Settings;
576
576
  }
@@ -602,122 +602,122 @@ export declare const OAuthScopesElement: {
602
602
  */
603
603
  export type OAuthScopesElement = (typeof OAuthScopesElement)[keyof typeof OAuthScopesElement];
604
604
  /**
605
- * @public
606
605
  * <p>Describes third-party social federation configurations for allowing your app users to sign in using OAuth.</p>
606
+ * @public
607
607
  */
608
608
  export interface BackendAuthSocialProviderConfig {
609
609
  /**
610
- * @public
611
610
  * <p>Describes the client_id, which can be obtained from the third-party social federation provider.</p>
611
+ * @public
612
612
  */
613
613
  ClientId?: string;
614
614
  /**
615
- * @public
616
615
  * <p>Describes the client_secret, which can be obtained from third-party social federation providers.</p>
616
+ * @public
617
617
  */
618
618
  ClientSecret?: string;
619
619
  }
620
620
  /**
621
- * @public
622
621
  * <p>Describes Apple social federation configurations for allowing your app users to sign in using OAuth.</p>
622
+ * @public
623
623
  */
624
624
  export interface BackendAuthAppleProviderConfig {
625
625
  /**
626
- * @public
627
626
  * <p>Describes the client_id (also called Services ID) that comes from Apple.</p>
627
+ * @public
628
628
  */
629
629
  ClientId?: string;
630
630
  /**
631
- * @public
632
631
  * <p>Describes the key_id that comes from Apple.</p>
632
+ * @public
633
633
  */
634
634
  KeyId?: string;
635
635
  /**
636
- * @public
637
636
  * <p>Describes the private_key that comes from Apple.</p>
637
+ * @public
638
638
  */
639
639
  PrivateKey?: string;
640
640
  /**
641
- * @public
642
641
  * <p>Describes the team_id that comes from Apple.</p>
642
+ * @public
643
643
  */
644
644
  TeamId?: string;
645
645
  }
646
646
  /**
647
- * @public
648
647
  * <p>The settings for using the social identity providers for access to your Amplify app.</p>
648
+ * @public
649
649
  */
650
650
  export interface SocialProviderSettings {
651
651
  /**
652
- * @public
653
652
  * <p>Describes third-party social federation configurations for allowing your app users to sign in using OAuth.</p>
653
+ * @public
654
654
  */
655
655
  Facebook?: BackendAuthSocialProviderConfig;
656
656
  /**
657
- * @public
658
657
  * <p>Describes third-party social federation configurations for allowing your app users to sign in using OAuth.</p>
658
+ * @public
659
659
  */
660
660
  Google?: BackendAuthSocialProviderConfig;
661
661
  /**
662
- * @public
663
662
  * <p>Describes third-party social federation configurations for allowing your app users to sign in using OAuth.</p>
663
+ * @public
664
664
  */
665
665
  LoginWithAmazon?: BackendAuthSocialProviderConfig;
666
666
  /**
667
- * @public
668
667
  * <p>Describes Apple social federation configurations for allowing your app users to sign in using OAuth.</p>
668
+ * @public
669
669
  */
670
670
  SignInWithApple?: BackendAuthAppleProviderConfig;
671
671
  }
672
672
  /**
673
- * @public
674
673
  * <p>Creates the OAuth configuration for your Amplify project.</p>
674
+ * @public
675
675
  */
676
676
  export interface CreateBackendAuthOAuthConfig {
677
677
  /**
678
- * @public
679
678
  * <p>The domain prefix for your Amplify app.</p>
679
+ * @public
680
680
  */
681
681
  DomainPrefix?: string;
682
682
  /**
683
- * @public
684
683
  * <p>The OAuth grant type that you use to allow app users to authenticate from your Amplify app.</p>
684
+ * @public
685
685
  */
686
686
  OAuthGrantType: OAuthGrantType | undefined;
687
687
  /**
688
- * @public
689
688
  * <p>List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.</p>
689
+ * @public
690
690
  */
691
691
  OAuthScopes: OAuthScopesElement[] | undefined;
692
692
  /**
693
- * @public
694
693
  * <p>The redirected URI for signing in to your Amplify app.</p>
694
+ * @public
695
695
  */
696
696
  RedirectSignInURIs: string[] | undefined;
697
697
  /**
698
- * @public
699
698
  * <p>Redirect URLs that OAuth uses when a user signs out of an Amplify app.</p>
699
+ * @public
700
700
  */
701
701
  RedirectSignOutURIs: string[] | undefined;
702
702
  /**
703
- * @public
704
703
  * <p>The settings for using social providers to access your Amplify app.</p>
704
+ * @public
705
705
  */
706
706
  SocialProviderSettings?: SocialProviderSettings;
707
707
  }
708
708
  /**
709
- * @public
710
709
  * <p>The password policy configuration for the backend to your Amplify project.</p>
710
+ * @public
711
711
  */
712
712
  export interface CreateBackendAuthPasswordPolicyConfig {
713
713
  /**
714
- * @public
715
714
  * <p>Additional constraints for the password used to access the backend of your Amplify project.</p>
715
+ * @public
716
716
  */
717
717
  AdditionalConstraints?: AdditionalConstraintsElement[];
718
718
  /**
719
- * @public
720
719
  * <p>The minimum length of the password used to access the backend of your Amplify project.</p>
720
+ * @public
721
721
  */
722
722
  MinimumLength: number | undefined;
723
723
  }
@@ -763,121 +763,121 @@ export declare const SignInMethod: {
763
763
  */
764
764
  export type SignInMethod = (typeof SignInMethod)[keyof typeof SignInMethod];
765
765
  /**
766
- * @public
767
766
  * <p>Creates an email or SMS verification message for the auth resource configured for your Amplify project.</p>
767
+ * @public
768
768
  */
769
769
  export interface CreateBackendAuthVerificationMessageConfig {
770
770
  /**
771
- * @public
772
771
  * <p>The type of verification message to send.</p>
772
+ * @public
773
773
  */
774
774
  DeliveryMethod: DeliveryMethod | undefined;
775
775
  /**
776
- * @public
777
776
  * <p>The settings for the email message.</p>
777
+ * @public
778
778
  */
779
779
  EmailSettings?: EmailSettings;
780
780
  /**
781
- * @public
782
781
  * <p>The settings for the SMS message.</p>
782
+ * @public
783
783
  */
784
784
  SmsSettings?: SmsSettings;
785
785
  }
786
786
  /**
787
- * @public
788
787
  * <p>Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.</p>
788
+ * @public
789
789
  */
790
790
  export interface CreateBackendAuthUserPoolConfig {
791
791
  /**
792
- * @public
793
792
  * <p><b>(DEPRECATED)</b> Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>
793
+ * @public
794
794
  */
795
795
  ForgotPassword?: CreateBackendAuthForgotPasswordConfig;
796
796
  /**
797
- * @public
798
797
  * <p>Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.</p>
798
+ * @public
799
799
  */
800
800
  Mfa?: CreateBackendAuthMFAConfig;
801
801
  /**
802
- * @public
803
802
  * <p>Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>
803
+ * @public
804
804
  */
805
805
  OAuth?: CreateBackendAuthOAuthConfig;
806
806
  /**
807
- * @public
808
807
  * <p>Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>
808
+ * @public
809
809
  */
810
810
  PasswordPolicy?: CreateBackendAuthPasswordPolicyConfig;
811
811
  /**
812
- * @public
813
812
  * <p>The required attributes to sign up new users in the user pool.</p>
813
+ * @public
814
814
  */
815
815
  RequiredSignUpAttributes: RequiredSignUpAttributesElement[] | undefined;
816
816
  /**
817
- * @public
818
817
  * <p>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.</p>
818
+ * @public
819
819
  */
820
820
  SignInMethod: SignInMethod | undefined;
821
821
  /**
822
- * @public
823
822
  * <p>The Amazon Cognito user pool name.</p>
823
+ * @public
824
824
  */
825
825
  UserPoolName: string | undefined;
826
826
  /**
827
- * @public
828
827
  * <p>Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>
828
+ * @public
829
829
  */
830
830
  VerificationMessage?: CreateBackendAuthVerificationMessageConfig;
831
831
  }
832
832
  /**
833
- * @public
834
833
  * <p>Defines the resource configuration when creating an auth resource in your Amplify project.</p>
834
+ * @public
835
835
  */
836
836
  export interface CreateBackendAuthResourceConfig {
837
837
  /**
838
- * @public
839
838
  * <p>Defines whether you want to configure only authentication or both authentication and authorization settings.</p>
839
+ * @public
840
840
  */
841
841
  AuthResources: AuthResources | undefined;
842
842
  /**
843
- * @public
844
843
  * <p>Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.</p>
844
+ * @public
845
845
  */
846
846
  IdentityPoolConfigs?: CreateBackendAuthIdentityPoolConfig;
847
847
  /**
848
- * @public
849
848
  * <p>Defines the service name to use when configuring an authentication resource in your Amplify project.</p>
849
+ * @public
850
850
  */
851
851
  Service: Service | undefined;
852
852
  /**
853
- * @public
854
853
  * <p>Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.</p>
854
+ * @public
855
855
  */
856
856
  UserPoolConfigs: CreateBackendAuthUserPoolConfig | undefined;
857
857
  }
858
858
  /**
859
- * @public
860
859
  * <p>The request body for CreateBackendAuth.</p>
860
+ * @public
861
861
  */
862
862
  export interface CreateBackendAuthRequest {
863
863
  /**
864
- * @public
865
864
  * <p>The app ID.</p>
865
+ * @public
866
866
  */
867
867
  AppId: string | undefined;
868
868
  /**
869
- * @public
870
869
  * <p>The name of the backend environment.</p>
870
+ * @public
871
871
  */
872
872
  BackendEnvironmentName: string | undefined;
873
873
  /**
874
- * @public
875
874
  * <p>The resource configuration for this request object.</p>
875
+ * @public
876
876
  */
877
877
  ResourceConfig: CreateBackendAuthResourceConfig | undefined;
878
878
  /**
879
- * @public
880
879
  * <p>The name of this resource.</p>
880
+ * @public
881
881
  */
882
882
  ResourceName: string | undefined;
883
883
  }
@@ -886,49 +886,49 @@ export interface CreateBackendAuthRequest {
886
886
  */
887
887
  export interface CreateBackendAuthResponse {
888
888
  /**
889
- * @public
890
889
  * <p>The app ID.</p>
890
+ * @public
891
891
  */
892
892
  AppId?: string;
893
893
  /**
894
- * @public
895
894
  * <p>The name of the backend environment.</p>
895
+ * @public
896
896
  */
897
897
  BackendEnvironmentName?: string;
898
898
  /**
899
- * @public
900
899
  * <p>If the request fails, this error is returned.</p>
900
+ * @public
901
901
  */
902
902
  Error?: string;
903
903
  /**
904
- * @public
905
904
  * <p>The ID for the job.</p>
905
+ * @public
906
906
  */
907
907
  JobId?: string;
908
908
  /**
909
- * @public
910
909
  * <p>The name of the operation.</p>
910
+ * @public
911
911
  */
912
912
  Operation?: string;
913
913
  /**
914
- * @public
915
914
  * <p>The current status of the request.</p>
915
+ * @public
916
916
  */
917
917
  Status?: string;
918
918
  }
919
919
  /**
920
- * @public
921
920
  * <p>The request body for CreateBackendConfig.</p>
921
+ * @public
922
922
  */
923
923
  export interface CreateBackendConfigRequest {
924
924
  /**
925
- * @public
926
925
  * <p>The app ID.</p>
926
+ * @public
927
927
  */
928
928
  AppId: string | undefined;
929
929
  /**
930
- * @public
931
930
  * <p>The app ID for the backend manager.</p>
931
+ * @public
932
932
  */
933
933
  BackendManagerAppId?: string;
934
934
  }
@@ -937,23 +937,23 @@ export interface CreateBackendConfigRequest {
937
937
  */
938
938
  export interface CreateBackendConfigResponse {
939
939
  /**
940
- * @public
941
940
  * <p>The app ID.</p>
941
+ * @public
942
942
  */
943
943
  AppId?: string;
944
944
  /**
945
- * @public
946
945
  * <p>The name of the backend environment.</p>
946
+ * @public
947
947
  */
948
948
  BackendEnvironmentName?: string;
949
949
  /**
950
- * @public
951
950
  * <p>The ID for the job.</p>
951
+ * @public
952
952
  */
953
953
  JobId?: string;
954
954
  /**
955
- * @public
956
955
  * <p>The current status of the request.</p>
956
+ * @public
957
957
  */
958
958
  Status?: string;
959
959
  }
@@ -984,18 +984,18 @@ export declare const UnAuthenticatedElement: {
984
984
  */
985
985
  export type UnAuthenticatedElement = (typeof UnAuthenticatedElement)[keyof typeof UnAuthenticatedElement];
986
986
  /**
987
- * @public
988
987
  * <p>Describes the read, write, and delete permissions users have against your storage S3 bucket.</p>
988
+ * @public
989
989
  */
990
990
  export interface BackendStoragePermissions {
991
991
  /**
992
- * @public
993
992
  * <p>Lists all authenticated user read, write, and delete permissions for your S3 bucket.</p>
993
+ * @public
994
994
  */
995
995
  Authenticated: AuthenticatedElement[] | undefined;
996
996
  /**
997
- * @public
998
997
  * <p>Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.</p>
998
+ * @public
999
999
  */
1000
1000
  UnAuthenticated?: UnAuthenticatedElement[];
1001
1001
  }
@@ -1011,49 +1011,49 @@ export declare const ServiceName: {
1011
1011
  */
1012
1012
  export type ServiceName = (typeof ServiceName)[keyof typeof ServiceName];
1013
1013
  /**
1014
- * @public
1015
1014
  * <p>The resource configuration for creating backend storage.</p>
1015
+ * @public
1016
1016
  */
1017
1017
  export interface CreateBackendStorageResourceConfig {
1018
1018
  /**
1019
- * @public
1020
1019
  * <p>The name of the S3 bucket.</p>
1020
+ * @public
1021
1021
  */
1022
1022
  BucketName?: string;
1023
1023
  /**
1024
- * @public
1025
1024
  * <p>The authorization configuration for the storage S3 bucket.</p>
1025
+ * @public
1026
1026
  */
1027
1027
  Permissions: BackendStoragePermissions | undefined;
1028
1028
  /**
1029
- * @public
1030
1029
  * <p>The name of the storage service.</p>
1030
+ * @public
1031
1031
  */
1032
1032
  ServiceName: ServiceName | undefined;
1033
1033
  }
1034
1034
  /**
1035
- * @public
1036
1035
  * <p>The request body for CreateBackendStorage.</p>
1036
+ * @public
1037
1037
  */
1038
1038
  export interface CreateBackendStorageRequest {
1039
1039
  /**
1040
- * @public
1041
1040
  * <p>The app ID.</p>
1041
+ * @public
1042
1042
  */
1043
1043
  AppId: string | undefined;
1044
1044
  /**
1045
- * @public
1046
1045
  * <p>The name of the backend environment.</p>
1046
+ * @public
1047
1047
  */
1048
1048
  BackendEnvironmentName: string | undefined;
1049
1049
  /**
1050
- * @public
1051
1050
  * <p>The resource configuration for creating backend storage.</p>
1051
+ * @public
1052
1052
  */
1053
1053
  ResourceConfig: CreateBackendStorageResourceConfig | undefined;
1054
1054
  /**
1055
- * @public
1056
1055
  * <p>The name of the storage resource.</p>
1056
+ * @public
1057
1057
  */
1058
1058
  ResourceName: string | undefined;
1059
1059
  }
@@ -1062,23 +1062,23 @@ export interface CreateBackendStorageRequest {
1062
1062
  */
1063
1063
  export interface CreateBackendStorageResponse {
1064
1064
  /**
1065
- * @public
1066
1065
  * <p>The app ID.</p>
1066
+ * @public
1067
1067
  */
1068
1068
  AppId?: string;
1069
1069
  /**
1070
- * @public
1071
1070
  * <p>The name of the backend environment.</p>
1071
+ * @public
1072
1072
  */
1073
1073
  BackendEnvironmentName?: string;
1074
1074
  /**
1075
- * @public
1076
1075
  * <p>The ID for the job.</p>
1076
+ * @public
1077
1077
  */
1078
1078
  JobId?: string;
1079
1079
  /**
1080
- * @public
1081
1080
  * <p>The current status of the request.</p>
1081
+ * @public
1082
1082
  */
1083
1083
  Status?: string;
1084
1084
  }
@@ -1087,8 +1087,8 @@ export interface CreateBackendStorageResponse {
1087
1087
  */
1088
1088
  export interface CreateTokenRequest {
1089
1089
  /**
1090
- * @public
1091
1090
  * <p>The app ID.</p>
1091
+ * @public
1092
1092
  */
1093
1093
  AppId: string | undefined;
1094
1094
  }
@@ -1097,23 +1097,23 @@ export interface CreateTokenRequest {
1097
1097
  */
1098
1098
  export interface CreateTokenResponse {
1099
1099
  /**
1100
- * @public
1101
1100
  * <p>The app ID.</p>
1101
+ * @public
1102
1102
  */
1103
1103
  AppId?: string;
1104
1104
  /**
1105
- * @public
1106
1105
  * <p>One-time challenge code for authenticating into the Amplify Admin UI.</p>
1106
+ * @public
1107
1107
  */
1108
1108
  ChallengeCode?: string;
1109
1109
  /**
1110
- * @public
1111
1110
  * <p>A unique ID provided when creating a new challenge token.</p>
1111
+ * @public
1112
1112
  */
1113
1113
  SessionId?: string;
1114
1114
  /**
1115
- * @public
1116
1115
  * <p>The expiry time for the one-time generated token code.</p>
1116
+ * @public
1117
1117
  */
1118
1118
  Ttl?: string;
1119
1119
  }
@@ -1122,13 +1122,13 @@ export interface CreateTokenResponse {
1122
1122
  */
1123
1123
  export interface DeleteBackendRequest {
1124
1124
  /**
1125
- * @public
1126
1125
  * <p>The app ID.</p>
1126
+ * @public
1127
1127
  */
1128
1128
  AppId: string | undefined;
1129
1129
  /**
1130
- * @public
1131
1130
  * <p>The name of the backend environment.</p>
1131
+ * @public
1132
1132
  */
1133
1133
  BackendEnvironmentName: string | undefined;
1134
1134
  }
@@ -1137,59 +1137,59 @@ export interface DeleteBackendRequest {
1137
1137
  */
1138
1138
  export interface DeleteBackendResponse {
1139
1139
  /**
1140
- * @public
1141
1140
  * <p>The app ID.</p>
1141
+ * @public
1142
1142
  */
1143
1143
  AppId?: string;
1144
1144
  /**
1145
- * @public
1146
1145
  * <p>The name of the backend environment.</p>
1146
+ * @public
1147
1147
  */
1148
1148
  BackendEnvironmentName?: string;
1149
1149
  /**
1150
- * @public
1151
1150
  * <p>If the request fails, this error is returned.</p>
1151
+ * @public
1152
1152
  */
1153
1153
  Error?: string;
1154
1154
  /**
1155
- * @public
1156
1155
  * <p>The ID for the job.</p>
1156
+ * @public
1157
1157
  */
1158
1158
  JobId?: string;
1159
1159
  /**
1160
- * @public
1161
1160
  * <p>The name of the operation.</p>
1161
+ * @public
1162
1162
  */
1163
1163
  Operation?: string;
1164
1164
  /**
1165
- * @public
1166
1165
  * <p>The current status of the request.</p>
1166
+ * @public
1167
1167
  */
1168
1168
  Status?: string;
1169
1169
  }
1170
1170
  /**
1171
- * @public
1172
1171
  * <p>The request body for DeleteBackendAPI.</p>
1172
+ * @public
1173
1173
  */
1174
1174
  export interface DeleteBackendAPIRequest {
1175
1175
  /**
1176
- * @public
1177
1176
  * <p>The app ID.</p>
1177
+ * @public
1178
1178
  */
1179
1179
  AppId: string | undefined;
1180
1180
  /**
1181
- * @public
1182
1181
  * <p>The name of the backend environment.</p>
1182
+ * @public
1183
1183
  */
1184
1184
  BackendEnvironmentName: string | undefined;
1185
1185
  /**
1186
- * @public
1187
1186
  * <p>Defines the resource configuration for the data model in your Amplify project.</p>
1187
+ * @public
1188
1188
  */
1189
1189
  ResourceConfig?: BackendAPIResourceConfig;
1190
1190
  /**
1191
- * @public
1192
1191
  * <p>The name of this resource.</p>
1192
+ * @public
1193
1193
  */
1194
1194
  ResourceName: string | undefined;
1195
1195
  }
@@ -1198,54 +1198,54 @@ export interface DeleteBackendAPIRequest {
1198
1198
  */
1199
1199
  export interface DeleteBackendAPIResponse {
1200
1200
  /**
1201
- * @public
1202
1201
  * <p>The app ID.</p>
1202
+ * @public
1203
1203
  */
1204
1204
  AppId?: string;
1205
1205
  /**
1206
- * @public
1207
1206
  * <p>The name of the backend environment.</p>
1207
+ * @public
1208
1208
  */
1209
1209
  BackendEnvironmentName?: string;
1210
1210
  /**
1211
- * @public
1212
1211
  * <p>If the request fails, this error is returned.</p>
1212
+ * @public
1213
1213
  */
1214
1214
  Error?: string;
1215
1215
  /**
1216
- * @public
1217
1216
  * <p>The ID for the job.</p>
1217
+ * @public
1218
1218
  */
1219
1219
  JobId?: string;
1220
1220
  /**
1221
- * @public
1222
1221
  * <p>The name of the operation.</p>
1222
+ * @public
1223
1223
  */
1224
1224
  Operation?: string;
1225
1225
  /**
1226
- * @public
1227
1226
  * <p>The current status of the request.</p>
1227
+ * @public
1228
1228
  */
1229
1229
  Status?: string;
1230
1230
  }
1231
1231
  /**
1232
- * @public
1233
1232
  * <p>The request body for DeleteBackendAuth.</p>
1233
+ * @public
1234
1234
  */
1235
1235
  export interface DeleteBackendAuthRequest {
1236
1236
  /**
1237
- * @public
1238
1237
  * <p>The app ID.</p>
1238
+ * @public
1239
1239
  */
1240
1240
  AppId: string | undefined;
1241
1241
  /**
1242
- * @public
1243
1242
  * <p>The name of the backend environment.</p>
1243
+ * @public
1244
1244
  */
1245
1245
  BackendEnvironmentName: string | undefined;
1246
1246
  /**
1247
- * @public
1248
1247
  * <p>The name of this resource.</p>
1248
+ * @public
1249
1249
  */
1250
1250
  ResourceName: string | undefined;
1251
1251
  }
@@ -1254,59 +1254,59 @@ export interface DeleteBackendAuthRequest {
1254
1254
  */
1255
1255
  export interface DeleteBackendAuthResponse {
1256
1256
  /**
1257
- * @public
1258
1257
  * <p>The app ID.</p>
1258
+ * @public
1259
1259
  */
1260
1260
  AppId?: string;
1261
1261
  /**
1262
- * @public
1263
1262
  * <p>The name of the backend environment.</p>
1263
+ * @public
1264
1264
  */
1265
1265
  BackendEnvironmentName?: string;
1266
1266
  /**
1267
- * @public
1268
1267
  * <p>If the request fails, this error is returned.</p>
1268
+ * @public
1269
1269
  */
1270
1270
  Error?: string;
1271
1271
  /**
1272
- * @public
1273
1272
  * <p>The ID for the job.</p>
1273
+ * @public
1274
1274
  */
1275
1275
  JobId?: string;
1276
1276
  /**
1277
- * @public
1278
1277
  * <p>The name of the operation.</p>
1278
+ * @public
1279
1279
  */
1280
1280
  Operation?: string;
1281
1281
  /**
1282
- * @public
1283
1282
  * <p>The current status of the request.</p>
1283
+ * @public
1284
1284
  */
1285
1285
  Status?: string;
1286
1286
  }
1287
1287
  /**
1288
- * @public
1289
1288
  * <p>The request body for DeleteBackendStorage.</p>
1289
+ * @public
1290
1290
  */
1291
1291
  export interface DeleteBackendStorageRequest {
1292
1292
  /**
1293
- * @public
1294
1293
  * <p>The app ID.</p>
1294
+ * @public
1295
1295
  */
1296
1296
  AppId: string | undefined;
1297
1297
  /**
1298
- * @public
1299
1298
  * <p>The name of the backend environment.</p>
1299
+ * @public
1300
1300
  */
1301
1301
  BackendEnvironmentName: string | undefined;
1302
1302
  /**
1303
- * @public
1304
1303
  * <p>The name of the storage resource.</p>
1304
+ * @public
1305
1305
  */
1306
1306
  ResourceName: string | undefined;
1307
1307
  /**
1308
- * @public
1309
1308
  * <p>The name of the storage service.</p>
1309
+ * @public
1310
1310
  */
1311
1311
  ServiceName: ServiceName | undefined;
1312
1312
  }
@@ -1315,23 +1315,23 @@ export interface DeleteBackendStorageRequest {
1315
1315
  */
1316
1316
  export interface DeleteBackendStorageResponse {
1317
1317
  /**
1318
- * @public
1319
1318
  * <p>The app ID.</p>
1319
+ * @public
1320
1320
  */
1321
1321
  AppId?: string;
1322
1322
  /**
1323
- * @public
1324
1323
  * <p>The name of the backend environment.</p>
1324
+ * @public
1325
1325
  */
1326
1326
  BackendEnvironmentName?: string;
1327
1327
  /**
1328
- * @public
1329
1328
  * <p>The ID for the job.</p>
1329
+ * @public
1330
1330
  */
1331
1331
  JobId?: string;
1332
1332
  /**
1333
- * @public
1334
1333
  * <p>The current status of the request.</p>
1334
+ * @public
1335
1335
  */
1336
1336
  Status?: string;
1337
1337
  }
@@ -1340,13 +1340,13 @@ export interface DeleteBackendStorageResponse {
1340
1340
  */
1341
1341
  export interface DeleteTokenRequest {
1342
1342
  /**
1343
- * @public
1344
1343
  * <p>The app ID.</p>
1344
+ * @public
1345
1345
  */
1346
1346
  AppId: string | undefined;
1347
1347
  /**
1348
- * @public
1349
1348
  * <p>The session ID.</p>
1349
+ * @public
1350
1350
  */
1351
1351
  SessionId: string | undefined;
1352
1352
  }
@@ -1355,29 +1355,29 @@ export interface DeleteTokenRequest {
1355
1355
  */
1356
1356
  export interface DeleteTokenResponse {
1357
1357
  /**
1358
- * @public
1359
1358
  * <p>Indicates whether the request succeeded or failed.</p>
1359
+ * @public
1360
1360
  */
1361
1361
  IsSuccess?: boolean;
1362
1362
  }
1363
1363
  /**
1364
- * @public
1365
1364
  * <p>The request body for GenerateBackendAPIModels.</p>
1365
+ * @public
1366
1366
  */
1367
1367
  export interface GenerateBackendAPIModelsRequest {
1368
1368
  /**
1369
- * @public
1370
1369
  * <p>The app ID.</p>
1370
+ * @public
1371
1371
  */
1372
1372
  AppId: string | undefined;
1373
1373
  /**
1374
- * @public
1375
1374
  * <p>The name of the backend environment.</p>
1375
+ * @public
1376
1376
  */
1377
1377
  BackendEnvironmentName: string | undefined;
1378
1378
  /**
1379
- * @public
1380
1379
  * <p>The name of this resource.</p>
1380
+ * @public
1381
1381
  */
1382
1382
  ResourceName: string | undefined;
1383
1383
  }
@@ -1386,49 +1386,49 @@ export interface GenerateBackendAPIModelsRequest {
1386
1386
  */
1387
1387
  export interface GenerateBackendAPIModelsResponse {
1388
1388
  /**
1389
- * @public
1390
1389
  * <p>The app ID.</p>
1390
+ * @public
1391
1391
  */
1392
1392
  AppId?: string;
1393
1393
  /**
1394
- * @public
1395
1394
  * <p>The name of the backend environment.</p>
1395
+ * @public
1396
1396
  */
1397
1397
  BackendEnvironmentName?: string;
1398
1398
  /**
1399
- * @public
1400
1399
  * <p>If the request fails, this error is returned.</p>
1400
+ * @public
1401
1401
  */
1402
1402
  Error?: string;
1403
1403
  /**
1404
- * @public
1405
1404
  * <p>The ID for the job.</p>
1405
+ * @public
1406
1406
  */
1407
1407
  JobId?: string;
1408
1408
  /**
1409
- * @public
1410
1409
  * <p>The name of the operation.</p>
1410
+ * @public
1411
1411
  */
1412
1412
  Operation?: string;
1413
1413
  /**
1414
- * @public
1415
1414
  * <p>The current status of the request.</p>
1415
+ * @public
1416
1416
  */
1417
1417
  Status?: string;
1418
1418
  }
1419
1419
  /**
1420
- * @public
1421
1420
  * <p>The request body for GetBackend.</p>
1421
+ * @public
1422
1422
  */
1423
1423
  export interface GetBackendRequest {
1424
1424
  /**
1425
- * @public
1426
1425
  * <p>The app ID.</p>
1426
+ * @public
1427
1427
  */
1428
1428
  AppId: string | undefined;
1429
1429
  /**
1430
- * @public
1431
1430
  * <p>The name of the backend environment.</p>
1431
+ * @public
1432
1432
  */
1433
1433
  BackendEnvironmentName?: string;
1434
1434
  }
@@ -1437,64 +1437,64 @@ export interface GetBackendRequest {
1437
1437
  */
1438
1438
  export interface GetBackendResponse {
1439
1439
  /**
1440
- * @public
1441
1440
  * <p>A stringified version of the cli.json file for your Amplify project.</p>
1441
+ * @public
1442
1442
  */
1443
1443
  AmplifyFeatureFlags?: string;
1444
1444
  /**
1445
- * @public
1446
1445
  * <p>A stringified version of the current configs for your Amplify project.</p>
1446
+ * @public
1447
1447
  */
1448
1448
  AmplifyMetaConfig?: string;
1449
1449
  /**
1450
- * @public
1451
1450
  * <p>The app ID.</p>
1451
+ * @public
1452
1452
  */
1453
1453
  AppId?: string;
1454
1454
  /**
1455
- * @public
1456
1455
  * <p>The name of the app.</p>
1456
+ * @public
1457
1457
  */
1458
1458
  AppName?: string;
1459
1459
  /**
1460
- * @public
1461
1460
  * <p>A list of backend environments in an array.</p>
1461
+ * @public
1462
1462
  */
1463
1463
  BackendEnvironmentList?: string[];
1464
1464
  /**
1465
- * @public
1466
1465
  * <p>The name of the backend environment.</p>
1466
+ * @public
1467
1467
  */
1468
1468
  BackendEnvironmentName?: string;
1469
1469
  /**
1470
- * @public
1471
1470
  * <p>If the request failed, this is the returned error.</p>
1471
+ * @public
1472
1472
  */
1473
1473
  Error?: string;
1474
1474
  }
1475
1475
  /**
1476
- * @public
1477
1476
  * <p>The request body for GetBackendAPI.</p>
1477
+ * @public
1478
1478
  */
1479
1479
  export interface GetBackendAPIRequest {
1480
1480
  /**
1481
- * @public
1482
1481
  * <p>The app ID.</p>
1482
+ * @public
1483
1483
  */
1484
1484
  AppId: string | undefined;
1485
1485
  /**
1486
- * @public
1487
1486
  * <p>The name of the backend environment.</p>
1487
+ * @public
1488
1488
  */
1489
1489
  BackendEnvironmentName: string | undefined;
1490
1490
  /**
1491
- * @public
1492
1491
  * <p>Defines the resource configuration for the data model in your Amplify project.</p>
1492
+ * @public
1493
1493
  */
1494
1494
  ResourceConfig?: BackendAPIResourceConfig;
1495
1495
  /**
1496
- * @public
1497
1496
  * <p>The name of this resource.</p>
1497
+ * @public
1498
1498
  */
1499
1499
  ResourceName: string | undefined;
1500
1500
  }
@@ -1503,49 +1503,49 @@ export interface GetBackendAPIRequest {
1503
1503
  */
1504
1504
  export interface GetBackendAPIResponse {
1505
1505
  /**
1506
- * @public
1507
1506
  * <p>The app ID.</p>
1507
+ * @public
1508
1508
  */
1509
1509
  AppId?: string;
1510
1510
  /**
1511
- * @public
1512
1511
  * <p>The name of the backend environment.</p>
1512
+ * @public
1513
1513
  */
1514
1514
  BackendEnvironmentName?: string;
1515
1515
  /**
1516
- * @public
1517
1516
  * <p>If the request fails, this error is returned.</p>
1517
+ * @public
1518
1518
  */
1519
1519
  Error?: string;
1520
1520
  /**
1521
- * @public
1522
1521
  * <p>The resource configuration for this response object.</p>
1522
+ * @public
1523
1523
  */
1524
1524
  ResourceConfig?: BackendAPIResourceConfig;
1525
1525
  /**
1526
- * @public
1527
1526
  * <p>The name of this resource.</p>
1527
+ * @public
1528
1528
  */
1529
1529
  ResourceName?: string;
1530
1530
  }
1531
1531
  /**
1532
- * @public
1533
1532
  * <p>The request body for GetBackendAPIModels.</p>
1533
+ * @public
1534
1534
  */
1535
1535
  export interface GetBackendAPIModelsRequest {
1536
1536
  /**
1537
- * @public
1538
1537
  * <p>The app ID.</p>
1538
+ * @public
1539
1539
  */
1540
1540
  AppId: string | undefined;
1541
1541
  /**
1542
- * @public
1543
1542
  * <p>The name of the backend environment.</p>
1543
+ * @public
1544
1544
  */
1545
1545
  BackendEnvironmentName: string | undefined;
1546
1546
  /**
1547
- * @public
1548
1547
  * <p>The name of this resource.</p>
1548
+ * @public
1549
1549
  */
1550
1550
  ResourceName: string | undefined;
1551
1551
  }
@@ -1566,39 +1566,39 @@ export type Status = (typeof Status)[keyof typeof Status];
1566
1566
  */
1567
1567
  export interface GetBackendAPIModelsResponse {
1568
1568
  /**
1569
- * @public
1570
1569
  * <p>Stringified JSON of the datastore model.</p>
1570
+ * @public
1571
1571
  */
1572
1572
  Models?: string;
1573
1573
  /**
1574
- * @public
1575
1574
  * <p>The current status of the request.</p>
1575
+ * @public
1576
1576
  */
1577
1577
  Status?: Status;
1578
1578
  /**
1579
- * @public
1580
1579
  * <p>Stringified JSON of the model introspection schema for an existing backend API resource.</p>
1580
+ * @public
1581
1581
  */
1582
1582
  ModelIntrospectionSchema?: string;
1583
1583
  }
1584
1584
  /**
1585
- * @public
1586
1585
  * <p>The request body for GetBackendAuth.</p>
1586
+ * @public
1587
1587
  */
1588
1588
  export interface GetBackendAuthRequest {
1589
1589
  /**
1590
- * @public
1591
1590
  * <p>The app ID.</p>
1591
+ * @public
1592
1592
  */
1593
1593
  AppId: string | undefined;
1594
1594
  /**
1595
- * @public
1596
1595
  * <p>The name of the backend environment.</p>
1596
+ * @public
1597
1597
  */
1598
1598
  BackendEnvironmentName: string | undefined;
1599
1599
  /**
1600
- * @public
1601
1600
  * <p>The name of this resource.</p>
1601
+ * @public
1602
1602
  */
1603
1603
  ResourceName: string | undefined;
1604
1604
  }
@@ -1607,28 +1607,28 @@ export interface GetBackendAuthRequest {
1607
1607
  */
1608
1608
  export interface GetBackendAuthResponse {
1609
1609
  /**
1610
- * @public
1611
1610
  * <p>The app ID.</p>
1611
+ * @public
1612
1612
  */
1613
1613
  AppId?: string;
1614
1614
  /**
1615
- * @public
1616
1615
  * <p>The name of the backend environment.</p>
1616
+ * @public
1617
1617
  */
1618
1618
  BackendEnvironmentName?: string;
1619
1619
  /**
1620
- * @public
1621
1620
  * <p>If the request fails, this error is returned.</p>
1621
+ * @public
1622
1622
  */
1623
1623
  Error?: string;
1624
1624
  /**
1625
- * @public
1626
1625
  * <p>The resource configuration for authorization requests to the backend of your Amplify project.</p>
1626
+ * @public
1627
1627
  */
1628
1628
  ResourceConfig?: CreateBackendAuthResourceConfig;
1629
1629
  /**
1630
- * @public
1631
1630
  * <p>The name of this resource.</p>
1631
+ * @public
1632
1632
  */
1633
1633
  ResourceName?: string;
1634
1634
  }
@@ -1637,18 +1637,18 @@ export interface GetBackendAuthResponse {
1637
1637
  */
1638
1638
  export interface GetBackendJobRequest {
1639
1639
  /**
1640
- * @public
1641
1640
  * <p>The app ID.</p>
1641
+ * @public
1642
1642
  */
1643
1643
  AppId: string | undefined;
1644
1644
  /**
1645
- * @public
1646
1645
  * <p>The name of the backend environment.</p>
1646
+ * @public
1647
1647
  */
1648
1648
  BackendEnvironmentName: string | undefined;
1649
1649
  /**
1650
- * @public
1651
1650
  * <p>The ID for the job.</p>
1651
+ * @public
1652
1652
  */
1653
1653
  JobId: string | undefined;
1654
1654
  }
@@ -1657,90 +1657,90 @@ export interface GetBackendJobRequest {
1657
1657
  */
1658
1658
  export interface GetBackendJobResponse {
1659
1659
  /**
1660
- * @public
1661
1660
  * <p>The app ID.</p>
1661
+ * @public
1662
1662
  */
1663
1663
  AppId?: string;
1664
1664
  /**
1665
- * @public
1666
1665
  * <p>The name of the backend environment.</p>
1666
+ * @public
1667
1667
  */
1668
1668
  BackendEnvironmentName?: string;
1669
1669
  /**
1670
- * @public
1671
1670
  * <p>The time when the job was created.</p>
1671
+ * @public
1672
1672
  */
1673
1673
  CreateTime?: string;
1674
1674
  /**
1675
- * @public
1676
1675
  * <p>If the request fails, this error is returned.</p>
1676
+ * @public
1677
1677
  */
1678
1678
  Error?: string;
1679
1679
  /**
1680
- * @public
1681
1680
  * <p>The ID for the job.</p>
1681
+ * @public
1682
1682
  */
1683
1683
  JobId?: string;
1684
1684
  /**
1685
- * @public
1686
1685
  * <p>The name of the operation.</p>
1686
+ * @public
1687
1687
  */
1688
1688
  Operation?: string;
1689
1689
  /**
1690
- * @public
1691
1690
  * <p>The current status of the request.</p>
1691
+ * @public
1692
1692
  */
1693
1693
  Status?: string;
1694
1694
  /**
1695
- * @public
1696
1695
  * <p>The time when the job was last updated.</p>
1696
+ * @public
1697
1697
  */
1698
1698
  UpdateTime?: string;
1699
1699
  }
1700
1700
  /**
1701
- * @public
1702
1701
  * <p>The request body for GetBackendStorage.</p>
1702
+ * @public
1703
1703
  */
1704
1704
  export interface GetBackendStorageRequest {
1705
1705
  /**
1706
- * @public
1707
1706
  * <p>The app ID.</p>
1707
+ * @public
1708
1708
  */
1709
1709
  AppId: string | undefined;
1710
1710
  /**
1711
- * @public
1712
1711
  * <p>The name of the backend environment.</p>
1712
+ * @public
1713
1713
  */
1714
1714
  BackendEnvironmentName: string | undefined;
1715
1715
  /**
1716
- * @public
1717
1716
  * <p>The name of the storage resource.</p>
1717
+ * @public
1718
1718
  */
1719
1719
  ResourceName: string | undefined;
1720
1720
  }
1721
1721
  /**
1722
- * @public
1723
1722
  * <p>The details for a backend storage resource.</p>
1723
+ * @public
1724
1724
  */
1725
1725
  export interface GetBackendStorageResourceConfig {
1726
1726
  /**
1727
- * @public
1728
1727
  * <p>The name of the S3 bucket.</p>
1728
+ * @public
1729
1729
  */
1730
1730
  BucketName?: string;
1731
1731
  /**
1732
- * @public
1733
1732
  * <p>Returns True if the storage resource has been imported.</p>
1733
+ * @public
1734
1734
  */
1735
1735
  Imported: boolean | undefined;
1736
1736
  /**
1737
- * @public
1738
1737
  * <p>The authorization configuration for the storage S3 bucket.</p>
1738
+ * @public
1739
1739
  */
1740
1740
  Permissions?: BackendStoragePermissions;
1741
1741
  /**
1742
- * @public
1743
1742
  * <p>The name of the storage service.</p>
1743
+ * @public
1744
1744
  */
1745
1745
  ServiceName: ServiceName | undefined;
1746
1746
  }
@@ -1749,23 +1749,23 @@ export interface GetBackendStorageResourceConfig {
1749
1749
  */
1750
1750
  export interface GetBackendStorageResponse {
1751
1751
  /**
1752
- * @public
1753
1752
  * <p>The app ID.</p>
1753
+ * @public
1754
1754
  */
1755
1755
  AppId?: string;
1756
1756
  /**
1757
- * @public
1758
1757
  * <p>The name of the backend environment.</p>
1758
+ * @public
1759
1759
  */
1760
1760
  BackendEnvironmentName?: string;
1761
1761
  /**
1762
- * @public
1763
1762
  * <p>The resource configuration for the backend storage resource.</p>
1763
+ * @public
1764
1764
  */
1765
1765
  ResourceConfig?: GetBackendStorageResourceConfig;
1766
1766
  /**
1767
- * @public
1768
1767
  * <p>The name of the storage resource.</p>
1768
+ * @public
1769
1769
  */
1770
1770
  ResourceName?: string;
1771
1771
  }
@@ -1774,13 +1774,13 @@ export interface GetBackendStorageResponse {
1774
1774
  */
1775
1775
  export interface GetTokenRequest {
1776
1776
  /**
1777
- * @public
1778
1777
  * <p>The app ID.</p>
1778
+ * @public
1779
1779
  */
1780
1780
  AppId: string | undefined;
1781
1781
  /**
1782
- * @public
1783
1782
  * <p>The session ID.</p>
1783
+ * @public
1784
1784
  */
1785
1785
  SessionId: string | undefined;
1786
1786
  }
@@ -1789,59 +1789,59 @@ export interface GetTokenRequest {
1789
1789
  */
1790
1790
  export interface GetTokenResponse {
1791
1791
  /**
1792
- * @public
1793
1792
  * <p>The app ID.</p>
1793
+ * @public
1794
1794
  */
1795
1795
  AppId?: string;
1796
1796
  /**
1797
- * @public
1798
1797
  * <p>The one-time challenge code for authenticating into the Amplify Admin UI.</p>
1798
+ * @public
1799
1799
  */
1800
1800
  ChallengeCode?: string;
1801
1801
  /**
1802
- * @public
1803
1802
  * <p>A unique ID provided when creating a new challenge token.</p>
1803
+ * @public
1804
1804
  */
1805
1805
  SessionId?: string;
1806
1806
  /**
1807
- * @public
1808
1807
  * <p>The expiry time for the one-time generated token code.</p>
1808
+ * @public
1809
1809
  */
1810
1810
  Ttl?: string;
1811
1811
  }
1812
1812
  /**
1813
- * @public
1814
1813
  * <p>The request body for ImportBackendAuth.</p>
1814
+ * @public
1815
1815
  */
1816
1816
  export interface ImportBackendAuthRequest {
1817
1817
  /**
1818
- * @public
1819
1818
  * <p>The app ID.</p>
1819
+ * @public
1820
1820
  */
1821
1821
  AppId: string | undefined;
1822
1822
  /**
1823
- * @public
1824
1823
  * <p>The name of the backend environment.</p>
1824
+ * @public
1825
1825
  */
1826
1826
  BackendEnvironmentName: string | undefined;
1827
1827
  /**
1828
- * @public
1829
1828
  * <p>The ID of the Amazon Cognito identity pool.</p>
1829
+ * @public
1830
1830
  */
1831
1831
  IdentityPoolId?: string;
1832
1832
  /**
1833
- * @public
1834
1833
  * <p>The ID of the Amazon Cognito native client.</p>
1834
+ * @public
1835
1835
  */
1836
1836
  NativeClientId: string | undefined;
1837
1837
  /**
1838
- * @public
1839
1838
  * <p>The ID of the Amazon Cognito user pool.</p>
1839
+ * @public
1840
1840
  */
1841
1841
  UserPoolId: string | undefined;
1842
1842
  /**
1843
- * @public
1844
1843
  * <p>The ID of the Amazon Cognito web client.</p>
1844
+ * @public
1845
1845
  */
1846
1846
  WebClientId: string | undefined;
1847
1847
  }
@@ -1850,59 +1850,59 @@ export interface ImportBackendAuthRequest {
1850
1850
  */
1851
1851
  export interface ImportBackendAuthResponse {
1852
1852
  /**
1853
- * @public
1854
1853
  * <p>The app ID.</p>
1854
+ * @public
1855
1855
  */
1856
1856
  AppId?: string;
1857
1857
  /**
1858
- * @public
1859
1858
  * <p>The name of the backend environment.</p>
1859
+ * @public
1860
1860
  */
1861
1861
  BackendEnvironmentName?: string;
1862
1862
  /**
1863
- * @public
1864
1863
  * <p>If the request fails, this error is returned.</p>
1864
+ * @public
1865
1865
  */
1866
1866
  Error?: string;
1867
1867
  /**
1868
- * @public
1869
1868
  * <p>The ID for the job.</p>
1869
+ * @public
1870
1870
  */
1871
1871
  JobId?: string;
1872
1872
  /**
1873
- * @public
1874
1873
  * <p>The name of the operation.</p>
1874
+ * @public
1875
1875
  */
1876
1876
  Operation?: string;
1877
1877
  /**
1878
- * @public
1879
1878
  * <p>The current status of the request.</p>
1879
+ * @public
1880
1880
  */
1881
1881
  Status?: string;
1882
1882
  }
1883
1883
  /**
1884
- * @public
1885
1884
  * <p>The request body for ImportBackendStorage.</p>
1885
+ * @public
1886
1886
  */
1887
1887
  export interface ImportBackendStorageRequest {
1888
1888
  /**
1889
- * @public
1890
1889
  * <p>The app ID.</p>
1890
+ * @public
1891
1891
  */
1892
1892
  AppId: string | undefined;
1893
1893
  /**
1894
- * @public
1895
1894
  * <p>The name of the backend environment.</p>
1895
+ * @public
1896
1896
  */
1897
1897
  BackendEnvironmentName: string | undefined;
1898
1898
  /**
1899
- * @public
1900
1899
  * <p>The name of the S3 bucket.</p>
1900
+ * @public
1901
1901
  */
1902
1902
  BucketName?: string;
1903
1903
  /**
1904
- * @public
1905
1904
  * <p>The name of the storage service.</p>
1905
+ * @public
1906
1906
  */
1907
1907
  ServiceName: ServiceName | undefined;
1908
1908
  }
@@ -1911,110 +1911,110 @@ export interface ImportBackendStorageRequest {
1911
1911
  */
1912
1912
  export interface ImportBackendStorageResponse {
1913
1913
  /**
1914
- * @public
1915
1914
  * <p>The app ID.</p>
1915
+ * @public
1916
1916
  */
1917
1917
  AppId?: string;
1918
1918
  /**
1919
- * @public
1920
1919
  * <p>The name of the backend environment.</p>
1920
+ * @public
1921
1921
  */
1922
1922
  BackendEnvironmentName?: string;
1923
1923
  /**
1924
- * @public
1925
1924
  * <p>The ID for the job.</p>
1925
+ * @public
1926
1926
  */
1927
1927
  JobId?: string;
1928
1928
  /**
1929
- * @public
1930
1929
  * <p>The current status of the request.</p>
1930
+ * @public
1931
1931
  */
1932
1932
  Status?: string;
1933
1933
  }
1934
1934
  /**
1935
- * @public
1936
1935
  * <p>The request body for ListBackendJobs.</p>
1936
+ * @public
1937
1937
  */
1938
1938
  export interface ListBackendJobsRequest {
1939
1939
  /**
1940
- * @public
1941
1940
  * <p>The app ID.</p>
1941
+ * @public
1942
1942
  */
1943
1943
  AppId: string | undefined;
1944
1944
  /**
1945
- * @public
1946
1945
  * <p>The name of the backend environment.</p>
1946
+ * @public
1947
1947
  */
1948
1948
  BackendEnvironmentName: string | undefined;
1949
1949
  /**
1950
- * @public
1951
1950
  * <p>The ID for the job.</p>
1951
+ * @public
1952
1952
  */
1953
1953
  JobId?: string;
1954
1954
  /**
1955
- * @public
1956
1955
  * <p>The maximum number of results that you want in the response.</p>
1956
+ * @public
1957
1957
  */
1958
1958
  MaxResults?: number;
1959
1959
  /**
1960
- * @public
1961
1960
  * <p>The token for the next set of results.</p>
1961
+ * @public
1962
1962
  */
1963
1963
  NextToken?: string;
1964
1964
  /**
1965
- * @public
1966
1965
  * <p>Filters the list of response objects to include only those with the specified operation name.</p>
1966
+ * @public
1967
1967
  */
1968
1968
  Operation?: string;
1969
1969
  /**
1970
- * @public
1971
1970
  * <p>Filters the list of response objects to include only those with the specified status.</p>
1971
+ * @public
1972
1972
  */
1973
1973
  Status?: string;
1974
1974
  }
1975
1975
  /**
1976
- * @public
1977
1976
  * <p>The response object for this operation.</p>
1977
+ * @public
1978
1978
  */
1979
1979
  export interface BackendJobRespObj {
1980
1980
  /**
1981
- * @public
1982
1981
  * <p>The app ID.</p>
1982
+ * @public
1983
1983
  */
1984
1984
  AppId: string | undefined;
1985
1985
  /**
1986
- * @public
1987
1986
  * <p>The name of the backend environment.</p>
1987
+ * @public
1988
1988
  */
1989
1989
  BackendEnvironmentName: string | undefined;
1990
1990
  /**
1991
- * @public
1992
1991
  * <p>The time when the job was created.</p>
1992
+ * @public
1993
1993
  */
1994
1994
  CreateTime?: string;
1995
1995
  /**
1996
- * @public
1997
1996
  * <p>If the request fails, this error is returned.</p>
1997
+ * @public
1998
1998
  */
1999
1999
  Error?: string;
2000
2000
  /**
2001
- * @public
2002
2001
  * <p>The ID for the job.</p>
2002
+ * @public
2003
2003
  */
2004
2004
  JobId?: string;
2005
2005
  /**
2006
- * @public
2007
2006
  * <p>The name of the operation.</p>
2007
+ * @public
2008
2008
  */
2009
2009
  Operation?: string;
2010
2010
  /**
2011
- * @public
2012
2011
  * <p>The current status of the request.</p>
2012
+ * @public
2013
2013
  */
2014
2014
  Status?: string;
2015
2015
  /**
2016
- * @public
2017
2016
  * <p>The time when the job was last updated.</p>
2017
+ * @public
2018
2018
  */
2019
2019
  UpdateTime?: string;
2020
2020
  }
@@ -2023,40 +2023,40 @@ export interface BackendJobRespObj {
2023
2023
  */
2024
2024
  export interface ListBackendJobsResponse {
2025
2025
  /**
2026
- * @public
2027
2026
  * <p>An array of jobs and their properties.</p>
2027
+ * @public
2028
2028
  */
2029
2029
  Jobs?: BackendJobRespObj[];
2030
2030
  /**
2031
- * @public
2032
2031
  * <p>The token for the next set of results.</p>
2032
+ * @public
2033
2033
  */
2034
2034
  NextToken?: string;
2035
2035
  }
2036
2036
  /**
2037
- * @public
2038
2037
  * <p>The request body for S3Buckets.</p>
2038
+ * @public
2039
2039
  */
2040
2040
  export interface ListS3BucketsRequest {
2041
2041
  /**
2042
- * @public
2043
2042
  * <p>Reserved for future use.</p>
2043
+ * @public
2044
2044
  */
2045
2045
  NextToken?: string;
2046
2046
  }
2047
2047
  /**
2048
- * @public
2049
2048
  * <p>Describes the metadata of the S3 bucket.</p>
2049
+ * @public
2050
2050
  */
2051
2051
  export interface S3BucketInfo {
2052
2052
  /**
2053
- * @public
2054
2053
  * <p>The creation date of the S3 bucket.</p>
2054
+ * @public
2055
2055
  */
2056
2056
  CreationDate?: string;
2057
2057
  /**
2058
- * @public
2059
2058
  * <p>The name of the S3 bucket.</p>
2059
+ * @public
2060
2060
  */
2061
2061
  Name?: string;
2062
2062
  }
@@ -2065,29 +2065,29 @@ export interface S3BucketInfo {
2065
2065
  */
2066
2066
  export interface ListS3BucketsResponse {
2067
2067
  /**
2068
- * @public
2069
2068
  * <p>The list of S3 buckets.</p>
2069
+ * @public
2070
2070
  */
2071
2071
  Buckets?: S3BucketInfo[];
2072
2072
  /**
2073
- * @public
2074
2073
  * <p>Reserved for future use.</p>
2074
+ * @public
2075
2075
  */
2076
2076
  NextToken?: string;
2077
2077
  }
2078
2078
  /**
2079
- * @public
2080
2079
  * <p>The request body for RemoveAllBackends.</p>
2080
+ * @public
2081
2081
  */
2082
2082
  export interface RemoveAllBackendsRequest {
2083
2083
  /**
2084
- * @public
2085
2084
  * <p>The app ID.</p>
2085
+ * @public
2086
2086
  */
2087
2087
  AppId: string | undefined;
2088
2088
  /**
2089
- * @public
2090
2089
  * <p>Cleans up the Amplify Console app if this value is set to true.</p>
2090
+ * @public
2091
2091
  */
2092
2092
  CleanAmplifyApp?: boolean;
2093
2093
  }
@@ -2096,28 +2096,28 @@ export interface RemoveAllBackendsRequest {
2096
2096
  */
2097
2097
  export interface RemoveAllBackendsResponse {
2098
2098
  /**
2099
- * @public
2100
2099
  * <p>The app ID.</p>
2100
+ * @public
2101
2101
  */
2102
2102
  AppId?: string;
2103
2103
  /**
2104
- * @public
2105
2104
  * <p>If the request fails, this error is returned.</p>
2105
+ * @public
2106
2106
  */
2107
2107
  Error?: string;
2108
2108
  /**
2109
- * @public
2110
2109
  * <p>The ID for the job.</p>
2110
+ * @public
2111
2111
  */
2112
2112
  JobId?: string;
2113
2113
  /**
2114
- * @public
2115
2114
  * <p>The name of the operation.</p>
2115
+ * @public
2116
2116
  */
2117
2117
  Operation?: string;
2118
2118
  /**
2119
- * @public
2120
2119
  * <p>The current status of the request.</p>
2120
+ * @public
2121
2121
  */
2122
2122
  Status?: string;
2123
2123
  }
@@ -2126,8 +2126,8 @@ export interface RemoveAllBackendsResponse {
2126
2126
  */
2127
2127
  export interface RemoveBackendConfigRequest {
2128
2128
  /**
2129
- * @public
2130
2129
  * <p>The app ID.</p>
2130
+ * @public
2131
2131
  */
2132
2132
  AppId: string | undefined;
2133
2133
  }
@@ -2136,34 +2136,34 @@ export interface RemoveBackendConfigRequest {
2136
2136
  */
2137
2137
  export interface RemoveBackendConfigResponse {
2138
2138
  /**
2139
- * @public
2140
2139
  * <p>If the request fails, this error is returned.</p>
2140
+ * @public
2141
2141
  */
2142
2142
  Error?: string;
2143
2143
  }
2144
2144
  /**
2145
- * @public
2146
2145
  * <p>The request body for UpdateBackendAPI.</p>
2146
+ * @public
2147
2147
  */
2148
2148
  export interface UpdateBackendAPIRequest {
2149
2149
  /**
2150
- * @public
2151
2150
  * <p>The app ID.</p>
2151
+ * @public
2152
2152
  */
2153
2153
  AppId: string | undefined;
2154
2154
  /**
2155
- * @public
2156
2155
  * <p>The name of the backend environment.</p>
2156
+ * @public
2157
2157
  */
2158
2158
  BackendEnvironmentName: string | undefined;
2159
2159
  /**
2160
- * @public
2161
2160
  * <p>Defines the resource configuration for the data model in your Amplify project.</p>
2161
+ * @public
2162
2162
  */
2163
2163
  ResourceConfig?: BackendAPIResourceConfig;
2164
2164
  /**
2165
- * @public
2166
2165
  * <p>The name of this resource.</p>
2166
+ * @public
2167
2167
  */
2168
2168
  ResourceName: string | undefined;
2169
2169
  }
@@ -2172,237 +2172,237 @@ export interface UpdateBackendAPIRequest {
2172
2172
  */
2173
2173
  export interface UpdateBackendAPIResponse {
2174
2174
  /**
2175
- * @public
2176
2175
  * <p>The app ID.</p>
2176
+ * @public
2177
2177
  */
2178
2178
  AppId?: string;
2179
2179
  /**
2180
- * @public
2181
2180
  * <p>The name of the backend environment.</p>
2181
+ * @public
2182
2182
  */
2183
2183
  BackendEnvironmentName?: string;
2184
2184
  /**
2185
- * @public
2186
2185
  * <p>If the request fails, this error is returned.</p>
2186
+ * @public
2187
2187
  */
2188
2188
  Error?: string;
2189
2189
  /**
2190
- * @public
2191
2190
  * <p>The ID for the job.</p>
2191
+ * @public
2192
2192
  */
2193
2193
  JobId?: string;
2194
2194
  /**
2195
- * @public
2196
2195
  * <p>The name of the operation.</p>
2196
+ * @public
2197
2197
  */
2198
2198
  Operation?: string;
2199
2199
  /**
2200
- * @public
2201
2200
  * <p>The current status of the request.</p>
2201
+ * @public
2202
2202
  */
2203
2203
  Status?: string;
2204
2204
  }
2205
2205
  /**
2206
- * @public
2207
2206
  * <p>Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.</p>
2207
+ * @public
2208
2208
  */
2209
2209
  export interface UpdateBackendAuthIdentityPoolConfig {
2210
2210
  /**
2211
- * @public
2212
2211
  * <p>A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.</p>
2212
+ * @public
2213
2213
  */
2214
2214
  UnauthenticatedLogin?: boolean;
2215
2215
  }
2216
2216
  /**
2217
- * @public
2218
2217
  * <p><b>(DEPRECATED)</b> Describes the forgot password policy for authenticating into the Amplify app.</p>
2218
+ * @public
2219
2219
  */
2220
2220
  export interface UpdateBackendAuthForgotPasswordConfig {
2221
2221
  /**
2222
- * @public
2223
2222
  * <p><b>(DEPRECATED)</b> Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.</p>
2223
+ * @public
2224
2224
  */
2225
2225
  DeliveryMethod?: DeliveryMethod;
2226
2226
  /**
2227
- * @public
2228
2227
  * <p><b>(DEPRECATED)</b> The configuration for the email sent when an app user forgets their password.</p>
2228
+ * @public
2229
2229
  */
2230
2230
  EmailSettings?: EmailSettings;
2231
2231
  /**
2232
- * @public
2233
2232
  * <p><b>(DEPRECATED)</b> The configuration for the SMS message sent when an Amplify app user forgets their password.</p>
2233
+ * @public
2234
2234
  */
2235
2235
  SmsSettings?: SmsSettings;
2236
2236
  }
2237
2237
  /**
2238
- * @public
2239
2238
  * <p>Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.</p>
2239
+ * @public
2240
2240
  */
2241
2241
  export interface UpdateBackendAuthMFAConfig {
2242
2242
  /**
2243
- * @public
2244
2243
  * <p>The MFA mode for the backend of your Amplify project.</p>
2244
+ * @public
2245
2245
  */
2246
2246
  MFAMode?: MFAMode;
2247
2247
  /**
2248
- * @public
2249
2248
  * <p>The settings of your MFA configuration for the backend of your Amplify project.</p>
2249
+ * @public
2250
2250
  */
2251
2251
  Settings?: Settings;
2252
2252
  }
2253
2253
  /**
2254
- * @public
2255
2254
  * <p>The OAuth configurations for authenticating users into your Amplify app.</p>
2255
+ * @public
2256
2256
  */
2257
2257
  export interface UpdateBackendAuthOAuthConfig {
2258
2258
  /**
2259
- * @public
2260
2259
  * <p>The Amazon Cognito domain prefix used to create a hosted UI for authentication.</p>
2260
+ * @public
2261
2261
  */
2262
2262
  DomainPrefix?: string;
2263
2263
  /**
2264
- * @public
2265
2264
  * <p>The OAuth grant type to allow app users to authenticate from your Amplify app.</p>
2265
+ * @public
2266
2266
  */
2267
2267
  OAuthGrantType?: OAuthGrantType;
2268
2268
  /**
2269
- * @public
2270
2269
  * <p>The list of OAuth-related flows that can allow users to authenticate from your Amplify app.</p>
2270
+ * @public
2271
2271
  */
2272
2272
  OAuthScopes?: OAuthScopesElement[];
2273
2273
  /**
2274
- * @public
2275
2274
  * <p>Redirect URLs that OAuth uses when a user signs in to an Amplify app.</p>
2275
+ * @public
2276
2276
  */
2277
2277
  RedirectSignInURIs?: string[];
2278
2278
  /**
2279
- * @public
2280
2279
  * <p>Redirect URLs that OAuth uses when a user signs out of an Amplify app.</p>
2280
+ * @public
2281
2281
  */
2282
2282
  RedirectSignOutURIs?: string[];
2283
2283
  /**
2284
- * @public
2285
2284
  * <p>Describes third-party social federation configurations for allowing your users to sign in with OAuth.</p>
2285
+ * @public
2286
2286
  */
2287
2287
  SocialProviderSettings?: SocialProviderSettings;
2288
2288
  }
2289
2289
  /**
2290
- * @public
2291
2290
  * <p>Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.</p>
2291
+ * @public
2292
2292
  */
2293
2293
  export interface UpdateBackendAuthPasswordPolicyConfig {
2294
2294
  /**
2295
- * @public
2296
2295
  * <p>Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.</p>
2296
+ * @public
2297
2297
  */
2298
2298
  AdditionalConstraints?: AdditionalConstraintsElement[];
2299
2299
  /**
2300
- * @public
2301
2300
  * <p>Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.</p>
2301
+ * @public
2302
2302
  */
2303
2303
  MinimumLength?: number;
2304
2304
  }
2305
2305
  /**
2306
- * @public
2307
2306
  * <p>Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.</p>
2307
+ * @public
2308
2308
  */
2309
2309
  export interface UpdateBackendAuthVerificationMessageConfig {
2310
2310
  /**
2311
- * @public
2312
2311
  * <p>The type of verification message to send.</p>
2312
+ * @public
2313
2313
  */
2314
2314
  DeliveryMethod: DeliveryMethod | undefined;
2315
2315
  /**
2316
- * @public
2317
2316
  * <p>The settings for the email message.</p>
2317
+ * @public
2318
2318
  */
2319
2319
  EmailSettings?: EmailSettings;
2320
2320
  /**
2321
- * @public
2322
2321
  * <p>The settings for the SMS message.</p>
2322
+ * @public
2323
2323
  */
2324
2324
  SmsSettings?: SmsSettings;
2325
2325
  }
2326
2326
  /**
2327
- * @public
2328
2327
  * <p>Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.</p>
2328
+ * @public
2329
2329
  */
2330
2330
  export interface UpdateBackendAuthUserPoolConfig {
2331
2331
  /**
2332
- * @public
2333
2332
  * <p><b>(DEPRECATED)</b> Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>
2333
+ * @public
2334
2334
  */
2335
2335
  ForgotPassword?: UpdateBackendAuthForgotPasswordConfig;
2336
2336
  /**
2337
- * @public
2338
2337
  * <p>Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.</p>
2338
+ * @public
2339
2339
  */
2340
2340
  Mfa?: UpdateBackendAuthMFAConfig;
2341
2341
  /**
2342
- * @public
2343
2342
  * <p>Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>
2343
+ * @public
2344
2344
  */
2345
2345
  OAuth?: UpdateBackendAuthOAuthConfig;
2346
2346
  /**
2347
- * @public
2348
2347
  * <p>Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>
2348
+ * @public
2349
2349
  */
2350
2350
  PasswordPolicy?: UpdateBackendAuthPasswordPolicyConfig;
2351
2351
  /**
2352
- * @public
2353
2352
  * <p>Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>
2353
+ * @public
2354
2354
  */
2355
2355
  VerificationMessage?: UpdateBackendAuthVerificationMessageConfig;
2356
2356
  }
2357
2357
  /**
2358
- * @public
2359
2358
  * <p>Defines the resource configuration when updating an authentication resource in your Amplify project.</p>
2359
+ * @public
2360
2360
  */
2361
2361
  export interface UpdateBackendAuthResourceConfig {
2362
2362
  /**
2363
- * @public
2364
2363
  * <p>Defines the service name to use when configuring an authentication resource in your Amplify project.</p>
2364
+ * @public
2365
2365
  */
2366
2366
  AuthResources: AuthResources | undefined;
2367
2367
  /**
2368
- * @public
2369
2368
  * <p>Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.</p>
2369
+ * @public
2370
2370
  */
2371
2371
  IdentityPoolConfigs?: UpdateBackendAuthIdentityPoolConfig;
2372
2372
  /**
2373
- * @public
2374
2373
  * <p>Defines the service name to use when configuring an authentication resource in your Amplify project.</p>
2374
+ * @public
2375
2375
  */
2376
2376
  Service: Service | undefined;
2377
2377
  /**
2378
- * @public
2379
2378
  * <p>Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.</p>
2379
+ * @public
2380
2380
  */
2381
2381
  UserPoolConfigs: UpdateBackendAuthUserPoolConfig | undefined;
2382
2382
  }
2383
2383
  /**
2384
- * @public
2385
2384
  * <p>The request body for UpdateBackendAuth.</p>
2385
+ * @public
2386
2386
  */
2387
2387
  export interface UpdateBackendAuthRequest {
2388
2388
  /**
2389
- * @public
2390
2389
  * <p>The app ID.</p>
2390
+ * @public
2391
2391
  */
2392
2392
  AppId: string | undefined;
2393
2393
  /**
2394
- * @public
2395
2394
  * <p>The name of the backend environment.</p>
2395
+ * @public
2396
2396
  */
2397
2397
  BackendEnvironmentName: string | undefined;
2398
2398
  /**
2399
- * @public
2400
2399
  * <p>The resource configuration for this request object.</p>
2400
+ * @public
2401
2401
  */
2402
2402
  ResourceConfig: UpdateBackendAuthResourceConfig | undefined;
2403
2403
  /**
2404
- * @public
2405
2404
  * <p>The name of this resource.</p>
2405
+ * @public
2406
2406
  */
2407
2407
  ResourceName: string | undefined;
2408
2408
  }
@@ -2411,75 +2411,75 @@ export interface UpdateBackendAuthRequest {
2411
2411
  */
2412
2412
  export interface UpdateBackendAuthResponse {
2413
2413
  /**
2414
- * @public
2415
2414
  * <p>The app ID.</p>
2415
+ * @public
2416
2416
  */
2417
2417
  AppId?: string;
2418
2418
  /**
2419
- * @public
2420
2419
  * <p>The name of the backend environment.</p>
2420
+ * @public
2421
2421
  */
2422
2422
  BackendEnvironmentName?: string;
2423
2423
  /**
2424
- * @public
2425
2424
  * <p>If the request fails, this error is returned.</p>
2425
+ * @public
2426
2426
  */
2427
2427
  Error?: string;
2428
2428
  /**
2429
- * @public
2430
2429
  * <p>The ID for the job.</p>
2430
+ * @public
2431
2431
  */
2432
2432
  JobId?: string;
2433
2433
  /**
2434
- * @public
2435
2434
  * <p>The name of the operation.</p>
2435
+ * @public
2436
2436
  */
2437
2437
  Operation?: string;
2438
2438
  /**
2439
- * @public
2440
2439
  * <p>The current status of the request.</p>
2440
+ * @public
2441
2441
  */
2442
2442
  Status?: string;
2443
2443
  }
2444
2444
  /**
2445
- * @public
2446
2445
  * <p>The request object for this operation.</p>
2446
+ * @public
2447
2447
  */
2448
2448
  export interface LoginAuthConfigReqObj {
2449
2449
  /**
2450
- * @public
2451
2450
  * <p>The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.</p>
2451
+ * @public
2452
2452
  */
2453
2453
  AwsCognitoIdentityPoolId?: string;
2454
2454
  /**
2455
- * @public
2456
2455
  * <p>The AWS Region for the Amplify Admin UI login.</p>
2456
+ * @public
2457
2457
  */
2458
2458
  AwsCognitoRegion?: string;
2459
2459
  /**
2460
- * @public
2461
2460
  * <p>The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.</p>
2461
+ * @public
2462
2462
  */
2463
2463
  AwsUserPoolsId?: string;
2464
2464
  /**
2465
- * @public
2466
2465
  * <p>The web client ID for the Amazon Cognito user pools.</p>
2466
+ * @public
2467
2467
  */
2468
2468
  AwsUserPoolsWebClientId?: string;
2469
2469
  }
2470
2470
  /**
2471
- * @public
2472
2471
  * <p>The request body for UpdateBackendConfig.</p>
2472
+ * @public
2473
2473
  */
2474
2474
  export interface UpdateBackendConfigRequest {
2475
2475
  /**
2476
- * @public
2477
2476
  * <p>The app ID.</p>
2477
+ * @public
2478
2478
  */
2479
2479
  AppId: string | undefined;
2480
2480
  /**
2481
- * @public
2482
2481
  * <p>Describes the Amazon Cognito configuration for Admin UI access.</p>
2482
+ * @public
2483
2483
  */
2484
2484
  LoginAuthConfig?: LoginAuthConfigReqObj;
2485
2485
  }
@@ -2488,54 +2488,54 @@ export interface UpdateBackendConfigRequest {
2488
2488
  */
2489
2489
  export interface UpdateBackendConfigResponse {
2490
2490
  /**
2491
- * @public
2492
2491
  * <p>The app ID.</p>
2492
+ * @public
2493
2493
  */
2494
2494
  AppId?: string;
2495
2495
  /**
2496
- * @public
2497
2496
  * <p>The app ID for the backend manager.</p>
2497
+ * @public
2498
2498
  */
2499
2499
  BackendManagerAppId?: string;
2500
2500
  /**
2501
- * @public
2502
2501
  * <p>If the request fails, this error is returned.</p>
2502
+ * @public
2503
2503
  */
2504
2504
  Error?: string;
2505
2505
  /**
2506
- * @public
2507
2506
  * <p>Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.</p>
2507
+ * @public
2508
2508
  */
2509
2509
  LoginAuthConfig?: LoginAuthConfigReqObj;
2510
2510
  }
2511
2511
  /**
2512
- * @public
2513
2512
  * <p>The request body for GetBackendJob.</p>
2513
+ * @public
2514
2514
  */
2515
2515
  export interface UpdateBackendJobRequest {
2516
2516
  /**
2517
- * @public
2518
2517
  * <p>The app ID.</p>
2518
+ * @public
2519
2519
  */
2520
2520
  AppId: string | undefined;
2521
2521
  /**
2522
- * @public
2523
2522
  * <p>The name of the backend environment.</p>
2523
+ * @public
2524
2524
  */
2525
2525
  BackendEnvironmentName: string | undefined;
2526
2526
  /**
2527
- * @public
2528
2527
  * <p>The ID for the job.</p>
2528
+ * @public
2529
2529
  */
2530
2530
  JobId: string | undefined;
2531
2531
  /**
2532
- * @public
2533
2532
  * <p>Filters the list of response objects to include only those with the specified operation name.</p>
2533
+ * @public
2534
2534
  */
2535
2535
  Operation?: string;
2536
2536
  /**
2537
- * @public
2538
2537
  * <p>Filters the list of response objects to include only those with the specified status.</p>
2538
+ * @public
2539
2539
  */
2540
2540
  Status?: string;
2541
2541
  }
@@ -2544,85 +2544,85 @@ export interface UpdateBackendJobRequest {
2544
2544
  */
2545
2545
  export interface UpdateBackendJobResponse {
2546
2546
  /**
2547
- * @public
2548
2547
  * <p>The app ID.</p>
2548
+ * @public
2549
2549
  */
2550
2550
  AppId?: string;
2551
2551
  /**
2552
- * @public
2553
2552
  * <p>The name of the backend environment.</p>
2553
+ * @public
2554
2554
  */
2555
2555
  BackendEnvironmentName?: string;
2556
2556
  /**
2557
- * @public
2558
2557
  * <p>The time when the job was created.</p>
2558
+ * @public
2559
2559
  */
2560
2560
  CreateTime?: string;
2561
2561
  /**
2562
- * @public
2563
2562
  * <p>If the request fails, this error is returned.</p>
2563
+ * @public
2564
2564
  */
2565
2565
  Error?: string;
2566
2566
  /**
2567
- * @public
2568
2567
  * <p>The ID for the job.</p>
2568
+ * @public
2569
2569
  */
2570
2570
  JobId?: string;
2571
2571
  /**
2572
- * @public
2573
2572
  * <p>The name of the operation.</p>
2573
+ * @public
2574
2574
  */
2575
2575
  Operation?: string;
2576
2576
  /**
2577
- * @public
2578
2577
  * <p>The current status of the request.</p>
2578
+ * @public
2579
2579
  */
2580
2580
  Status?: string;
2581
2581
  /**
2582
- * @public
2583
2582
  * <p>The time when the job was last updated.</p>
2583
+ * @public
2584
2584
  */
2585
2585
  UpdateTime?: string;
2586
2586
  }
2587
2587
  /**
2588
- * @public
2589
2588
  * <p>The resource configuration for updating backend storage.</p>
2589
+ * @public
2590
2590
  */
2591
2591
  export interface UpdateBackendStorageResourceConfig {
2592
2592
  /**
2593
- * @public
2594
2593
  * <p>The authorization configuration for the storage S3 bucket.</p>
2594
+ * @public
2595
2595
  */
2596
2596
  Permissions: BackendStoragePermissions | undefined;
2597
2597
  /**
2598
- * @public
2599
2598
  * <p>The name of the storage service.</p>
2599
+ * @public
2600
2600
  */
2601
2601
  ServiceName: ServiceName | undefined;
2602
2602
  }
2603
2603
  /**
2604
- * @public
2605
2604
  * <p>The request body for UpdateBackendStorage.</p>
2605
+ * @public
2606
2606
  */
2607
2607
  export interface UpdateBackendStorageRequest {
2608
2608
  /**
2609
- * @public
2610
2609
  * <p>The app ID.</p>
2610
+ * @public
2611
2611
  */
2612
2612
  AppId: string | undefined;
2613
2613
  /**
2614
- * @public
2615
2614
  * <p>The name of the backend environment.</p>
2615
+ * @public
2616
2616
  */
2617
2617
  BackendEnvironmentName: string | undefined;
2618
2618
  /**
2619
- * @public
2620
2619
  * <p>The resource configuration for updating backend storage.</p>
2620
+ * @public
2621
2621
  */
2622
2622
  ResourceConfig: UpdateBackendStorageResourceConfig | undefined;
2623
2623
  /**
2624
- * @public
2625
2624
  * <p>The name of the storage resource.</p>
2625
+ * @public
2626
2626
  */
2627
2627
  ResourceName: string | undefined;
2628
2628
  }
@@ -2631,23 +2631,23 @@ export interface UpdateBackendStorageRequest {
2631
2631
  */
2632
2632
  export interface UpdateBackendStorageResponse {
2633
2633
  /**
2634
- * @public
2635
2634
  * <p>The app ID.</p>
2635
+ * @public
2636
2636
  */
2637
2637
  AppId?: string;
2638
2638
  /**
2639
- * @public
2640
2639
  * <p>The name of the backend environment.</p>
2640
+ * @public
2641
2641
  */
2642
2642
  BackendEnvironmentName?: string;
2643
2643
  /**
2644
- * @public
2645
2644
  * <p>The ID for the job.</p>
2645
+ * @public
2646
2646
  */
2647
2647
  JobId?: string;
2648
2648
  /**
2649
- * @public
2650
2649
  * <p>The current status of the request.</p>
2650
+ * @public
2651
2651
  */
2652
2652
  Status?: string;
2653
2653
  }