@aws-sdk/client-amplifybackend 3.687.0 → 3.692.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.
- package/dist-types/models/models_0.d.ts +258 -258
- package/dist-types/ts3.4/models/models_0.d.ts +258 -258
- package/package.json +35 -35
|
@@ -25,7 +25,7 @@ export declare class BadRequestException extends __BaseException {
|
|
|
25
25
|
* <p>An error message to inform that the request failed.</p>
|
|
26
26
|
* @public
|
|
27
27
|
*/
|
|
28
|
-
Message?: string;
|
|
28
|
+
Message?: string | undefined;
|
|
29
29
|
/**
|
|
30
30
|
* @internal
|
|
31
31
|
*/
|
|
@@ -60,32 +60,32 @@ export interface CloneBackendResponse {
|
|
|
60
60
|
* <p>The app ID.</p>
|
|
61
61
|
* @public
|
|
62
62
|
*/
|
|
63
|
-
AppId?: string;
|
|
63
|
+
AppId?: string | undefined;
|
|
64
64
|
/**
|
|
65
65
|
* <p>The name of the backend environment.</p>
|
|
66
66
|
* @public
|
|
67
67
|
*/
|
|
68
|
-
BackendEnvironmentName?: string;
|
|
68
|
+
BackendEnvironmentName?: string | undefined;
|
|
69
69
|
/**
|
|
70
70
|
* <p>If the request fails, this error is returned.</p>
|
|
71
71
|
* @public
|
|
72
72
|
*/
|
|
73
|
-
Error?: string;
|
|
73
|
+
Error?: string | undefined;
|
|
74
74
|
/**
|
|
75
75
|
* <p>The ID for the job.</p>
|
|
76
76
|
* @public
|
|
77
77
|
*/
|
|
78
|
-
JobId?: string;
|
|
78
|
+
JobId?: string | undefined;
|
|
79
79
|
/**
|
|
80
80
|
* <p>The name of the operation.</p>
|
|
81
81
|
* @public
|
|
82
82
|
*/
|
|
83
|
-
Operation?: string;
|
|
83
|
+
Operation?: string | undefined;
|
|
84
84
|
/**
|
|
85
85
|
* <p>The current status of the request.</p>
|
|
86
86
|
* @public
|
|
87
87
|
*/
|
|
88
|
-
Status?: string;
|
|
88
|
+
Status?: string | undefined;
|
|
89
89
|
}
|
|
90
90
|
/**
|
|
91
91
|
* <p>An error returned if there's a temporary issue with the service.</p>
|
|
@@ -98,7 +98,7 @@ export declare class GatewayTimeoutException extends __BaseException {
|
|
|
98
98
|
* <p>An error message to inform that the request failed.</p>
|
|
99
99
|
* @public
|
|
100
100
|
*/
|
|
101
|
-
Message?: string;
|
|
101
|
+
Message?: string | undefined;
|
|
102
102
|
/**
|
|
103
103
|
* @internal
|
|
104
104
|
*/
|
|
@@ -115,12 +115,12 @@ export declare class NotFoundException extends __BaseException {
|
|
|
115
115
|
* <p>An error message to inform that the request has failed.</p>
|
|
116
116
|
* @public
|
|
117
117
|
*/
|
|
118
|
-
Message?: string;
|
|
118
|
+
Message?: string | undefined;
|
|
119
119
|
/**
|
|
120
120
|
* <p>The type of resource that is not found.</p>
|
|
121
121
|
* @public
|
|
122
122
|
*/
|
|
123
|
-
ResourceType?: string;
|
|
123
|
+
ResourceType?: string | undefined;
|
|
124
124
|
/**
|
|
125
125
|
* @internal
|
|
126
126
|
*/
|
|
@@ -137,12 +137,12 @@ export declare class TooManyRequestsException extends __BaseException {
|
|
|
137
137
|
* <p>The type of limit that was exceeded.</p>
|
|
138
138
|
* @public
|
|
139
139
|
*/
|
|
140
|
-
LimitType?: string;
|
|
140
|
+
LimitType?: string | undefined;
|
|
141
141
|
/**
|
|
142
142
|
* <p>An error message to inform that the request has failed.</p>
|
|
143
143
|
* @public
|
|
144
144
|
*/
|
|
145
|
-
Message?: string;
|
|
145
|
+
Message?: string | undefined;
|
|
146
146
|
/**
|
|
147
147
|
* @internal
|
|
148
148
|
*/
|
|
@@ -178,12 +178,12 @@ export interface CreateBackendRequest {
|
|
|
178
178
|
* <p>The resource configuration for creating a backend.</p>
|
|
179
179
|
* @public
|
|
180
180
|
*/
|
|
181
|
-
ResourceConfig?: ResourceConfig;
|
|
181
|
+
ResourceConfig?: ResourceConfig | undefined;
|
|
182
182
|
/**
|
|
183
183
|
* <p>The name of the resource.</p>
|
|
184
184
|
* @public
|
|
185
185
|
*/
|
|
186
|
-
ResourceName?: string;
|
|
186
|
+
ResourceName?: string | undefined;
|
|
187
187
|
}
|
|
188
188
|
/**
|
|
189
189
|
* @public
|
|
@@ -193,32 +193,32 @@ export interface CreateBackendResponse {
|
|
|
193
193
|
* <p>The app ID.</p>
|
|
194
194
|
* @public
|
|
195
195
|
*/
|
|
196
|
-
AppId?: string;
|
|
196
|
+
AppId?: string | undefined;
|
|
197
197
|
/**
|
|
198
198
|
* <p>The name of the backend environment.</p>
|
|
199
199
|
* @public
|
|
200
200
|
*/
|
|
201
|
-
BackendEnvironmentName?: string;
|
|
201
|
+
BackendEnvironmentName?: string | undefined;
|
|
202
202
|
/**
|
|
203
203
|
* <p>If the request fails, this error is returned.</p>
|
|
204
204
|
* @public
|
|
205
205
|
*/
|
|
206
|
-
Error?: string;
|
|
206
|
+
Error?: string | undefined;
|
|
207
207
|
/**
|
|
208
208
|
* <p>The ID for the job.</p>
|
|
209
209
|
* @public
|
|
210
210
|
*/
|
|
211
|
-
JobId?: string;
|
|
211
|
+
JobId?: string | undefined;
|
|
212
212
|
/**
|
|
213
213
|
* <p>The name of the operation.</p>
|
|
214
214
|
* @public
|
|
215
215
|
*/
|
|
216
|
-
Operation?: string;
|
|
216
|
+
Operation?: string | undefined;
|
|
217
217
|
/**
|
|
218
218
|
* <p>The current status of the request.</p>
|
|
219
219
|
* @public
|
|
220
220
|
*/
|
|
221
|
-
Status?: string;
|
|
221
|
+
Status?: string | undefined;
|
|
222
222
|
}
|
|
223
223
|
/**
|
|
224
224
|
* @public
|
|
@@ -243,42 +243,42 @@ export interface BackendAPIAppSyncAuthSettings {
|
|
|
243
243
|
* <p>The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.</p>
|
|
244
244
|
* @public
|
|
245
245
|
*/
|
|
246
|
-
CognitoUserPoolId?: string;
|
|
246
|
+
CognitoUserPoolId?: string | undefined;
|
|
247
247
|
/**
|
|
248
248
|
* <p>The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.</p>
|
|
249
249
|
* @public
|
|
250
250
|
*/
|
|
251
|
-
Description?: string;
|
|
251
|
+
Description?: string | undefined;
|
|
252
252
|
/**
|
|
253
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
254
|
* @public
|
|
255
255
|
*/
|
|
256
|
-
ExpirationTime?: number;
|
|
256
|
+
ExpirationTime?: number | undefined;
|
|
257
257
|
/**
|
|
258
258
|
* <p>The expiry time for the OpenID authentication mechanism.</p>
|
|
259
259
|
* @public
|
|
260
260
|
*/
|
|
261
|
-
OpenIDAuthTTL?: string;
|
|
261
|
+
OpenIDAuthTTL?: string | undefined;
|
|
262
262
|
/**
|
|
263
263
|
* <p>The clientID for openID, if openID was used as an authentication setting to access your data models.</p>
|
|
264
264
|
* @public
|
|
265
265
|
*/
|
|
266
|
-
OpenIDClientId?: string;
|
|
266
|
+
OpenIDClientId?: string | undefined;
|
|
267
267
|
/**
|
|
268
268
|
* <p>The expiry time for the OpenID authentication mechanism.</p>
|
|
269
269
|
* @public
|
|
270
270
|
*/
|
|
271
|
-
OpenIDIatTTL?: string;
|
|
271
|
+
OpenIDIatTTL?: string | undefined;
|
|
272
272
|
/**
|
|
273
273
|
* <p>The openID issuer URL, if openID was used as an authentication setting to access your data models.</p>
|
|
274
274
|
* @public
|
|
275
275
|
*/
|
|
276
|
-
OpenIDIssueURL?: string;
|
|
276
|
+
OpenIDIssueURL?: string | undefined;
|
|
277
277
|
/**
|
|
278
278
|
* <p>The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.</p>
|
|
279
279
|
* @public
|
|
280
280
|
*/
|
|
281
|
-
OpenIDProviderName?: string;
|
|
281
|
+
OpenIDProviderName?: string | undefined;
|
|
282
282
|
}
|
|
283
283
|
/**
|
|
284
284
|
* <p>Describes the auth types for your configured data models.</p>
|
|
@@ -289,12 +289,12 @@ export interface BackendAPIAuthType {
|
|
|
289
289
|
* <p>Describes the authentication mode.</p>
|
|
290
290
|
* @public
|
|
291
291
|
*/
|
|
292
|
-
Mode?: Mode;
|
|
292
|
+
Mode?: Mode | undefined;
|
|
293
293
|
/**
|
|
294
294
|
* <p>Describes settings for the authentication mode.</p>
|
|
295
295
|
* @public
|
|
296
296
|
*/
|
|
297
|
-
Settings?: BackendAPIAppSyncAuthSettings;
|
|
297
|
+
Settings?: BackendAPIAppSyncAuthSettings | undefined;
|
|
298
298
|
}
|
|
299
299
|
/**
|
|
300
300
|
* @public
|
|
@@ -319,7 +319,7 @@ export interface BackendAPIConflictResolution {
|
|
|
319
319
|
* <p>The strategy for conflict resolution.</p>
|
|
320
320
|
* @public
|
|
321
321
|
*/
|
|
322
|
-
ResolutionStrategy?: ResolutionStrategy;
|
|
322
|
+
ResolutionStrategy?: ResolutionStrategy | undefined;
|
|
323
323
|
}
|
|
324
324
|
/**
|
|
325
325
|
* <p>The resource config for the data model, configured as a part of the Amplify project.</p>
|
|
@@ -330,32 +330,32 @@ export interface BackendAPIResourceConfig {
|
|
|
330
330
|
* <p>Additional authentication methods used to interact with your data models.</p>
|
|
331
331
|
* @public
|
|
332
332
|
*/
|
|
333
|
-
AdditionalAuthTypes?: BackendAPIAuthType[];
|
|
333
|
+
AdditionalAuthTypes?: BackendAPIAuthType[] | undefined;
|
|
334
334
|
/**
|
|
335
335
|
* <p>The API name used to interact with the data model, configured as a part of your Amplify project.</p>
|
|
336
336
|
* @public
|
|
337
337
|
*/
|
|
338
|
-
ApiName?: string;
|
|
338
|
+
ApiName?: string | undefined;
|
|
339
339
|
/**
|
|
340
340
|
* <p>The conflict resolution strategy for your data stored in the data models.</p>
|
|
341
341
|
* @public
|
|
342
342
|
*/
|
|
343
|
-
ConflictResolution?: BackendAPIConflictResolution;
|
|
343
|
+
ConflictResolution?: BackendAPIConflictResolution | undefined;
|
|
344
344
|
/**
|
|
345
345
|
* <p>The default authentication type for interacting with the configured data models in your Amplify project.</p>
|
|
346
346
|
* @public
|
|
347
347
|
*/
|
|
348
|
-
DefaultAuthType?: BackendAPIAuthType;
|
|
348
|
+
DefaultAuthType?: BackendAPIAuthType | undefined;
|
|
349
349
|
/**
|
|
350
350
|
* <p>The service used to provision and interact with the data model.</p>
|
|
351
351
|
* @public
|
|
352
352
|
*/
|
|
353
|
-
Service?: string;
|
|
353
|
+
Service?: string | undefined;
|
|
354
354
|
/**
|
|
355
355
|
* <p>The definition of the data model in the annotated transform of the GraphQL schema.</p>
|
|
356
356
|
* @public
|
|
357
357
|
*/
|
|
358
|
-
TransformSchema?: string;
|
|
358
|
+
TransformSchema?: string | undefined;
|
|
359
359
|
}
|
|
360
360
|
/**
|
|
361
361
|
* <p>The request body for CreateBackendAPI.</p>
|
|
@@ -391,32 +391,32 @@ export interface CreateBackendAPIResponse {
|
|
|
391
391
|
* <p>The app ID.</p>
|
|
392
392
|
* @public
|
|
393
393
|
*/
|
|
394
|
-
AppId?: string;
|
|
394
|
+
AppId?: string | undefined;
|
|
395
395
|
/**
|
|
396
396
|
* <p>The name of the backend environment.</p>
|
|
397
397
|
* @public
|
|
398
398
|
*/
|
|
399
|
-
BackendEnvironmentName?: string;
|
|
399
|
+
BackendEnvironmentName?: string | undefined;
|
|
400
400
|
/**
|
|
401
401
|
* <p>If the request fails, this error is returned.</p>
|
|
402
402
|
* @public
|
|
403
403
|
*/
|
|
404
|
-
Error?: string;
|
|
404
|
+
Error?: string | undefined;
|
|
405
405
|
/**
|
|
406
406
|
* <p>The ID for the job.</p>
|
|
407
407
|
* @public
|
|
408
408
|
*/
|
|
409
|
-
JobId?: string;
|
|
409
|
+
JobId?: string | undefined;
|
|
410
410
|
/**
|
|
411
411
|
* <p>The name of the operation.</p>
|
|
412
412
|
* @public
|
|
413
413
|
*/
|
|
414
|
-
Operation?: string;
|
|
414
|
+
Operation?: string | undefined;
|
|
415
415
|
/**
|
|
416
416
|
* <p>The current status of the request.</p>
|
|
417
417
|
* @public
|
|
418
418
|
*/
|
|
419
|
-
Status?: string;
|
|
419
|
+
Status?: string | undefined;
|
|
420
420
|
}
|
|
421
421
|
/**
|
|
422
422
|
* @public
|
|
@@ -478,12 +478,12 @@ export interface EmailSettings {
|
|
|
478
478
|
* <p>The contents of the email message.</p>
|
|
479
479
|
* @public
|
|
480
480
|
*/
|
|
481
|
-
EmailMessage?: string;
|
|
481
|
+
EmailMessage?: string | undefined;
|
|
482
482
|
/**
|
|
483
483
|
* <p>The contents of the subject line of the email message.</p>
|
|
484
484
|
* @public
|
|
485
485
|
*/
|
|
486
|
-
EmailSubject?: string;
|
|
486
|
+
EmailSubject?: string | undefined;
|
|
487
487
|
}
|
|
488
488
|
/**
|
|
489
489
|
* <p>SMS settings for authentication.</p>
|
|
@@ -494,7 +494,7 @@ export interface SmsSettings {
|
|
|
494
494
|
* <p>The contents of the SMS message.</p>
|
|
495
495
|
* @public
|
|
496
496
|
*/
|
|
497
|
-
SmsMessage?: string;
|
|
497
|
+
SmsMessage?: string | undefined;
|
|
498
498
|
}
|
|
499
499
|
/**
|
|
500
500
|
* <p><b>(DEPRECATED)</b> Describes the forgot password policy for authenticating into the Amplify app.</p>
|
|
@@ -510,12 +510,12 @@ export interface CreateBackendAuthForgotPasswordConfig {
|
|
|
510
510
|
* <p><b>(DEPRECATED)</b> The configuration for the email sent when an app user forgets their password.</p>
|
|
511
511
|
* @public
|
|
512
512
|
*/
|
|
513
|
-
EmailSettings?: EmailSettings;
|
|
513
|
+
EmailSettings?: EmailSettings | undefined;
|
|
514
514
|
/**
|
|
515
515
|
* <p><b>(DEPRECATED)</b> The configuration for the SMS message sent when an app user forgets their password.</p>
|
|
516
516
|
* @public
|
|
517
517
|
*/
|
|
518
|
-
SmsSettings?: SmsSettings;
|
|
518
|
+
SmsSettings?: SmsSettings | undefined;
|
|
519
519
|
}
|
|
520
520
|
/**
|
|
521
521
|
* @public
|
|
@@ -551,12 +551,12 @@ export interface Settings {
|
|
|
551
551
|
* <p>The supported MFA types.</p>
|
|
552
552
|
* @public
|
|
553
553
|
*/
|
|
554
|
-
MfaTypes?: MfaTypesElement[];
|
|
554
|
+
MfaTypes?: MfaTypesElement[] | undefined;
|
|
555
555
|
/**
|
|
556
556
|
* <p>The body of the SMS message.</p>
|
|
557
557
|
* @public
|
|
558
558
|
*/
|
|
559
|
-
SmsMessage?: string;
|
|
559
|
+
SmsMessage?: string | undefined;
|
|
560
560
|
}
|
|
561
561
|
/**
|
|
562
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>
|
|
@@ -572,7 +572,7 @@ export interface CreateBackendAuthMFAConfig {
|
|
|
572
572
|
* <p>Describes the configuration settings and methods for your Amplify app users to use MFA.</p>
|
|
573
573
|
* @public
|
|
574
574
|
*/
|
|
575
|
-
Settings?: Settings;
|
|
575
|
+
Settings?: Settings | undefined;
|
|
576
576
|
}
|
|
577
577
|
/**
|
|
578
578
|
* @public
|
|
@@ -610,12 +610,12 @@ export interface BackendAuthSocialProviderConfig {
|
|
|
610
610
|
* <p>Describes the client_id, which can be obtained from the third-party social federation provider.</p>
|
|
611
611
|
* @public
|
|
612
612
|
*/
|
|
613
|
-
ClientId?: string;
|
|
613
|
+
ClientId?: string | undefined;
|
|
614
614
|
/**
|
|
615
615
|
* <p>Describes the client_secret, which can be obtained from third-party social federation providers.</p>
|
|
616
616
|
* @public
|
|
617
617
|
*/
|
|
618
|
-
ClientSecret?: string;
|
|
618
|
+
ClientSecret?: string | undefined;
|
|
619
619
|
}
|
|
620
620
|
/**
|
|
621
621
|
* <p>Describes Apple social federation configurations for allowing your app users to sign in using OAuth.</p>
|
|
@@ -626,22 +626,22 @@ export interface BackendAuthAppleProviderConfig {
|
|
|
626
626
|
* <p>Describes the client_id (also called Services ID) that comes from Apple.</p>
|
|
627
627
|
* @public
|
|
628
628
|
*/
|
|
629
|
-
ClientId?: string;
|
|
629
|
+
ClientId?: string | undefined;
|
|
630
630
|
/**
|
|
631
631
|
* <p>Describes the key_id that comes from Apple.</p>
|
|
632
632
|
* @public
|
|
633
633
|
*/
|
|
634
|
-
KeyId?: string;
|
|
634
|
+
KeyId?: string | undefined;
|
|
635
635
|
/**
|
|
636
636
|
* <p>Describes the private_key that comes from Apple.</p>
|
|
637
637
|
* @public
|
|
638
638
|
*/
|
|
639
|
-
PrivateKey?: string;
|
|
639
|
+
PrivateKey?: string | undefined;
|
|
640
640
|
/**
|
|
641
641
|
* <p>Describes the team_id that comes from Apple.</p>
|
|
642
642
|
* @public
|
|
643
643
|
*/
|
|
644
|
-
TeamId?: string;
|
|
644
|
+
TeamId?: string | undefined;
|
|
645
645
|
}
|
|
646
646
|
/**
|
|
647
647
|
* <p>The settings for using the social identity providers for access to your Amplify app.</p>
|
|
@@ -652,22 +652,22 @@ export interface SocialProviderSettings {
|
|
|
652
652
|
* <p>Describes third-party social federation configurations for allowing your app users to sign in using OAuth.</p>
|
|
653
653
|
* @public
|
|
654
654
|
*/
|
|
655
|
-
Facebook?: BackendAuthSocialProviderConfig;
|
|
655
|
+
Facebook?: BackendAuthSocialProviderConfig | undefined;
|
|
656
656
|
/**
|
|
657
657
|
* <p>Describes third-party social federation configurations for allowing your app users to sign in using OAuth.</p>
|
|
658
658
|
* @public
|
|
659
659
|
*/
|
|
660
|
-
Google?: BackendAuthSocialProviderConfig;
|
|
660
|
+
Google?: BackendAuthSocialProviderConfig | undefined;
|
|
661
661
|
/**
|
|
662
662
|
* <p>Describes third-party social federation configurations for allowing your app users to sign in using OAuth.</p>
|
|
663
663
|
* @public
|
|
664
664
|
*/
|
|
665
|
-
LoginWithAmazon?: BackendAuthSocialProviderConfig;
|
|
665
|
+
LoginWithAmazon?: BackendAuthSocialProviderConfig | undefined;
|
|
666
666
|
/**
|
|
667
667
|
* <p>Describes Apple social federation configurations for allowing your app users to sign in using OAuth.</p>
|
|
668
668
|
* @public
|
|
669
669
|
*/
|
|
670
|
-
SignInWithApple?: BackendAuthAppleProviderConfig;
|
|
670
|
+
SignInWithApple?: BackendAuthAppleProviderConfig | undefined;
|
|
671
671
|
}
|
|
672
672
|
/**
|
|
673
673
|
* <p>Creates the OAuth configuration for your Amplify project.</p>
|
|
@@ -678,7 +678,7 @@ export interface CreateBackendAuthOAuthConfig {
|
|
|
678
678
|
* <p>The domain prefix for your Amplify app.</p>
|
|
679
679
|
* @public
|
|
680
680
|
*/
|
|
681
|
-
DomainPrefix?: string;
|
|
681
|
+
DomainPrefix?: string | undefined;
|
|
682
682
|
/**
|
|
683
683
|
* <p>The OAuth grant type that you use to allow app users to authenticate from your Amplify app.</p>
|
|
684
684
|
* @public
|
|
@@ -703,7 +703,7 @@ export interface CreateBackendAuthOAuthConfig {
|
|
|
703
703
|
* <p>The settings for using social providers to access your Amplify app.</p>
|
|
704
704
|
* @public
|
|
705
705
|
*/
|
|
706
|
-
SocialProviderSettings?: SocialProviderSettings;
|
|
706
|
+
SocialProviderSettings?: SocialProviderSettings | undefined;
|
|
707
707
|
}
|
|
708
708
|
/**
|
|
709
709
|
* <p>The password policy configuration for the backend to your Amplify project.</p>
|
|
@@ -714,7 +714,7 @@ export interface CreateBackendAuthPasswordPolicyConfig {
|
|
|
714
714
|
* <p>Additional constraints for the password used to access the backend of your Amplify project.</p>
|
|
715
715
|
* @public
|
|
716
716
|
*/
|
|
717
|
-
AdditionalConstraints?: AdditionalConstraintsElement[];
|
|
717
|
+
AdditionalConstraints?: AdditionalConstraintsElement[] | undefined;
|
|
718
718
|
/**
|
|
719
719
|
* <p>The minimum length of the password used to access the backend of your Amplify project.</p>
|
|
720
720
|
* @public
|
|
@@ -776,12 +776,12 @@ export interface CreateBackendAuthVerificationMessageConfig {
|
|
|
776
776
|
* <p>The settings for the email message.</p>
|
|
777
777
|
* @public
|
|
778
778
|
*/
|
|
779
|
-
EmailSettings?: EmailSettings;
|
|
779
|
+
EmailSettings?: EmailSettings | undefined;
|
|
780
780
|
/**
|
|
781
781
|
* <p>The settings for the SMS message.</p>
|
|
782
782
|
* @public
|
|
783
783
|
*/
|
|
784
|
-
SmsSettings?: SmsSettings;
|
|
784
|
+
SmsSettings?: SmsSettings | undefined;
|
|
785
785
|
}
|
|
786
786
|
/**
|
|
787
787
|
* <p>Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.</p>
|
|
@@ -792,22 +792,22 @@ export interface CreateBackendAuthUserPoolConfig {
|
|
|
792
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
793
|
* @public
|
|
794
794
|
*/
|
|
795
|
-
ForgotPassword?: CreateBackendAuthForgotPasswordConfig;
|
|
795
|
+
ForgotPassword?: CreateBackendAuthForgotPasswordConfig | undefined;
|
|
796
796
|
/**
|
|
797
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
798
|
* @public
|
|
799
799
|
*/
|
|
800
|
-
Mfa?: CreateBackendAuthMFAConfig;
|
|
800
|
+
Mfa?: CreateBackendAuthMFAConfig | undefined;
|
|
801
801
|
/**
|
|
802
802
|
* <p>Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>
|
|
803
803
|
* @public
|
|
804
804
|
*/
|
|
805
|
-
OAuth?: CreateBackendAuthOAuthConfig;
|
|
805
|
+
OAuth?: CreateBackendAuthOAuthConfig | undefined;
|
|
806
806
|
/**
|
|
807
807
|
* <p>Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>
|
|
808
808
|
* @public
|
|
809
809
|
*/
|
|
810
|
-
PasswordPolicy?: CreateBackendAuthPasswordPolicyConfig;
|
|
810
|
+
PasswordPolicy?: CreateBackendAuthPasswordPolicyConfig | undefined;
|
|
811
811
|
/**
|
|
812
812
|
* <p>The required attributes to sign up new users in the user pool.</p>
|
|
813
813
|
* @public
|
|
@@ -827,7 +827,7 @@ export interface CreateBackendAuthUserPoolConfig {
|
|
|
827
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
828
|
* @public
|
|
829
829
|
*/
|
|
830
|
-
VerificationMessage?: CreateBackendAuthVerificationMessageConfig;
|
|
830
|
+
VerificationMessage?: CreateBackendAuthVerificationMessageConfig | undefined;
|
|
831
831
|
}
|
|
832
832
|
/**
|
|
833
833
|
* <p>Defines the resource configuration when creating an auth resource in your Amplify project.</p>
|
|
@@ -843,7 +843,7 @@ export interface CreateBackendAuthResourceConfig {
|
|
|
843
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
844
|
* @public
|
|
845
845
|
*/
|
|
846
|
-
IdentityPoolConfigs?: CreateBackendAuthIdentityPoolConfig;
|
|
846
|
+
IdentityPoolConfigs?: CreateBackendAuthIdentityPoolConfig | undefined;
|
|
847
847
|
/**
|
|
848
848
|
* <p>Defines the service name to use when configuring an authentication resource in your Amplify project.</p>
|
|
849
849
|
* @public
|
|
@@ -889,32 +889,32 @@ export interface CreateBackendAuthResponse {
|
|
|
889
889
|
* <p>The app ID.</p>
|
|
890
890
|
* @public
|
|
891
891
|
*/
|
|
892
|
-
AppId?: string;
|
|
892
|
+
AppId?: string | undefined;
|
|
893
893
|
/**
|
|
894
894
|
* <p>The name of the backend environment.</p>
|
|
895
895
|
* @public
|
|
896
896
|
*/
|
|
897
|
-
BackendEnvironmentName?: string;
|
|
897
|
+
BackendEnvironmentName?: string | undefined;
|
|
898
898
|
/**
|
|
899
899
|
* <p>If the request fails, this error is returned.</p>
|
|
900
900
|
* @public
|
|
901
901
|
*/
|
|
902
|
-
Error?: string;
|
|
902
|
+
Error?: string | undefined;
|
|
903
903
|
/**
|
|
904
904
|
* <p>The ID for the job.</p>
|
|
905
905
|
* @public
|
|
906
906
|
*/
|
|
907
|
-
JobId?: string;
|
|
907
|
+
JobId?: string | undefined;
|
|
908
908
|
/**
|
|
909
909
|
* <p>The name of the operation.</p>
|
|
910
910
|
* @public
|
|
911
911
|
*/
|
|
912
|
-
Operation?: string;
|
|
912
|
+
Operation?: string | undefined;
|
|
913
913
|
/**
|
|
914
914
|
* <p>The current status of the request.</p>
|
|
915
915
|
* @public
|
|
916
916
|
*/
|
|
917
|
-
Status?: string;
|
|
917
|
+
Status?: string | undefined;
|
|
918
918
|
}
|
|
919
919
|
/**
|
|
920
920
|
* <p>The request body for CreateBackendConfig.</p>
|
|
@@ -930,7 +930,7 @@ export interface CreateBackendConfigRequest {
|
|
|
930
930
|
* <p>The app ID for the backend manager.</p>
|
|
931
931
|
* @public
|
|
932
932
|
*/
|
|
933
|
-
BackendManagerAppId?: string;
|
|
933
|
+
BackendManagerAppId?: string | undefined;
|
|
934
934
|
}
|
|
935
935
|
/**
|
|
936
936
|
* @public
|
|
@@ -940,22 +940,22 @@ export interface CreateBackendConfigResponse {
|
|
|
940
940
|
* <p>The app ID.</p>
|
|
941
941
|
* @public
|
|
942
942
|
*/
|
|
943
|
-
AppId?: string;
|
|
943
|
+
AppId?: string | undefined;
|
|
944
944
|
/**
|
|
945
945
|
* <p>The name of the backend environment.</p>
|
|
946
946
|
* @public
|
|
947
947
|
*/
|
|
948
|
-
BackendEnvironmentName?: string;
|
|
948
|
+
BackendEnvironmentName?: string | undefined;
|
|
949
949
|
/**
|
|
950
950
|
* <p>The ID for the job.</p>
|
|
951
951
|
* @public
|
|
952
952
|
*/
|
|
953
|
-
JobId?: string;
|
|
953
|
+
JobId?: string | undefined;
|
|
954
954
|
/**
|
|
955
955
|
* <p>The current status of the request.</p>
|
|
956
956
|
* @public
|
|
957
957
|
*/
|
|
958
|
-
Status?: string;
|
|
958
|
+
Status?: string | undefined;
|
|
959
959
|
}
|
|
960
960
|
/**
|
|
961
961
|
* @public
|
|
@@ -997,7 +997,7 @@ export interface BackendStoragePermissions {
|
|
|
997
997
|
* <p>Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.</p>
|
|
998
998
|
* @public
|
|
999
999
|
*/
|
|
1000
|
-
UnAuthenticated?: UnAuthenticatedElement[];
|
|
1000
|
+
UnAuthenticated?: UnAuthenticatedElement[] | undefined;
|
|
1001
1001
|
}
|
|
1002
1002
|
/**
|
|
1003
1003
|
* @public
|
|
@@ -1019,7 +1019,7 @@ export interface CreateBackendStorageResourceConfig {
|
|
|
1019
1019
|
* <p>The name of the S3 bucket.</p>
|
|
1020
1020
|
* @public
|
|
1021
1021
|
*/
|
|
1022
|
-
BucketName?: string;
|
|
1022
|
+
BucketName?: string | undefined;
|
|
1023
1023
|
/**
|
|
1024
1024
|
* <p>The authorization configuration for the storage S3 bucket.</p>
|
|
1025
1025
|
* @public
|
|
@@ -1065,22 +1065,22 @@ export interface CreateBackendStorageResponse {
|
|
|
1065
1065
|
* <p>The app ID.</p>
|
|
1066
1066
|
* @public
|
|
1067
1067
|
*/
|
|
1068
|
-
AppId?: string;
|
|
1068
|
+
AppId?: string | undefined;
|
|
1069
1069
|
/**
|
|
1070
1070
|
* <p>The name of the backend environment.</p>
|
|
1071
1071
|
* @public
|
|
1072
1072
|
*/
|
|
1073
|
-
BackendEnvironmentName?: string;
|
|
1073
|
+
BackendEnvironmentName?: string | undefined;
|
|
1074
1074
|
/**
|
|
1075
1075
|
* <p>The ID for the job.</p>
|
|
1076
1076
|
* @public
|
|
1077
1077
|
*/
|
|
1078
|
-
JobId?: string;
|
|
1078
|
+
JobId?: string | undefined;
|
|
1079
1079
|
/**
|
|
1080
1080
|
* <p>The current status of the request.</p>
|
|
1081
1081
|
* @public
|
|
1082
1082
|
*/
|
|
1083
|
-
Status?: string;
|
|
1083
|
+
Status?: string | undefined;
|
|
1084
1084
|
}
|
|
1085
1085
|
/**
|
|
1086
1086
|
* @public
|
|
@@ -1100,22 +1100,22 @@ export interface CreateTokenResponse {
|
|
|
1100
1100
|
* <p>The app ID.</p>
|
|
1101
1101
|
* @public
|
|
1102
1102
|
*/
|
|
1103
|
-
AppId?: string;
|
|
1103
|
+
AppId?: string | undefined;
|
|
1104
1104
|
/**
|
|
1105
1105
|
* <p>One-time challenge code for authenticating into the Amplify Admin UI.</p>
|
|
1106
1106
|
* @public
|
|
1107
1107
|
*/
|
|
1108
|
-
ChallengeCode?: string;
|
|
1108
|
+
ChallengeCode?: string | undefined;
|
|
1109
1109
|
/**
|
|
1110
1110
|
* <p>A unique ID provided when creating a new challenge token.</p>
|
|
1111
1111
|
* @public
|
|
1112
1112
|
*/
|
|
1113
|
-
SessionId?: string;
|
|
1113
|
+
SessionId?: string | undefined;
|
|
1114
1114
|
/**
|
|
1115
1115
|
* <p>The expiry time for the one-time generated token code.</p>
|
|
1116
1116
|
* @public
|
|
1117
1117
|
*/
|
|
1118
|
-
Ttl?: string;
|
|
1118
|
+
Ttl?: string | undefined;
|
|
1119
1119
|
}
|
|
1120
1120
|
/**
|
|
1121
1121
|
* @public
|
|
@@ -1140,32 +1140,32 @@ export interface DeleteBackendResponse {
|
|
|
1140
1140
|
* <p>The app ID.</p>
|
|
1141
1141
|
* @public
|
|
1142
1142
|
*/
|
|
1143
|
-
AppId?: string;
|
|
1143
|
+
AppId?: string | undefined;
|
|
1144
1144
|
/**
|
|
1145
1145
|
* <p>The name of the backend environment.</p>
|
|
1146
1146
|
* @public
|
|
1147
1147
|
*/
|
|
1148
|
-
BackendEnvironmentName?: string;
|
|
1148
|
+
BackendEnvironmentName?: string | undefined;
|
|
1149
1149
|
/**
|
|
1150
1150
|
* <p>If the request fails, this error is returned.</p>
|
|
1151
1151
|
* @public
|
|
1152
1152
|
*/
|
|
1153
|
-
Error?: string;
|
|
1153
|
+
Error?: string | undefined;
|
|
1154
1154
|
/**
|
|
1155
1155
|
* <p>The ID for the job.</p>
|
|
1156
1156
|
* @public
|
|
1157
1157
|
*/
|
|
1158
|
-
JobId?: string;
|
|
1158
|
+
JobId?: string | undefined;
|
|
1159
1159
|
/**
|
|
1160
1160
|
* <p>The name of the operation.</p>
|
|
1161
1161
|
* @public
|
|
1162
1162
|
*/
|
|
1163
|
-
Operation?: string;
|
|
1163
|
+
Operation?: string | undefined;
|
|
1164
1164
|
/**
|
|
1165
1165
|
* <p>The current status of the request.</p>
|
|
1166
1166
|
* @public
|
|
1167
1167
|
*/
|
|
1168
|
-
Status?: string;
|
|
1168
|
+
Status?: string | undefined;
|
|
1169
1169
|
}
|
|
1170
1170
|
/**
|
|
1171
1171
|
* <p>The request body for DeleteBackendAPI.</p>
|
|
@@ -1186,7 +1186,7 @@ export interface DeleteBackendAPIRequest {
|
|
|
1186
1186
|
* <p>Defines the resource configuration for the data model in your Amplify project.</p>
|
|
1187
1187
|
* @public
|
|
1188
1188
|
*/
|
|
1189
|
-
ResourceConfig?: BackendAPIResourceConfig;
|
|
1189
|
+
ResourceConfig?: BackendAPIResourceConfig | undefined;
|
|
1190
1190
|
/**
|
|
1191
1191
|
* <p>The name of this resource.</p>
|
|
1192
1192
|
* @public
|
|
@@ -1201,32 +1201,32 @@ export interface DeleteBackendAPIResponse {
|
|
|
1201
1201
|
* <p>The app ID.</p>
|
|
1202
1202
|
* @public
|
|
1203
1203
|
*/
|
|
1204
|
-
AppId?: string;
|
|
1204
|
+
AppId?: string | undefined;
|
|
1205
1205
|
/**
|
|
1206
1206
|
* <p>The name of the backend environment.</p>
|
|
1207
1207
|
* @public
|
|
1208
1208
|
*/
|
|
1209
|
-
BackendEnvironmentName?: string;
|
|
1209
|
+
BackendEnvironmentName?: string | undefined;
|
|
1210
1210
|
/**
|
|
1211
1211
|
* <p>If the request fails, this error is returned.</p>
|
|
1212
1212
|
* @public
|
|
1213
1213
|
*/
|
|
1214
|
-
Error?: string;
|
|
1214
|
+
Error?: string | undefined;
|
|
1215
1215
|
/**
|
|
1216
1216
|
* <p>The ID for the job.</p>
|
|
1217
1217
|
* @public
|
|
1218
1218
|
*/
|
|
1219
|
-
JobId?: string;
|
|
1219
|
+
JobId?: string | undefined;
|
|
1220
1220
|
/**
|
|
1221
1221
|
* <p>The name of the operation.</p>
|
|
1222
1222
|
* @public
|
|
1223
1223
|
*/
|
|
1224
|
-
Operation?: string;
|
|
1224
|
+
Operation?: string | undefined;
|
|
1225
1225
|
/**
|
|
1226
1226
|
* <p>The current status of the request.</p>
|
|
1227
1227
|
* @public
|
|
1228
1228
|
*/
|
|
1229
|
-
Status?: string;
|
|
1229
|
+
Status?: string | undefined;
|
|
1230
1230
|
}
|
|
1231
1231
|
/**
|
|
1232
1232
|
* <p>The request body for DeleteBackendAuth.</p>
|
|
@@ -1257,32 +1257,32 @@ export interface DeleteBackendAuthResponse {
|
|
|
1257
1257
|
* <p>The app ID.</p>
|
|
1258
1258
|
* @public
|
|
1259
1259
|
*/
|
|
1260
|
-
AppId?: string;
|
|
1260
|
+
AppId?: string | undefined;
|
|
1261
1261
|
/**
|
|
1262
1262
|
* <p>The name of the backend environment.</p>
|
|
1263
1263
|
* @public
|
|
1264
1264
|
*/
|
|
1265
|
-
BackendEnvironmentName?: string;
|
|
1265
|
+
BackendEnvironmentName?: string | undefined;
|
|
1266
1266
|
/**
|
|
1267
1267
|
* <p>If the request fails, this error is returned.</p>
|
|
1268
1268
|
* @public
|
|
1269
1269
|
*/
|
|
1270
|
-
Error?: string;
|
|
1270
|
+
Error?: string | undefined;
|
|
1271
1271
|
/**
|
|
1272
1272
|
* <p>The ID for the job.</p>
|
|
1273
1273
|
* @public
|
|
1274
1274
|
*/
|
|
1275
|
-
JobId?: string;
|
|
1275
|
+
JobId?: string | undefined;
|
|
1276
1276
|
/**
|
|
1277
1277
|
* <p>The name of the operation.</p>
|
|
1278
1278
|
* @public
|
|
1279
1279
|
*/
|
|
1280
|
-
Operation?: string;
|
|
1280
|
+
Operation?: string | undefined;
|
|
1281
1281
|
/**
|
|
1282
1282
|
* <p>The current status of the request.</p>
|
|
1283
1283
|
* @public
|
|
1284
1284
|
*/
|
|
1285
|
-
Status?: string;
|
|
1285
|
+
Status?: string | undefined;
|
|
1286
1286
|
}
|
|
1287
1287
|
/**
|
|
1288
1288
|
* <p>The request body for DeleteBackendStorage.</p>
|
|
@@ -1318,22 +1318,22 @@ export interface DeleteBackendStorageResponse {
|
|
|
1318
1318
|
* <p>The app ID.</p>
|
|
1319
1319
|
* @public
|
|
1320
1320
|
*/
|
|
1321
|
-
AppId?: string;
|
|
1321
|
+
AppId?: string | undefined;
|
|
1322
1322
|
/**
|
|
1323
1323
|
* <p>The name of the backend environment.</p>
|
|
1324
1324
|
* @public
|
|
1325
1325
|
*/
|
|
1326
|
-
BackendEnvironmentName?: string;
|
|
1326
|
+
BackendEnvironmentName?: string | undefined;
|
|
1327
1327
|
/**
|
|
1328
1328
|
* <p>The ID for the job.</p>
|
|
1329
1329
|
* @public
|
|
1330
1330
|
*/
|
|
1331
|
-
JobId?: string;
|
|
1331
|
+
JobId?: string | undefined;
|
|
1332
1332
|
/**
|
|
1333
1333
|
* <p>The current status of the request.</p>
|
|
1334
1334
|
* @public
|
|
1335
1335
|
*/
|
|
1336
|
-
Status?: string;
|
|
1336
|
+
Status?: string | undefined;
|
|
1337
1337
|
}
|
|
1338
1338
|
/**
|
|
1339
1339
|
* @public
|
|
@@ -1358,7 +1358,7 @@ export interface DeleteTokenResponse {
|
|
|
1358
1358
|
* <p>Indicates whether the request succeeded or failed.</p>
|
|
1359
1359
|
* @public
|
|
1360
1360
|
*/
|
|
1361
|
-
IsSuccess?: boolean;
|
|
1361
|
+
IsSuccess?: boolean | undefined;
|
|
1362
1362
|
}
|
|
1363
1363
|
/**
|
|
1364
1364
|
* <p>The request body for GenerateBackendAPIModels.</p>
|
|
@@ -1389,32 +1389,32 @@ export interface GenerateBackendAPIModelsResponse {
|
|
|
1389
1389
|
* <p>The app ID.</p>
|
|
1390
1390
|
* @public
|
|
1391
1391
|
*/
|
|
1392
|
-
AppId?: string;
|
|
1392
|
+
AppId?: string | undefined;
|
|
1393
1393
|
/**
|
|
1394
1394
|
* <p>The name of the backend environment.</p>
|
|
1395
1395
|
* @public
|
|
1396
1396
|
*/
|
|
1397
|
-
BackendEnvironmentName?: string;
|
|
1397
|
+
BackendEnvironmentName?: string | undefined;
|
|
1398
1398
|
/**
|
|
1399
1399
|
* <p>If the request fails, this error is returned.</p>
|
|
1400
1400
|
* @public
|
|
1401
1401
|
*/
|
|
1402
|
-
Error?: string;
|
|
1402
|
+
Error?: string | undefined;
|
|
1403
1403
|
/**
|
|
1404
1404
|
* <p>The ID for the job.</p>
|
|
1405
1405
|
* @public
|
|
1406
1406
|
*/
|
|
1407
|
-
JobId?: string;
|
|
1407
|
+
JobId?: string | undefined;
|
|
1408
1408
|
/**
|
|
1409
1409
|
* <p>The name of the operation.</p>
|
|
1410
1410
|
* @public
|
|
1411
1411
|
*/
|
|
1412
|
-
Operation?: string;
|
|
1412
|
+
Operation?: string | undefined;
|
|
1413
1413
|
/**
|
|
1414
1414
|
* <p>The current status of the request.</p>
|
|
1415
1415
|
* @public
|
|
1416
1416
|
*/
|
|
1417
|
-
Status?: string;
|
|
1417
|
+
Status?: string | undefined;
|
|
1418
1418
|
}
|
|
1419
1419
|
/**
|
|
1420
1420
|
* <p>The request body for GetBackend.</p>
|
|
@@ -1430,7 +1430,7 @@ export interface GetBackendRequest {
|
|
|
1430
1430
|
* <p>The name of the backend environment.</p>
|
|
1431
1431
|
* @public
|
|
1432
1432
|
*/
|
|
1433
|
-
BackendEnvironmentName?: string;
|
|
1433
|
+
BackendEnvironmentName?: string | undefined;
|
|
1434
1434
|
}
|
|
1435
1435
|
/**
|
|
1436
1436
|
* @public
|
|
@@ -1440,37 +1440,37 @@ export interface GetBackendResponse {
|
|
|
1440
1440
|
* <p>A stringified version of the cli.json file for your Amplify project.</p>
|
|
1441
1441
|
* @public
|
|
1442
1442
|
*/
|
|
1443
|
-
AmplifyFeatureFlags?: string;
|
|
1443
|
+
AmplifyFeatureFlags?: string | undefined;
|
|
1444
1444
|
/**
|
|
1445
1445
|
* <p>A stringified version of the current configs for your Amplify project.</p>
|
|
1446
1446
|
* @public
|
|
1447
1447
|
*/
|
|
1448
|
-
AmplifyMetaConfig?: string;
|
|
1448
|
+
AmplifyMetaConfig?: string | undefined;
|
|
1449
1449
|
/**
|
|
1450
1450
|
* <p>The app ID.</p>
|
|
1451
1451
|
* @public
|
|
1452
1452
|
*/
|
|
1453
|
-
AppId?: string;
|
|
1453
|
+
AppId?: string | undefined;
|
|
1454
1454
|
/**
|
|
1455
1455
|
* <p>The name of the app.</p>
|
|
1456
1456
|
* @public
|
|
1457
1457
|
*/
|
|
1458
|
-
AppName?: string;
|
|
1458
|
+
AppName?: string | undefined;
|
|
1459
1459
|
/**
|
|
1460
1460
|
* <p>A list of backend environments in an array.</p>
|
|
1461
1461
|
* @public
|
|
1462
1462
|
*/
|
|
1463
|
-
BackendEnvironmentList?: string[];
|
|
1463
|
+
BackendEnvironmentList?: string[] | undefined;
|
|
1464
1464
|
/**
|
|
1465
1465
|
* <p>The name of the backend environment.</p>
|
|
1466
1466
|
* @public
|
|
1467
1467
|
*/
|
|
1468
|
-
BackendEnvironmentName?: string;
|
|
1468
|
+
BackendEnvironmentName?: string | undefined;
|
|
1469
1469
|
/**
|
|
1470
1470
|
* <p>If the request failed, this is the returned error.</p>
|
|
1471
1471
|
* @public
|
|
1472
1472
|
*/
|
|
1473
|
-
Error?: string;
|
|
1473
|
+
Error?: string | undefined;
|
|
1474
1474
|
}
|
|
1475
1475
|
/**
|
|
1476
1476
|
* <p>The request body for GetBackendAPI.</p>
|
|
@@ -1491,7 +1491,7 @@ export interface GetBackendAPIRequest {
|
|
|
1491
1491
|
* <p>Defines the resource configuration for the data model in your Amplify project.</p>
|
|
1492
1492
|
* @public
|
|
1493
1493
|
*/
|
|
1494
|
-
ResourceConfig?: BackendAPIResourceConfig;
|
|
1494
|
+
ResourceConfig?: BackendAPIResourceConfig | undefined;
|
|
1495
1495
|
/**
|
|
1496
1496
|
* <p>The name of this resource.</p>
|
|
1497
1497
|
* @public
|
|
@@ -1506,27 +1506,27 @@ export interface GetBackendAPIResponse {
|
|
|
1506
1506
|
* <p>The app ID.</p>
|
|
1507
1507
|
* @public
|
|
1508
1508
|
*/
|
|
1509
|
-
AppId?: string;
|
|
1509
|
+
AppId?: string | undefined;
|
|
1510
1510
|
/**
|
|
1511
1511
|
* <p>The name of the backend environment.</p>
|
|
1512
1512
|
* @public
|
|
1513
1513
|
*/
|
|
1514
|
-
BackendEnvironmentName?: string;
|
|
1514
|
+
BackendEnvironmentName?: string | undefined;
|
|
1515
1515
|
/**
|
|
1516
1516
|
* <p>If the request fails, this error is returned.</p>
|
|
1517
1517
|
* @public
|
|
1518
1518
|
*/
|
|
1519
|
-
Error?: string;
|
|
1519
|
+
Error?: string | undefined;
|
|
1520
1520
|
/**
|
|
1521
1521
|
* <p>The resource configuration for this response object.</p>
|
|
1522
1522
|
* @public
|
|
1523
1523
|
*/
|
|
1524
|
-
ResourceConfig?: BackendAPIResourceConfig;
|
|
1524
|
+
ResourceConfig?: BackendAPIResourceConfig | undefined;
|
|
1525
1525
|
/**
|
|
1526
1526
|
* <p>The name of this resource.</p>
|
|
1527
1527
|
* @public
|
|
1528
1528
|
*/
|
|
1529
|
-
ResourceName?: string;
|
|
1529
|
+
ResourceName?: string | undefined;
|
|
1530
1530
|
}
|
|
1531
1531
|
/**
|
|
1532
1532
|
* <p>The request body for GetBackendAPIModels.</p>
|
|
@@ -1569,17 +1569,17 @@ export interface GetBackendAPIModelsResponse {
|
|
|
1569
1569
|
* <p>Stringified JSON of the datastore model.</p>
|
|
1570
1570
|
* @public
|
|
1571
1571
|
*/
|
|
1572
|
-
Models?: string;
|
|
1572
|
+
Models?: string | undefined;
|
|
1573
1573
|
/**
|
|
1574
1574
|
* <p>The current status of the request.</p>
|
|
1575
1575
|
* @public
|
|
1576
1576
|
*/
|
|
1577
|
-
Status?: Status;
|
|
1577
|
+
Status?: Status | undefined;
|
|
1578
1578
|
/**
|
|
1579
1579
|
* <p>Stringified JSON of the model introspection schema for an existing backend API resource.</p>
|
|
1580
1580
|
* @public
|
|
1581
1581
|
*/
|
|
1582
|
-
ModelIntrospectionSchema?: string;
|
|
1582
|
+
ModelIntrospectionSchema?: string | undefined;
|
|
1583
1583
|
}
|
|
1584
1584
|
/**
|
|
1585
1585
|
* <p>The request body for GetBackendAuth.</p>
|
|
@@ -1610,27 +1610,27 @@ export interface GetBackendAuthResponse {
|
|
|
1610
1610
|
* <p>The app ID.</p>
|
|
1611
1611
|
* @public
|
|
1612
1612
|
*/
|
|
1613
|
-
AppId?: string;
|
|
1613
|
+
AppId?: string | undefined;
|
|
1614
1614
|
/**
|
|
1615
1615
|
* <p>The name of the backend environment.</p>
|
|
1616
1616
|
* @public
|
|
1617
1617
|
*/
|
|
1618
|
-
BackendEnvironmentName?: string;
|
|
1618
|
+
BackendEnvironmentName?: string | undefined;
|
|
1619
1619
|
/**
|
|
1620
1620
|
* <p>If the request fails, this error is returned.</p>
|
|
1621
1621
|
* @public
|
|
1622
1622
|
*/
|
|
1623
|
-
Error?: string;
|
|
1623
|
+
Error?: string | undefined;
|
|
1624
1624
|
/**
|
|
1625
1625
|
* <p>The resource configuration for authorization requests to the backend of your Amplify project.</p>
|
|
1626
1626
|
* @public
|
|
1627
1627
|
*/
|
|
1628
|
-
ResourceConfig?: CreateBackendAuthResourceConfig;
|
|
1628
|
+
ResourceConfig?: CreateBackendAuthResourceConfig | undefined;
|
|
1629
1629
|
/**
|
|
1630
1630
|
* <p>The name of this resource.</p>
|
|
1631
1631
|
* @public
|
|
1632
1632
|
*/
|
|
1633
|
-
ResourceName?: string;
|
|
1633
|
+
ResourceName?: string | undefined;
|
|
1634
1634
|
}
|
|
1635
1635
|
/**
|
|
1636
1636
|
* @public
|
|
@@ -1660,42 +1660,42 @@ export interface GetBackendJobResponse {
|
|
|
1660
1660
|
* <p>The app ID.</p>
|
|
1661
1661
|
* @public
|
|
1662
1662
|
*/
|
|
1663
|
-
AppId?: string;
|
|
1663
|
+
AppId?: string | undefined;
|
|
1664
1664
|
/**
|
|
1665
1665
|
* <p>The name of the backend environment.</p>
|
|
1666
1666
|
* @public
|
|
1667
1667
|
*/
|
|
1668
|
-
BackendEnvironmentName?: string;
|
|
1668
|
+
BackendEnvironmentName?: string | undefined;
|
|
1669
1669
|
/**
|
|
1670
1670
|
* <p>The time when the job was created.</p>
|
|
1671
1671
|
* @public
|
|
1672
1672
|
*/
|
|
1673
|
-
CreateTime?: string;
|
|
1673
|
+
CreateTime?: string | undefined;
|
|
1674
1674
|
/**
|
|
1675
1675
|
* <p>If the request fails, this error is returned.</p>
|
|
1676
1676
|
* @public
|
|
1677
1677
|
*/
|
|
1678
|
-
Error?: string;
|
|
1678
|
+
Error?: string | undefined;
|
|
1679
1679
|
/**
|
|
1680
1680
|
* <p>The ID for the job.</p>
|
|
1681
1681
|
* @public
|
|
1682
1682
|
*/
|
|
1683
|
-
JobId?: string;
|
|
1683
|
+
JobId?: string | undefined;
|
|
1684
1684
|
/**
|
|
1685
1685
|
* <p>The name of the operation.</p>
|
|
1686
1686
|
* @public
|
|
1687
1687
|
*/
|
|
1688
|
-
Operation?: string;
|
|
1688
|
+
Operation?: string | undefined;
|
|
1689
1689
|
/**
|
|
1690
1690
|
* <p>The current status of the request.</p>
|
|
1691
1691
|
* @public
|
|
1692
1692
|
*/
|
|
1693
|
-
Status?: string;
|
|
1693
|
+
Status?: string | undefined;
|
|
1694
1694
|
/**
|
|
1695
1695
|
* <p>The time when the job was last updated.</p>
|
|
1696
1696
|
* @public
|
|
1697
1697
|
*/
|
|
1698
|
-
UpdateTime?: string;
|
|
1698
|
+
UpdateTime?: string | undefined;
|
|
1699
1699
|
}
|
|
1700
1700
|
/**
|
|
1701
1701
|
* <p>The request body for GetBackendStorage.</p>
|
|
@@ -1727,7 +1727,7 @@ export interface GetBackendStorageResourceConfig {
|
|
|
1727
1727
|
* <p>The name of the S3 bucket.</p>
|
|
1728
1728
|
* @public
|
|
1729
1729
|
*/
|
|
1730
|
-
BucketName?: string;
|
|
1730
|
+
BucketName?: string | undefined;
|
|
1731
1731
|
/**
|
|
1732
1732
|
* <p>Returns True if the storage resource has been imported.</p>
|
|
1733
1733
|
* @public
|
|
@@ -1737,7 +1737,7 @@ export interface GetBackendStorageResourceConfig {
|
|
|
1737
1737
|
* <p>The authorization configuration for the storage S3 bucket.</p>
|
|
1738
1738
|
* @public
|
|
1739
1739
|
*/
|
|
1740
|
-
Permissions?: BackendStoragePermissions;
|
|
1740
|
+
Permissions?: BackendStoragePermissions | undefined;
|
|
1741
1741
|
/**
|
|
1742
1742
|
* <p>The name of the storage service.</p>
|
|
1743
1743
|
* @public
|
|
@@ -1752,22 +1752,22 @@ export interface GetBackendStorageResponse {
|
|
|
1752
1752
|
* <p>The app ID.</p>
|
|
1753
1753
|
* @public
|
|
1754
1754
|
*/
|
|
1755
|
-
AppId?: string;
|
|
1755
|
+
AppId?: string | undefined;
|
|
1756
1756
|
/**
|
|
1757
1757
|
* <p>The name of the backend environment.</p>
|
|
1758
1758
|
* @public
|
|
1759
1759
|
*/
|
|
1760
|
-
BackendEnvironmentName?: string;
|
|
1760
|
+
BackendEnvironmentName?: string | undefined;
|
|
1761
1761
|
/**
|
|
1762
1762
|
* <p>The resource configuration for the backend storage resource.</p>
|
|
1763
1763
|
* @public
|
|
1764
1764
|
*/
|
|
1765
|
-
ResourceConfig?: GetBackendStorageResourceConfig;
|
|
1765
|
+
ResourceConfig?: GetBackendStorageResourceConfig | undefined;
|
|
1766
1766
|
/**
|
|
1767
1767
|
* <p>The name of the storage resource.</p>
|
|
1768
1768
|
* @public
|
|
1769
1769
|
*/
|
|
1770
|
-
ResourceName?: string;
|
|
1770
|
+
ResourceName?: string | undefined;
|
|
1771
1771
|
}
|
|
1772
1772
|
/**
|
|
1773
1773
|
* @public
|
|
@@ -1792,22 +1792,22 @@ export interface GetTokenResponse {
|
|
|
1792
1792
|
* <p>The app ID.</p>
|
|
1793
1793
|
* @public
|
|
1794
1794
|
*/
|
|
1795
|
-
AppId?: string;
|
|
1795
|
+
AppId?: string | undefined;
|
|
1796
1796
|
/**
|
|
1797
1797
|
* <p>The one-time challenge code for authenticating into the Amplify Admin UI.</p>
|
|
1798
1798
|
* @public
|
|
1799
1799
|
*/
|
|
1800
|
-
ChallengeCode?: string;
|
|
1800
|
+
ChallengeCode?: string | undefined;
|
|
1801
1801
|
/**
|
|
1802
1802
|
* <p>A unique ID provided when creating a new challenge token.</p>
|
|
1803
1803
|
* @public
|
|
1804
1804
|
*/
|
|
1805
|
-
SessionId?: string;
|
|
1805
|
+
SessionId?: string | undefined;
|
|
1806
1806
|
/**
|
|
1807
1807
|
* <p>The expiry time for the one-time generated token code.</p>
|
|
1808
1808
|
* @public
|
|
1809
1809
|
*/
|
|
1810
|
-
Ttl?: string;
|
|
1810
|
+
Ttl?: string | undefined;
|
|
1811
1811
|
}
|
|
1812
1812
|
/**
|
|
1813
1813
|
* <p>The request body for ImportBackendAuth.</p>
|
|
@@ -1828,7 +1828,7 @@ export interface ImportBackendAuthRequest {
|
|
|
1828
1828
|
* <p>The ID of the Amazon Cognito identity pool.</p>
|
|
1829
1829
|
* @public
|
|
1830
1830
|
*/
|
|
1831
|
-
IdentityPoolId?: string;
|
|
1831
|
+
IdentityPoolId?: string | undefined;
|
|
1832
1832
|
/**
|
|
1833
1833
|
* <p>The ID of the Amazon Cognito native client.</p>
|
|
1834
1834
|
* @public
|
|
@@ -1853,32 +1853,32 @@ export interface ImportBackendAuthResponse {
|
|
|
1853
1853
|
* <p>The app ID.</p>
|
|
1854
1854
|
* @public
|
|
1855
1855
|
*/
|
|
1856
|
-
AppId?: string;
|
|
1856
|
+
AppId?: string | undefined;
|
|
1857
1857
|
/**
|
|
1858
1858
|
* <p>The name of the backend environment.</p>
|
|
1859
1859
|
* @public
|
|
1860
1860
|
*/
|
|
1861
|
-
BackendEnvironmentName?: string;
|
|
1861
|
+
BackendEnvironmentName?: string | undefined;
|
|
1862
1862
|
/**
|
|
1863
1863
|
* <p>If the request fails, this error is returned.</p>
|
|
1864
1864
|
* @public
|
|
1865
1865
|
*/
|
|
1866
|
-
Error?: string;
|
|
1866
|
+
Error?: string | undefined;
|
|
1867
1867
|
/**
|
|
1868
1868
|
* <p>The ID for the job.</p>
|
|
1869
1869
|
* @public
|
|
1870
1870
|
*/
|
|
1871
|
-
JobId?: string;
|
|
1871
|
+
JobId?: string | undefined;
|
|
1872
1872
|
/**
|
|
1873
1873
|
* <p>The name of the operation.</p>
|
|
1874
1874
|
* @public
|
|
1875
1875
|
*/
|
|
1876
|
-
Operation?: string;
|
|
1876
|
+
Operation?: string | undefined;
|
|
1877
1877
|
/**
|
|
1878
1878
|
* <p>The current status of the request.</p>
|
|
1879
1879
|
* @public
|
|
1880
1880
|
*/
|
|
1881
|
-
Status?: string;
|
|
1881
|
+
Status?: string | undefined;
|
|
1882
1882
|
}
|
|
1883
1883
|
/**
|
|
1884
1884
|
* <p>The request body for ImportBackendStorage.</p>
|
|
@@ -1899,7 +1899,7 @@ export interface ImportBackendStorageRequest {
|
|
|
1899
1899
|
* <p>The name of the S3 bucket.</p>
|
|
1900
1900
|
* @public
|
|
1901
1901
|
*/
|
|
1902
|
-
BucketName?: string;
|
|
1902
|
+
BucketName?: string | undefined;
|
|
1903
1903
|
/**
|
|
1904
1904
|
* <p>The name of the storage service.</p>
|
|
1905
1905
|
* @public
|
|
@@ -1914,22 +1914,22 @@ export interface ImportBackendStorageResponse {
|
|
|
1914
1914
|
* <p>The app ID.</p>
|
|
1915
1915
|
* @public
|
|
1916
1916
|
*/
|
|
1917
|
-
AppId?: string;
|
|
1917
|
+
AppId?: string | undefined;
|
|
1918
1918
|
/**
|
|
1919
1919
|
* <p>The name of the backend environment.</p>
|
|
1920
1920
|
* @public
|
|
1921
1921
|
*/
|
|
1922
|
-
BackendEnvironmentName?: string;
|
|
1922
|
+
BackendEnvironmentName?: string | undefined;
|
|
1923
1923
|
/**
|
|
1924
1924
|
* <p>The ID for the job.</p>
|
|
1925
1925
|
* @public
|
|
1926
1926
|
*/
|
|
1927
|
-
JobId?: string;
|
|
1927
|
+
JobId?: string | undefined;
|
|
1928
1928
|
/**
|
|
1929
1929
|
* <p>The current status of the request.</p>
|
|
1930
1930
|
* @public
|
|
1931
1931
|
*/
|
|
1932
|
-
Status?: string;
|
|
1932
|
+
Status?: string | undefined;
|
|
1933
1933
|
}
|
|
1934
1934
|
/**
|
|
1935
1935
|
* <p>The request body for ListBackendJobs.</p>
|
|
@@ -1950,27 +1950,27 @@ export interface ListBackendJobsRequest {
|
|
|
1950
1950
|
* <p>The ID for the job.</p>
|
|
1951
1951
|
* @public
|
|
1952
1952
|
*/
|
|
1953
|
-
JobId?: string;
|
|
1953
|
+
JobId?: string | undefined;
|
|
1954
1954
|
/**
|
|
1955
1955
|
* <p>The maximum number of results that you want in the response.</p>
|
|
1956
1956
|
* @public
|
|
1957
1957
|
*/
|
|
1958
|
-
MaxResults?: number;
|
|
1958
|
+
MaxResults?: number | undefined;
|
|
1959
1959
|
/**
|
|
1960
1960
|
* <p>The token for the next set of results.</p>
|
|
1961
1961
|
* @public
|
|
1962
1962
|
*/
|
|
1963
|
-
NextToken?: string;
|
|
1963
|
+
NextToken?: string | undefined;
|
|
1964
1964
|
/**
|
|
1965
1965
|
* <p>Filters the list of response objects to include only those with the specified operation name.</p>
|
|
1966
1966
|
* @public
|
|
1967
1967
|
*/
|
|
1968
|
-
Operation?: string;
|
|
1968
|
+
Operation?: string | undefined;
|
|
1969
1969
|
/**
|
|
1970
1970
|
* <p>Filters the list of response objects to include only those with the specified status.</p>
|
|
1971
1971
|
* @public
|
|
1972
1972
|
*/
|
|
1973
|
-
Status?: string;
|
|
1973
|
+
Status?: string | undefined;
|
|
1974
1974
|
}
|
|
1975
1975
|
/**
|
|
1976
1976
|
* <p>The response object for this operation.</p>
|
|
@@ -1991,32 +1991,32 @@ export interface BackendJobRespObj {
|
|
|
1991
1991
|
* <p>The time when the job was created.</p>
|
|
1992
1992
|
* @public
|
|
1993
1993
|
*/
|
|
1994
|
-
CreateTime?: string;
|
|
1994
|
+
CreateTime?: string | undefined;
|
|
1995
1995
|
/**
|
|
1996
1996
|
* <p>If the request fails, this error is returned.</p>
|
|
1997
1997
|
* @public
|
|
1998
1998
|
*/
|
|
1999
|
-
Error?: string;
|
|
1999
|
+
Error?: string | undefined;
|
|
2000
2000
|
/**
|
|
2001
2001
|
* <p>The ID for the job.</p>
|
|
2002
2002
|
* @public
|
|
2003
2003
|
*/
|
|
2004
|
-
JobId?: string;
|
|
2004
|
+
JobId?: string | undefined;
|
|
2005
2005
|
/**
|
|
2006
2006
|
* <p>The name of the operation.</p>
|
|
2007
2007
|
* @public
|
|
2008
2008
|
*/
|
|
2009
|
-
Operation?: string;
|
|
2009
|
+
Operation?: string | undefined;
|
|
2010
2010
|
/**
|
|
2011
2011
|
* <p>The current status of the request.</p>
|
|
2012
2012
|
* @public
|
|
2013
2013
|
*/
|
|
2014
|
-
Status?: string;
|
|
2014
|
+
Status?: string | undefined;
|
|
2015
2015
|
/**
|
|
2016
2016
|
* <p>The time when the job was last updated.</p>
|
|
2017
2017
|
* @public
|
|
2018
2018
|
*/
|
|
2019
|
-
UpdateTime?: string;
|
|
2019
|
+
UpdateTime?: string | undefined;
|
|
2020
2020
|
}
|
|
2021
2021
|
/**
|
|
2022
2022
|
* @public
|
|
@@ -2026,12 +2026,12 @@ export interface ListBackendJobsResponse {
|
|
|
2026
2026
|
* <p>An array of jobs and their properties.</p>
|
|
2027
2027
|
* @public
|
|
2028
2028
|
*/
|
|
2029
|
-
Jobs?: BackendJobRespObj[];
|
|
2029
|
+
Jobs?: BackendJobRespObj[] | undefined;
|
|
2030
2030
|
/**
|
|
2031
2031
|
* <p>The token for the next set of results.</p>
|
|
2032
2032
|
* @public
|
|
2033
2033
|
*/
|
|
2034
|
-
NextToken?: string;
|
|
2034
|
+
NextToken?: string | undefined;
|
|
2035
2035
|
}
|
|
2036
2036
|
/**
|
|
2037
2037
|
* <p>The request body for S3Buckets.</p>
|
|
@@ -2042,7 +2042,7 @@ export interface ListS3BucketsRequest {
|
|
|
2042
2042
|
* <p>Reserved for future use.</p>
|
|
2043
2043
|
* @public
|
|
2044
2044
|
*/
|
|
2045
|
-
NextToken?: string;
|
|
2045
|
+
NextToken?: string | undefined;
|
|
2046
2046
|
}
|
|
2047
2047
|
/**
|
|
2048
2048
|
* <p>Describes the metadata of the S3 bucket.</p>
|
|
@@ -2053,12 +2053,12 @@ export interface S3BucketInfo {
|
|
|
2053
2053
|
* <p>The creation date of the S3 bucket.</p>
|
|
2054
2054
|
* @public
|
|
2055
2055
|
*/
|
|
2056
|
-
CreationDate?: string;
|
|
2056
|
+
CreationDate?: string | undefined;
|
|
2057
2057
|
/**
|
|
2058
2058
|
* <p>The name of the S3 bucket.</p>
|
|
2059
2059
|
* @public
|
|
2060
2060
|
*/
|
|
2061
|
-
Name?: string;
|
|
2061
|
+
Name?: string | undefined;
|
|
2062
2062
|
}
|
|
2063
2063
|
/**
|
|
2064
2064
|
* @public
|
|
@@ -2068,12 +2068,12 @@ export interface ListS3BucketsResponse {
|
|
|
2068
2068
|
* <p>The list of S3 buckets.</p>
|
|
2069
2069
|
* @public
|
|
2070
2070
|
*/
|
|
2071
|
-
Buckets?: S3BucketInfo[];
|
|
2071
|
+
Buckets?: S3BucketInfo[] | undefined;
|
|
2072
2072
|
/**
|
|
2073
2073
|
* <p>Reserved for future use.</p>
|
|
2074
2074
|
* @public
|
|
2075
2075
|
*/
|
|
2076
|
-
NextToken?: string;
|
|
2076
|
+
NextToken?: string | undefined;
|
|
2077
2077
|
}
|
|
2078
2078
|
/**
|
|
2079
2079
|
* <p>The request body for RemoveAllBackends.</p>
|
|
@@ -2089,7 +2089,7 @@ export interface RemoveAllBackendsRequest {
|
|
|
2089
2089
|
* <p>Cleans up the Amplify Console app if this value is set to true.</p>
|
|
2090
2090
|
* @public
|
|
2091
2091
|
*/
|
|
2092
|
-
CleanAmplifyApp?: boolean;
|
|
2092
|
+
CleanAmplifyApp?: boolean | undefined;
|
|
2093
2093
|
}
|
|
2094
2094
|
/**
|
|
2095
2095
|
* @public
|
|
@@ -2099,27 +2099,27 @@ export interface RemoveAllBackendsResponse {
|
|
|
2099
2099
|
* <p>The app ID.</p>
|
|
2100
2100
|
* @public
|
|
2101
2101
|
*/
|
|
2102
|
-
AppId?: string;
|
|
2102
|
+
AppId?: string | undefined;
|
|
2103
2103
|
/**
|
|
2104
2104
|
* <p>If the request fails, this error is returned.</p>
|
|
2105
2105
|
* @public
|
|
2106
2106
|
*/
|
|
2107
|
-
Error?: string;
|
|
2107
|
+
Error?: string | undefined;
|
|
2108
2108
|
/**
|
|
2109
2109
|
* <p>The ID for the job.</p>
|
|
2110
2110
|
* @public
|
|
2111
2111
|
*/
|
|
2112
|
-
JobId?: string;
|
|
2112
|
+
JobId?: string | undefined;
|
|
2113
2113
|
/**
|
|
2114
2114
|
* <p>The name of the operation.</p>
|
|
2115
2115
|
* @public
|
|
2116
2116
|
*/
|
|
2117
|
-
Operation?: string;
|
|
2117
|
+
Operation?: string | undefined;
|
|
2118
2118
|
/**
|
|
2119
2119
|
* <p>The current status of the request.</p>
|
|
2120
2120
|
* @public
|
|
2121
2121
|
*/
|
|
2122
|
-
Status?: string;
|
|
2122
|
+
Status?: string | undefined;
|
|
2123
2123
|
}
|
|
2124
2124
|
/**
|
|
2125
2125
|
* @public
|
|
@@ -2139,7 +2139,7 @@ export interface RemoveBackendConfigResponse {
|
|
|
2139
2139
|
* <p>If the request fails, this error is returned.</p>
|
|
2140
2140
|
* @public
|
|
2141
2141
|
*/
|
|
2142
|
-
Error?: string;
|
|
2142
|
+
Error?: string | undefined;
|
|
2143
2143
|
}
|
|
2144
2144
|
/**
|
|
2145
2145
|
* <p>The request body for UpdateBackendAPI.</p>
|
|
@@ -2160,7 +2160,7 @@ export interface UpdateBackendAPIRequest {
|
|
|
2160
2160
|
* <p>Defines the resource configuration for the data model in your Amplify project.</p>
|
|
2161
2161
|
* @public
|
|
2162
2162
|
*/
|
|
2163
|
-
ResourceConfig?: BackendAPIResourceConfig;
|
|
2163
|
+
ResourceConfig?: BackendAPIResourceConfig | undefined;
|
|
2164
2164
|
/**
|
|
2165
2165
|
* <p>The name of this resource.</p>
|
|
2166
2166
|
* @public
|
|
@@ -2175,32 +2175,32 @@ export interface UpdateBackendAPIResponse {
|
|
|
2175
2175
|
* <p>The app ID.</p>
|
|
2176
2176
|
* @public
|
|
2177
2177
|
*/
|
|
2178
|
-
AppId?: string;
|
|
2178
|
+
AppId?: string | undefined;
|
|
2179
2179
|
/**
|
|
2180
2180
|
* <p>The name of the backend environment.</p>
|
|
2181
2181
|
* @public
|
|
2182
2182
|
*/
|
|
2183
|
-
BackendEnvironmentName?: string;
|
|
2183
|
+
BackendEnvironmentName?: string | undefined;
|
|
2184
2184
|
/**
|
|
2185
2185
|
* <p>If the request fails, this error is returned.</p>
|
|
2186
2186
|
* @public
|
|
2187
2187
|
*/
|
|
2188
|
-
Error?: string;
|
|
2188
|
+
Error?: string | undefined;
|
|
2189
2189
|
/**
|
|
2190
2190
|
* <p>The ID for the job.</p>
|
|
2191
2191
|
* @public
|
|
2192
2192
|
*/
|
|
2193
|
-
JobId?: string;
|
|
2193
|
+
JobId?: string | undefined;
|
|
2194
2194
|
/**
|
|
2195
2195
|
* <p>The name of the operation.</p>
|
|
2196
2196
|
* @public
|
|
2197
2197
|
*/
|
|
2198
|
-
Operation?: string;
|
|
2198
|
+
Operation?: string | undefined;
|
|
2199
2199
|
/**
|
|
2200
2200
|
* <p>The current status of the request.</p>
|
|
2201
2201
|
* @public
|
|
2202
2202
|
*/
|
|
2203
|
-
Status?: string;
|
|
2203
|
+
Status?: string | undefined;
|
|
2204
2204
|
}
|
|
2205
2205
|
/**
|
|
2206
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>
|
|
@@ -2211,7 +2211,7 @@ export interface UpdateBackendAuthIdentityPoolConfig {
|
|
|
2211
2211
|
* <p>A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.</p>
|
|
2212
2212
|
* @public
|
|
2213
2213
|
*/
|
|
2214
|
-
UnauthenticatedLogin?: boolean;
|
|
2214
|
+
UnauthenticatedLogin?: boolean | undefined;
|
|
2215
2215
|
}
|
|
2216
2216
|
/**
|
|
2217
2217
|
* <p><b>(DEPRECATED)</b> Describes the forgot password policy for authenticating into the Amplify app.</p>
|
|
@@ -2222,17 +2222,17 @@ export interface UpdateBackendAuthForgotPasswordConfig {
|
|
|
2222
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
2223
|
* @public
|
|
2224
2224
|
*/
|
|
2225
|
-
DeliveryMethod?: DeliveryMethod;
|
|
2225
|
+
DeliveryMethod?: DeliveryMethod | undefined;
|
|
2226
2226
|
/**
|
|
2227
2227
|
* <p><b>(DEPRECATED)</b> The configuration for the email sent when an app user forgets their password.</p>
|
|
2228
2228
|
* @public
|
|
2229
2229
|
*/
|
|
2230
|
-
EmailSettings?: EmailSettings;
|
|
2230
|
+
EmailSettings?: EmailSettings | undefined;
|
|
2231
2231
|
/**
|
|
2232
2232
|
* <p><b>(DEPRECATED)</b> The configuration for the SMS message sent when an Amplify app user forgets their password.</p>
|
|
2233
2233
|
* @public
|
|
2234
2234
|
*/
|
|
2235
|
-
SmsSettings?: SmsSettings;
|
|
2235
|
+
SmsSettings?: SmsSettings | undefined;
|
|
2236
2236
|
}
|
|
2237
2237
|
/**
|
|
2238
2238
|
* <p>Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.</p>
|
|
@@ -2243,12 +2243,12 @@ export interface UpdateBackendAuthMFAConfig {
|
|
|
2243
2243
|
* <p>The MFA mode for the backend of your Amplify project.</p>
|
|
2244
2244
|
* @public
|
|
2245
2245
|
*/
|
|
2246
|
-
MFAMode?: MFAMode;
|
|
2246
|
+
MFAMode?: MFAMode | undefined;
|
|
2247
2247
|
/**
|
|
2248
2248
|
* <p>The settings of your MFA configuration for the backend of your Amplify project.</p>
|
|
2249
2249
|
* @public
|
|
2250
2250
|
*/
|
|
2251
|
-
Settings?: Settings;
|
|
2251
|
+
Settings?: Settings | undefined;
|
|
2252
2252
|
}
|
|
2253
2253
|
/**
|
|
2254
2254
|
* <p>The OAuth configurations for authenticating users into your Amplify app.</p>
|
|
@@ -2259,32 +2259,32 @@ export interface UpdateBackendAuthOAuthConfig {
|
|
|
2259
2259
|
* <p>The Amazon Cognito domain prefix used to create a hosted UI for authentication.</p>
|
|
2260
2260
|
* @public
|
|
2261
2261
|
*/
|
|
2262
|
-
DomainPrefix?: string;
|
|
2262
|
+
DomainPrefix?: string | undefined;
|
|
2263
2263
|
/**
|
|
2264
2264
|
* <p>The OAuth grant type to allow app users to authenticate from your Amplify app.</p>
|
|
2265
2265
|
* @public
|
|
2266
2266
|
*/
|
|
2267
|
-
OAuthGrantType?: OAuthGrantType;
|
|
2267
|
+
OAuthGrantType?: OAuthGrantType | undefined;
|
|
2268
2268
|
/**
|
|
2269
2269
|
* <p>The list of OAuth-related flows that can allow users to authenticate from your Amplify app.</p>
|
|
2270
2270
|
* @public
|
|
2271
2271
|
*/
|
|
2272
|
-
OAuthScopes?: OAuthScopesElement[];
|
|
2272
|
+
OAuthScopes?: OAuthScopesElement[] | undefined;
|
|
2273
2273
|
/**
|
|
2274
2274
|
* <p>Redirect URLs that OAuth uses when a user signs in to an Amplify app.</p>
|
|
2275
2275
|
* @public
|
|
2276
2276
|
*/
|
|
2277
|
-
RedirectSignInURIs?: string[];
|
|
2277
|
+
RedirectSignInURIs?: string[] | undefined;
|
|
2278
2278
|
/**
|
|
2279
2279
|
* <p>Redirect URLs that OAuth uses when a user signs out of an Amplify app.</p>
|
|
2280
2280
|
* @public
|
|
2281
2281
|
*/
|
|
2282
|
-
RedirectSignOutURIs?: string[];
|
|
2282
|
+
RedirectSignOutURIs?: string[] | undefined;
|
|
2283
2283
|
/**
|
|
2284
2284
|
* <p>Describes third-party social federation configurations for allowing your users to sign in with OAuth.</p>
|
|
2285
2285
|
* @public
|
|
2286
2286
|
*/
|
|
2287
|
-
SocialProviderSettings?: SocialProviderSettings;
|
|
2287
|
+
SocialProviderSettings?: SocialProviderSettings | undefined;
|
|
2288
2288
|
}
|
|
2289
2289
|
/**
|
|
2290
2290
|
* <p>Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.</p>
|
|
@@ -2295,12 +2295,12 @@ export interface UpdateBackendAuthPasswordPolicyConfig {
|
|
|
2295
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
2296
|
* @public
|
|
2297
2297
|
*/
|
|
2298
|
-
AdditionalConstraints?: AdditionalConstraintsElement[];
|
|
2298
|
+
AdditionalConstraints?: AdditionalConstraintsElement[] | undefined;
|
|
2299
2299
|
/**
|
|
2300
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
2301
|
* @public
|
|
2302
2302
|
*/
|
|
2303
|
-
MinimumLength?: number;
|
|
2303
|
+
MinimumLength?: number | undefined;
|
|
2304
2304
|
}
|
|
2305
2305
|
/**
|
|
2306
2306
|
* <p>Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.</p>
|
|
@@ -2316,12 +2316,12 @@ export interface UpdateBackendAuthVerificationMessageConfig {
|
|
|
2316
2316
|
* <p>The settings for the email message.</p>
|
|
2317
2317
|
* @public
|
|
2318
2318
|
*/
|
|
2319
|
-
EmailSettings?: EmailSettings;
|
|
2319
|
+
EmailSettings?: EmailSettings | undefined;
|
|
2320
2320
|
/**
|
|
2321
2321
|
* <p>The settings for the SMS message.</p>
|
|
2322
2322
|
* @public
|
|
2323
2323
|
*/
|
|
2324
|
-
SmsSettings?: SmsSettings;
|
|
2324
|
+
SmsSettings?: SmsSettings | undefined;
|
|
2325
2325
|
}
|
|
2326
2326
|
/**
|
|
2327
2327
|
* <p>Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.</p>
|
|
@@ -2332,27 +2332,27 @@ export interface UpdateBackendAuthUserPoolConfig {
|
|
|
2332
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
2333
|
* @public
|
|
2334
2334
|
*/
|
|
2335
|
-
ForgotPassword?: UpdateBackendAuthForgotPasswordConfig;
|
|
2335
|
+
ForgotPassword?: UpdateBackendAuthForgotPasswordConfig | undefined;
|
|
2336
2336
|
/**
|
|
2337
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
2338
|
* @public
|
|
2339
2339
|
*/
|
|
2340
|
-
Mfa?: UpdateBackendAuthMFAConfig;
|
|
2340
|
+
Mfa?: UpdateBackendAuthMFAConfig | undefined;
|
|
2341
2341
|
/**
|
|
2342
2342
|
* <p>Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>
|
|
2343
2343
|
* @public
|
|
2344
2344
|
*/
|
|
2345
|
-
OAuth?: UpdateBackendAuthOAuthConfig;
|
|
2345
|
+
OAuth?: UpdateBackendAuthOAuthConfig | undefined;
|
|
2346
2346
|
/**
|
|
2347
2347
|
* <p>Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>
|
|
2348
2348
|
* @public
|
|
2349
2349
|
*/
|
|
2350
|
-
PasswordPolicy?: UpdateBackendAuthPasswordPolicyConfig;
|
|
2350
|
+
PasswordPolicy?: UpdateBackendAuthPasswordPolicyConfig | undefined;
|
|
2351
2351
|
/**
|
|
2352
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
2353
|
* @public
|
|
2354
2354
|
*/
|
|
2355
|
-
VerificationMessage?: UpdateBackendAuthVerificationMessageConfig;
|
|
2355
|
+
VerificationMessage?: UpdateBackendAuthVerificationMessageConfig | undefined;
|
|
2356
2356
|
}
|
|
2357
2357
|
/**
|
|
2358
2358
|
* <p>Defines the resource configuration when updating an authentication resource in your Amplify project.</p>
|
|
@@ -2368,7 +2368,7 @@ export interface UpdateBackendAuthResourceConfig {
|
|
|
2368
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
2369
|
* @public
|
|
2370
2370
|
*/
|
|
2371
|
-
IdentityPoolConfigs?: UpdateBackendAuthIdentityPoolConfig;
|
|
2371
|
+
IdentityPoolConfigs?: UpdateBackendAuthIdentityPoolConfig | undefined;
|
|
2372
2372
|
/**
|
|
2373
2373
|
* <p>Defines the service name to use when configuring an authentication resource in your Amplify project.</p>
|
|
2374
2374
|
* @public
|
|
@@ -2414,32 +2414,32 @@ export interface UpdateBackendAuthResponse {
|
|
|
2414
2414
|
* <p>The app ID.</p>
|
|
2415
2415
|
* @public
|
|
2416
2416
|
*/
|
|
2417
|
-
AppId?: string;
|
|
2417
|
+
AppId?: string | undefined;
|
|
2418
2418
|
/**
|
|
2419
2419
|
* <p>The name of the backend environment.</p>
|
|
2420
2420
|
* @public
|
|
2421
2421
|
*/
|
|
2422
|
-
BackendEnvironmentName?: string;
|
|
2422
|
+
BackendEnvironmentName?: string | undefined;
|
|
2423
2423
|
/**
|
|
2424
2424
|
* <p>If the request fails, this error is returned.</p>
|
|
2425
2425
|
* @public
|
|
2426
2426
|
*/
|
|
2427
|
-
Error?: string;
|
|
2427
|
+
Error?: string | undefined;
|
|
2428
2428
|
/**
|
|
2429
2429
|
* <p>The ID for the job.</p>
|
|
2430
2430
|
* @public
|
|
2431
2431
|
*/
|
|
2432
|
-
JobId?: string;
|
|
2432
|
+
JobId?: string | undefined;
|
|
2433
2433
|
/**
|
|
2434
2434
|
* <p>The name of the operation.</p>
|
|
2435
2435
|
* @public
|
|
2436
2436
|
*/
|
|
2437
|
-
Operation?: string;
|
|
2437
|
+
Operation?: string | undefined;
|
|
2438
2438
|
/**
|
|
2439
2439
|
* <p>The current status of the request.</p>
|
|
2440
2440
|
* @public
|
|
2441
2441
|
*/
|
|
2442
|
-
Status?: string;
|
|
2442
|
+
Status?: string | undefined;
|
|
2443
2443
|
}
|
|
2444
2444
|
/**
|
|
2445
2445
|
* <p>The request object for this operation.</p>
|
|
@@ -2450,22 +2450,22 @@ export interface LoginAuthConfigReqObj {
|
|
|
2450
2450
|
* <p>The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.</p>
|
|
2451
2451
|
* @public
|
|
2452
2452
|
*/
|
|
2453
|
-
AwsCognitoIdentityPoolId?: string;
|
|
2453
|
+
AwsCognitoIdentityPoolId?: string | undefined;
|
|
2454
2454
|
/**
|
|
2455
2455
|
* <p>The AWS Region for the Amplify Admin UI login.</p>
|
|
2456
2456
|
* @public
|
|
2457
2457
|
*/
|
|
2458
|
-
AwsCognitoRegion?: string;
|
|
2458
|
+
AwsCognitoRegion?: string | undefined;
|
|
2459
2459
|
/**
|
|
2460
2460
|
* <p>The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.</p>
|
|
2461
2461
|
* @public
|
|
2462
2462
|
*/
|
|
2463
|
-
AwsUserPoolsId?: string;
|
|
2463
|
+
AwsUserPoolsId?: string | undefined;
|
|
2464
2464
|
/**
|
|
2465
2465
|
* <p>The web client ID for the Amazon Cognito user pools.</p>
|
|
2466
2466
|
* @public
|
|
2467
2467
|
*/
|
|
2468
|
-
AwsUserPoolsWebClientId?: string;
|
|
2468
|
+
AwsUserPoolsWebClientId?: string | undefined;
|
|
2469
2469
|
}
|
|
2470
2470
|
/**
|
|
2471
2471
|
* <p>The request body for UpdateBackendConfig.</p>
|
|
@@ -2481,7 +2481,7 @@ export interface UpdateBackendConfigRequest {
|
|
|
2481
2481
|
* <p>Describes the Amazon Cognito configuration for Admin UI access.</p>
|
|
2482
2482
|
* @public
|
|
2483
2483
|
*/
|
|
2484
|
-
LoginAuthConfig?: LoginAuthConfigReqObj;
|
|
2484
|
+
LoginAuthConfig?: LoginAuthConfigReqObj | undefined;
|
|
2485
2485
|
}
|
|
2486
2486
|
/**
|
|
2487
2487
|
* @public
|
|
@@ -2491,22 +2491,22 @@ export interface UpdateBackendConfigResponse {
|
|
|
2491
2491
|
* <p>The app ID.</p>
|
|
2492
2492
|
* @public
|
|
2493
2493
|
*/
|
|
2494
|
-
AppId?: string;
|
|
2494
|
+
AppId?: string | undefined;
|
|
2495
2495
|
/**
|
|
2496
2496
|
* <p>The app ID for the backend manager.</p>
|
|
2497
2497
|
* @public
|
|
2498
2498
|
*/
|
|
2499
|
-
BackendManagerAppId?: string;
|
|
2499
|
+
BackendManagerAppId?: string | undefined;
|
|
2500
2500
|
/**
|
|
2501
2501
|
* <p>If the request fails, this error is returned.</p>
|
|
2502
2502
|
* @public
|
|
2503
2503
|
*/
|
|
2504
|
-
Error?: string;
|
|
2504
|
+
Error?: string | undefined;
|
|
2505
2505
|
/**
|
|
2506
2506
|
* <p>Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.</p>
|
|
2507
2507
|
* @public
|
|
2508
2508
|
*/
|
|
2509
|
-
LoginAuthConfig?: LoginAuthConfigReqObj;
|
|
2509
|
+
LoginAuthConfig?: LoginAuthConfigReqObj | undefined;
|
|
2510
2510
|
}
|
|
2511
2511
|
/**
|
|
2512
2512
|
* <p>The request body for GetBackendJob.</p>
|
|
@@ -2532,12 +2532,12 @@ export interface UpdateBackendJobRequest {
|
|
|
2532
2532
|
* <p>Filters the list of response objects to include only those with the specified operation name.</p>
|
|
2533
2533
|
* @public
|
|
2534
2534
|
*/
|
|
2535
|
-
Operation?: string;
|
|
2535
|
+
Operation?: string | undefined;
|
|
2536
2536
|
/**
|
|
2537
2537
|
* <p>Filters the list of response objects to include only those with the specified status.</p>
|
|
2538
2538
|
* @public
|
|
2539
2539
|
*/
|
|
2540
|
-
Status?: string;
|
|
2540
|
+
Status?: string | undefined;
|
|
2541
2541
|
}
|
|
2542
2542
|
/**
|
|
2543
2543
|
* @public
|
|
@@ -2547,42 +2547,42 @@ export interface UpdateBackendJobResponse {
|
|
|
2547
2547
|
* <p>The app ID.</p>
|
|
2548
2548
|
* @public
|
|
2549
2549
|
*/
|
|
2550
|
-
AppId?: string;
|
|
2550
|
+
AppId?: string | undefined;
|
|
2551
2551
|
/**
|
|
2552
2552
|
* <p>The name of the backend environment.</p>
|
|
2553
2553
|
* @public
|
|
2554
2554
|
*/
|
|
2555
|
-
BackendEnvironmentName?: string;
|
|
2555
|
+
BackendEnvironmentName?: string | undefined;
|
|
2556
2556
|
/**
|
|
2557
2557
|
* <p>The time when the job was created.</p>
|
|
2558
2558
|
* @public
|
|
2559
2559
|
*/
|
|
2560
|
-
CreateTime?: string;
|
|
2560
|
+
CreateTime?: string | undefined;
|
|
2561
2561
|
/**
|
|
2562
2562
|
* <p>If the request fails, this error is returned.</p>
|
|
2563
2563
|
* @public
|
|
2564
2564
|
*/
|
|
2565
|
-
Error?: string;
|
|
2565
|
+
Error?: string | undefined;
|
|
2566
2566
|
/**
|
|
2567
2567
|
* <p>The ID for the job.</p>
|
|
2568
2568
|
* @public
|
|
2569
2569
|
*/
|
|
2570
|
-
JobId?: string;
|
|
2570
|
+
JobId?: string | undefined;
|
|
2571
2571
|
/**
|
|
2572
2572
|
* <p>The name of the operation.</p>
|
|
2573
2573
|
* @public
|
|
2574
2574
|
*/
|
|
2575
|
-
Operation?: string;
|
|
2575
|
+
Operation?: string | undefined;
|
|
2576
2576
|
/**
|
|
2577
2577
|
* <p>The current status of the request.</p>
|
|
2578
2578
|
* @public
|
|
2579
2579
|
*/
|
|
2580
|
-
Status?: string;
|
|
2580
|
+
Status?: string | undefined;
|
|
2581
2581
|
/**
|
|
2582
2582
|
* <p>The time when the job was last updated.</p>
|
|
2583
2583
|
* @public
|
|
2584
2584
|
*/
|
|
2585
|
-
UpdateTime?: string;
|
|
2585
|
+
UpdateTime?: string | undefined;
|
|
2586
2586
|
}
|
|
2587
2587
|
/**
|
|
2588
2588
|
* <p>The resource configuration for updating backend storage.</p>
|
|
@@ -2634,22 +2634,22 @@ export interface UpdateBackendStorageResponse {
|
|
|
2634
2634
|
* <p>The app ID.</p>
|
|
2635
2635
|
* @public
|
|
2636
2636
|
*/
|
|
2637
|
-
AppId?: string;
|
|
2637
|
+
AppId?: string | undefined;
|
|
2638
2638
|
/**
|
|
2639
2639
|
* <p>The name of the backend environment.</p>
|
|
2640
2640
|
* @public
|
|
2641
2641
|
*/
|
|
2642
|
-
BackendEnvironmentName?: string;
|
|
2642
|
+
BackendEnvironmentName?: string | undefined;
|
|
2643
2643
|
/**
|
|
2644
2644
|
* <p>The ID for the job.</p>
|
|
2645
2645
|
* @public
|
|
2646
2646
|
*/
|
|
2647
|
-
JobId?: string;
|
|
2647
|
+
JobId?: string | undefined;
|
|
2648
2648
|
/**
|
|
2649
2649
|
* <p>The current status of the request.</p>
|
|
2650
2650
|
* @public
|
|
2651
2651
|
*/
|
|
2652
|
-
Status?: string;
|
|
2652
|
+
Status?: string | undefined;
|
|
2653
2653
|
}
|
|
2654
2654
|
/**
|
|
2655
2655
|
* @internal
|