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