@aws-sdk/client-appsync 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.
Files changed (2) hide show
  1. package/dist-types/models/models_0.d.ts +461 -0
  2. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -35,6 +35,7 @@ export type AuthenticationType = (typeof AuthenticationType)[keyof typeof Authen
35
35
  */
36
36
  export interface LambdaAuthorizerConfig {
37
37
  /**
38
+ * @public
38
39
  * <p>The number of seconds a response should be cached for. The default is 0 seconds, which
39
40
  * disables caching. If you don't specify a value for
40
41
  * <code>authorizerResultTtlInSeconds</code>, the default value is used. The maximum value
@@ -43,6 +44,7 @@ export interface LambdaAuthorizerConfig {
43
44
  */
44
45
  authorizerResultTtlInSeconds?: number;
45
46
  /**
47
+ * @public
46
48
  * <p>The Amazon Resource Name (ARN) of the Lambda function to be called for
47
49
  * authorization. This can be a standard Lambda ARN, a version ARN
48
50
  * (<code>.../v3</code>), or an alias ARN. </p>
@@ -59,6 +61,7 @@ export interface LambdaAuthorizerConfig {
59
61
  */
60
62
  authorizerUri: string | undefined;
61
63
  /**
64
+ * @public
62
65
  * <p>A regular expression for validation of tokens before the Lambda function is
63
66
  * called.</p>
64
67
  */
@@ -70,11 +73,13 @@ export interface LambdaAuthorizerConfig {
70
73
  */
71
74
  export interface OpenIDConnectConfig {
72
75
  /**
76
+ * @public
73
77
  * <p>The issuer for the OIDC configuration. The issuer returned by discovery must exactly
74
78
  * match the value of <code>iss</code> in the ID token.</p>
75
79
  */
76
80
  issuer: string | undefined;
77
81
  /**
82
+ * @public
78
83
  * <p>The client identifier of the relying party at the OpenID identity provider. This
79
84
  * identifier is typically obtained when the relying party is registered with the OpenID
80
85
  * identity provider. You can specify a regular expression so that AppSync can
@@ -82,10 +87,12 @@ export interface OpenIDConnectConfig {
82
87
  */
83
88
  clientId?: string;
84
89
  /**
90
+ * @public
85
91
  * <p>The number of milliseconds that a token is valid after it's issued to a user.</p>
86
92
  */
87
93
  iatTTL?: number;
88
94
  /**
95
+ * @public
89
96
  * <p>The number of milliseconds that a token is valid after being authenticated.</p>
90
97
  */
91
98
  authTTL?: number;
@@ -96,14 +103,17 @@ export interface OpenIDConnectConfig {
96
103
  */
97
104
  export interface CognitoUserPoolConfig {
98
105
  /**
106
+ * @public
99
107
  * <p>The user pool ID.</p>
100
108
  */
101
109
  userPoolId: string | undefined;
102
110
  /**
111
+ * @public
103
112
  * <p>The Amazon Web Services Region in which the user pool was created.</p>
104
113
  */
105
114
  awsRegion: string | undefined;
106
115
  /**
116
+ * @public
107
117
  * <p>A regular expression for validating the incoming Amazon Cognito user pool app client
108
118
  * ID. If this value isn't set, no filtering is applied.</p>
109
119
  */
@@ -115,19 +125,23 @@ export interface CognitoUserPoolConfig {
115
125
  */
116
126
  export interface AdditionalAuthenticationProvider {
117
127
  /**
128
+ * @public
118
129
  * <p>The authentication type: API key, Identity and Access Management (IAM), OpenID
119
130
  * Connect (OIDC), Amazon Cognito user pools, or Lambda.</p>
120
131
  */
121
132
  authenticationType?: AuthenticationType | string;
122
133
  /**
134
+ * @public
123
135
  * <p>The OIDC configuration.</p>
124
136
  */
125
137
  openIDConnectConfig?: OpenIDConnectConfig;
126
138
  /**
139
+ * @public
127
140
  * <p>The Amazon Cognito user pool configuration.</p>
128
141
  */
129
142
  userPoolConfig?: CognitoUserPoolConfig;
130
143
  /**
144
+ * @public
131
145
  * <p>Configuration for Lambda function authorization.</p>
132
146
  */
133
147
  lambdaAuthorizerConfig?: LambdaAuthorizerConfig;
@@ -151,14 +165,17 @@ export type AssociationStatus = (typeof AssociationStatus)[keyof typeof Associat
151
165
  */
152
166
  export interface ApiAssociation {
153
167
  /**
168
+ * @public
154
169
  * <p>The domain name.</p>
155
170
  */
156
171
  domainName?: string;
157
172
  /**
173
+ * @public
158
174
  * <p>The API ID.</p>
159
175
  */
160
176
  apiId?: string;
161
177
  /**
178
+ * @public
162
179
  * <p>Identifies the status of an association.</p>
163
180
  * <ul>
164
181
  * <li>
@@ -180,6 +197,7 @@ export interface ApiAssociation {
180
197
  */
181
198
  associationStatus?: AssociationStatus | string;
182
199
  /**
200
+ * @public
183
201
  * <p>Details about the last deployment status.</p>
184
202
  */
185
203
  deploymentDetail?: string;
@@ -242,11 +260,13 @@ export type ApiCacheType = (typeof ApiCacheType)[keyof typeof ApiCacheType];
242
260
  */
243
261
  export interface ApiCache {
244
262
  /**
263
+ * @public
245
264
  * <p>TTL in seconds for cache entries.</p>
246
265
  * <p>Valid values are 1–3,600 seconds.</p>
247
266
  */
248
267
  ttl?: number;
249
268
  /**
269
+ * @public
250
270
  * <p>Caching behavior.</p>
251
271
  * <ul>
252
272
  * <li>
@@ -263,15 +283,18 @@ export interface ApiCache {
263
283
  */
264
284
  apiCachingBehavior?: ApiCachingBehavior | string;
265
285
  /**
286
+ * @public
266
287
  * <p>Transit encryption flag when connecting to cache. You cannot update this setting after
267
288
  * creation.</p>
268
289
  */
269
290
  transitEncryptionEnabled?: boolean;
270
291
  /**
292
+ * @public
271
293
  * <p>At-rest encryption flag for cache. You cannot update this setting after creation.</p>
272
294
  */
273
295
  atRestEncryptionEnabled?: boolean;
274
296
  /**
297
+ * @public
275
298
  * <p>The cache instance type. Valid values are </p>
276
299
  * <ul>
277
300
  * <li>
@@ -349,6 +372,7 @@ export interface ApiCache {
349
372
  */
350
373
  type?: ApiCacheType | string;
351
374
  /**
375
+ * @public
352
376
  * <p>The cache instance status.</p>
353
377
  * <ul>
354
378
  * <li>
@@ -453,19 +477,23 @@ export interface ApiCache {
453
477
  */
454
478
  export interface ApiKey {
455
479
  /**
480
+ * @public
456
481
  * <p>The API key ID.</p>
457
482
  */
458
483
  id?: string;
459
484
  /**
485
+ * @public
460
486
  * <p>A description of the purpose of the API key.</p>
461
487
  */
462
488
  description?: string;
463
489
  /**
490
+ * @public
464
491
  * <p>The time after which the API key expires. The date is represented as seconds since the
465
492
  * epoch, rounded down to the nearest hour.</p>
466
493
  */
467
494
  expires?: number;
468
495
  /**
496
+ * @public
469
497
  * <p>The time after which the API key is deleted. The date is represented as seconds since
470
498
  * the epoch, rounded down to the nearest hour.</p>
471
499
  */
@@ -526,11 +554,13 @@ export type RuntimeName = (typeof RuntimeName)[keyof typeof RuntimeName];
526
554
  */
527
555
  export interface AppSyncRuntime {
528
556
  /**
557
+ * @public
529
558
  * <p>The <code>name</code> of the runtime to use. Currently, the only allowed value is
530
559
  * <code>APPSYNC_JS</code>.</p>
531
560
  */
532
561
  name: RuntimeName | string | undefined;
533
562
  /**
563
+ * @public
534
564
  * <p>The <code>version</code> of the runtime to use. Currently, the only allowed version is
535
565
  * <code>1.0.0</code>.</p>
536
566
  */
@@ -541,10 +571,12 @@ export interface AppSyncRuntime {
541
571
  */
542
572
  export interface AssociateApiRequest {
543
573
  /**
574
+ * @public
544
575
  * <p>The domain name.</p>
545
576
  */
546
577
  domainName: string | undefined;
547
578
  /**
579
+ * @public
548
580
  * <p>The API ID. Private APIs can not be associated with custom domains.</p>
549
581
  */
550
582
  apiId: string | undefined;
@@ -554,6 +586,7 @@ export interface AssociateApiRequest {
554
586
  */
555
587
  export interface AssociateApiResponse {
556
588
  /**
589
+ * @public
557
590
  * <p>The <code>ApiAssociation</code> object.</p>
558
591
  */
559
592
  apiAssociation?: ApiAssociation;
@@ -564,14 +597,17 @@ export interface AssociateApiResponse {
564
597
  */
565
598
  export interface CodeErrorLocation {
566
599
  /**
600
+ * @public
567
601
  * <p>The line number in the code. Defaults to <code>0</code> if unknown.</p>
568
602
  */
569
603
  line?: number;
570
604
  /**
605
+ * @public
571
606
  * <p>The column number in the code. Defaults to <code>0</code> if unknown.</p>
572
607
  */
573
608
  column?: number;
574
609
  /**
610
+ * @public
575
611
  * <p>The span/length of the error. Defaults to <code>-1</code> if unknown.</p>
576
612
  */
577
613
  span?: number;
@@ -582,18 +618,21 @@ export interface CodeErrorLocation {
582
618
  */
583
619
  export interface CodeError {
584
620
  /**
621
+ * @public
585
622
  * <p>The type of code error. </p>
586
623
  * <p>Examples include, but aren't limited to: <code>LINT_ERROR</code>,
587
624
  * <code>PARSER_ERROR</code>.</p>
588
625
  */
589
626
  errorType?: string;
590
627
  /**
628
+ * @public
591
629
  * <p>A user presentable error.</p>
592
630
  * <p>Examples include, but aren't limited to: <code>Parsing error: Unterminated string
593
631
  * literal</code>.</p>
594
632
  */
595
633
  value?: string;
596
634
  /**
635
+ * @public
597
636
  * <p>The line, column, and span location of the error in the code.</p>
598
637
  */
599
638
  location?: CodeErrorLocation;
@@ -605,6 +644,7 @@ export interface CodeError {
605
644
  */
606
645
  export interface BadRequestDetail {
607
646
  /**
647
+ * @public
608
648
  * <p>Contains the list of errors in the request.</p>
609
649
  */
610
650
  codeErrors?: CodeError[];
@@ -629,11 +669,13 @@ export declare class BadRequestException extends __BaseException {
629
669
  readonly name: "BadRequestException";
630
670
  readonly $fault: "client";
631
671
  /**
672
+ * @public
632
673
  * <p>Provides context for the cause of the bad request. The only supported value is
633
674
  * <code>CODE_ERROR</code>.</p>
634
675
  */
635
676
  reason?: BadRequestReason | string;
636
677
  /**
678
+ * @public
637
679
  * <p>Provides further details for the reason behind the bad request. For reason type
638
680
  * <code>CODE_ERROR</code>, the detail will contain a list of code errors.</p>
639
681
  */
@@ -686,6 +728,7 @@ export type MergeType = (typeof MergeType)[keyof typeof MergeType];
686
728
  */
687
729
  export interface SourceApiAssociationConfig {
688
730
  /**
731
+ * @public
689
732
  * <p>The property that indicates which merging option is enabled in the source API association.</p>
690
733
  * <p>Valid merge types are <code>MANUAL_MERGE</code> (default) and <code>AUTO_MERGE</code>. Manual merges are the
691
734
  * default behavior and require the user to trigger any changes from the source APIs to the merged API manually.
@@ -700,20 +743,24 @@ export interface SourceApiAssociationConfig {
700
743
  */
701
744
  export interface AssociateMergedGraphqlApiRequest {
702
745
  /**
746
+ * @public
703
747
  * <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source
704
748
  * APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs
705
749
  * from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.</p>
706
750
  */
707
751
  sourceApiIdentifier: string | undefined;
708
752
  /**
753
+ * @public
709
754
  * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
710
755
  */
711
756
  mergedApiIdentifier: string | undefined;
712
757
  /**
758
+ * @public
713
759
  * <p>The description field.</p>
714
760
  */
715
761
  description?: string;
716
762
  /**
763
+ * @public
717
764
  * <p>The <code>SourceApiAssociationConfig</code> object data.</p>
718
765
  */
719
766
  sourceApiAssociationConfig?: SourceApiAssociationConfig;
@@ -748,46 +795,57 @@ export type SourceApiAssociationStatus = (typeof SourceApiAssociationStatus)[key
748
795
  */
749
796
  export interface SourceApiAssociation {
750
797
  /**
798
+ * @public
751
799
  * <p>The ID generated by the AppSync service for the source API association.</p>
752
800
  */
753
801
  associationId?: string;
754
802
  /**
803
+ * @public
755
804
  * <p>The Amazon Resource Name (ARN) of the source API association.</p>
756
805
  */
757
806
  associationArn?: string;
758
807
  /**
808
+ * @public
759
809
  * <p>The ID of the AppSync source API.</p>
760
810
  */
761
811
  sourceApiId?: string;
762
812
  /**
813
+ * @public
763
814
  * <p>The Amazon Resource Name (ARN) of the AppSync source API.</p>
764
815
  */
765
816
  sourceApiArn?: string;
766
817
  /**
818
+ * @public
767
819
  * <p>The Amazon Resource Name (ARN) of the AppSync Merged API.</p>
768
820
  */
769
821
  mergedApiArn?: string;
770
822
  /**
823
+ * @public
771
824
  * <p>The ID of the AppSync Merged API.</p>
772
825
  */
773
826
  mergedApiId?: string;
774
827
  /**
828
+ * @public
775
829
  * <p>The description field.</p>
776
830
  */
777
831
  description?: string;
778
832
  /**
833
+ * @public
779
834
  * <p>The <code>SourceApiAssociationConfig</code> object data.</p>
780
835
  */
781
836
  sourceApiAssociationConfig?: SourceApiAssociationConfig;
782
837
  /**
838
+ * @public
783
839
  * <p>The state of the source API association.</p>
784
840
  */
785
841
  sourceApiAssociationStatus?: SourceApiAssociationStatus | string;
786
842
  /**
843
+ * @public
787
844
  * <p>The detailed message related to the current state of the source API association.</p>
788
845
  */
789
846
  sourceApiAssociationStatusDetail?: string;
790
847
  /**
848
+ * @public
791
849
  * <p>The datetime value of the last successful merge of the source API association. The result will be in UTC
792
850
  * format and your local time zone.</p>
793
851
  */
@@ -798,6 +856,7 @@ export interface SourceApiAssociation {
798
856
  */
799
857
  export interface AssociateMergedGraphqlApiResponse {
800
858
  /**
859
+ * @public
801
860
  * <p>The <code>SourceApiAssociation</code> object data.</p>
802
861
  */
803
862
  sourceApiAssociation?: SourceApiAssociation;
@@ -844,20 +903,24 @@ export declare class UnauthorizedException extends __BaseException {
844
903
  */
845
904
  export interface AssociateSourceGraphqlApiRequest {
846
905
  /**
906
+ * @public
847
907
  * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
848
908
  */
849
909
  mergedApiIdentifier: string | undefined;
850
910
  /**
911
+ * @public
851
912
  * <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source
852
913
  * APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs
853
914
  * from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.</p>
854
915
  */
855
916
  sourceApiIdentifier: string | undefined;
856
917
  /**
918
+ * @public
857
919
  * <p>The description field.</p>
858
920
  */
859
921
  description?: string;
860
922
  /**
923
+ * @public
861
924
  * <p>The <code>SourceApiAssociationConfig</code> object data.</p>
862
925
  */
863
926
  sourceApiAssociationConfig?: SourceApiAssociationConfig;
@@ -867,6 +930,7 @@ export interface AssociateSourceGraphqlApiRequest {
867
930
  */
868
931
  export interface AssociateSourceGraphqlApiResponse {
869
932
  /**
933
+ * @public
870
934
  * <p>The <code>SourceApiAssociation</code> object data.</p>
871
935
  */
872
936
  sourceApiAssociation?: SourceApiAssociation;
@@ -888,10 +952,12 @@ export type AuthorizationType = (typeof AuthorizationType)[keyof typeof Authoriz
888
952
  */
889
953
  export interface AwsIamConfig {
890
954
  /**
955
+ * @public
891
956
  * <p>The signing Amazon Web Services Region for IAM authorization.</p>
892
957
  */
893
958
  signingRegion?: string;
894
959
  /**
960
+ * @public
895
961
  * <p>The signing service name for IAM authorization.</p>
896
962
  */
897
963
  signingServiceName?: string;
@@ -902,6 +968,7 @@ export interface AwsIamConfig {
902
968
  */
903
969
  export interface AuthorizationConfig {
904
970
  /**
971
+ * @public
905
972
  * <p>The authorization type that the HTTP endpoint requires.</p>
906
973
  * <ul>
907
974
  * <li>
@@ -913,6 +980,7 @@ export interface AuthorizationConfig {
913
980
  */
914
981
  authorizationType: AuthorizationType | string | undefined;
915
982
  /**
983
+ * @public
916
984
  * <p>The Identity and Access Management (IAM) settings.</p>
917
985
  */
918
986
  awsIamConfig?: AwsIamConfig;
@@ -923,24 +991,29 @@ export interface AuthorizationConfig {
923
991
  */
924
992
  export interface CreateApiCacheRequest {
925
993
  /**
994
+ * @public
926
995
  * <p>The GraphQL API ID.</p>
927
996
  */
928
997
  apiId: string | undefined;
929
998
  /**
999
+ * @public
930
1000
  * <p>TTL in seconds for cache entries.</p>
931
1001
  * <p>Valid values are 1–3,600 seconds.</p>
932
1002
  */
933
1003
  ttl: number | undefined;
934
1004
  /**
1005
+ * @public
935
1006
  * <p>Transit encryption flag when connecting to cache. You cannot update this setting after
936
1007
  * creation.</p>
937
1008
  */
938
1009
  transitEncryptionEnabled?: boolean;
939
1010
  /**
1011
+ * @public
940
1012
  * <p>At-rest encryption flag for cache. You cannot update this setting after creation.</p>
941
1013
  */
942
1014
  atRestEncryptionEnabled?: boolean;
943
1015
  /**
1016
+ * @public
944
1017
  * <p>Caching behavior.</p>
945
1018
  * <ul>
946
1019
  * <li>
@@ -957,6 +1030,7 @@ export interface CreateApiCacheRequest {
957
1030
  */
958
1031
  apiCachingBehavior: ApiCachingBehavior | string | undefined;
959
1032
  /**
1033
+ * @public
960
1034
  * <p>The cache instance type. Valid values are </p>
961
1035
  * <ul>
962
1036
  * <li>
@@ -1040,6 +1114,7 @@ export interface CreateApiCacheRequest {
1040
1114
  */
1041
1115
  export interface CreateApiCacheResponse {
1042
1116
  /**
1117
+ * @public
1043
1118
  * <p>The <code>ApiCache</code> object.</p>
1044
1119
  */
1045
1120
  apiCache?: ApiCache;
@@ -1049,14 +1124,17 @@ export interface CreateApiCacheResponse {
1049
1124
  */
1050
1125
  export interface CreateApiKeyRequest {
1051
1126
  /**
1127
+ * @public
1052
1128
  * <p>The ID for your GraphQL API.</p>
1053
1129
  */
1054
1130
  apiId: string | undefined;
1055
1131
  /**
1132
+ * @public
1056
1133
  * <p>A description of the purpose of the API key.</p>
1057
1134
  */
1058
1135
  description?: string;
1059
1136
  /**
1137
+ * @public
1060
1138
  * <p>From the creation time, the time after which the API key expires. The date is
1061
1139
  * represented as seconds since the epoch, rounded down to the nearest hour. The default value
1062
1140
  * for this parameter is 7 days from creation time. For more information, see .</p>
@@ -1068,6 +1146,7 @@ export interface CreateApiKeyRequest {
1068
1146
  */
1069
1147
  export interface CreateApiKeyResponse {
1070
1148
  /**
1149
+ * @public
1071
1150
  * <p>The API key.</p>
1072
1151
  */
1073
1152
  apiKey?: ApiKey;
@@ -1078,14 +1157,17 @@ export interface CreateApiKeyResponse {
1078
1157
  */
1079
1158
  export interface DeltaSyncConfig {
1080
1159
  /**
1160
+ * @public
1081
1161
  * <p>The number of minutes that an Item is stored in the data source.</p>
1082
1162
  */
1083
1163
  baseTableTTL?: number;
1084
1164
  /**
1165
+ * @public
1085
1166
  * <p>The Delta Sync table name.</p>
1086
1167
  */
1087
1168
  deltaSyncTableName?: string;
1088
1169
  /**
1170
+ * @public
1089
1171
  * <p>The number of minutes that a Delta Sync log entry is stored in the Delta Sync
1090
1172
  * table.</p>
1091
1173
  */
@@ -1097,22 +1179,27 @@ export interface DeltaSyncConfig {
1097
1179
  */
1098
1180
  export interface DynamodbDataSourceConfig {
1099
1181
  /**
1182
+ * @public
1100
1183
  * <p>The table name.</p>
1101
1184
  */
1102
1185
  tableName: string | undefined;
1103
1186
  /**
1187
+ * @public
1104
1188
  * <p>The Amazon Web Services Region.</p>
1105
1189
  */
1106
1190
  awsRegion: string | undefined;
1107
1191
  /**
1192
+ * @public
1108
1193
  * <p>Set to TRUE to use Amazon Cognito credentials with this data source.</p>
1109
1194
  */
1110
1195
  useCallerCredentials?: boolean;
1111
1196
  /**
1197
+ * @public
1112
1198
  * <p>The <code>DeltaSyncConfig</code> for a versioned data source.</p>
1113
1199
  */
1114
1200
  deltaSyncConfig?: DeltaSyncConfig;
1115
1201
  /**
1202
+ * @public
1116
1203
  * <p>Set to TRUE to use Conflict Detection and Resolution with this data source.</p>
1117
1204
  */
1118
1205
  versioned?: boolean;
@@ -1126,10 +1213,12 @@ export interface DynamodbDataSourceConfig {
1126
1213
  */
1127
1214
  export interface ElasticsearchDataSourceConfig {
1128
1215
  /**
1216
+ * @public
1129
1217
  * <p>The endpoint.</p>
1130
1218
  */
1131
1219
  endpoint: string | undefined;
1132
1220
  /**
1221
+ * @public
1133
1222
  * <p>The Amazon Web Services Region.</p>
1134
1223
  */
1135
1224
  awsRegion: string | undefined;
@@ -1140,6 +1229,7 @@ export interface ElasticsearchDataSourceConfig {
1140
1229
  */
1141
1230
  export interface EventBridgeDataSourceConfig {
1142
1231
  /**
1232
+ * @public
1143
1233
  * <p>The ARN of the event bus. For more information about event buses, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html">Amazon
1144
1234
  * EventBridge event buses</a>.</p>
1145
1235
  */
@@ -1151,6 +1241,7 @@ export interface EventBridgeDataSourceConfig {
1151
1241
  */
1152
1242
  export interface HttpDataSourceConfig {
1153
1243
  /**
1244
+ * @public
1154
1245
  * <p>The HTTP URL endpoint. You can specify either the domain name or IP, and port
1155
1246
  * combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port,
1156
1247
  * AppSync uses the default port 80 for the HTTP endpoint and port 443 for
@@ -1158,6 +1249,7 @@ export interface HttpDataSourceConfig {
1158
1249
  */
1159
1250
  endpoint?: string;
1160
1251
  /**
1252
+ * @public
1161
1253
  * <p>The authorization configuration in case the HTTP endpoint requires authorization.</p>
1162
1254
  */
1163
1255
  authorizationConfig?: AuthorizationConfig;
@@ -1168,6 +1260,7 @@ export interface HttpDataSourceConfig {
1168
1260
  */
1169
1261
  export interface LambdaDataSourceConfig {
1170
1262
  /**
1263
+ * @public
1171
1264
  * <p>The Amazon Resource Name (ARN) for the Lambda function.</p>
1172
1265
  */
1173
1266
  lambdaFunctionArn: string | undefined;
@@ -1178,10 +1271,12 @@ export interface LambdaDataSourceConfig {
1178
1271
  */
1179
1272
  export interface OpenSearchServiceDataSourceConfig {
1180
1273
  /**
1274
+ * @public
1181
1275
  * <p>The endpoint.</p>
1182
1276
  */
1183
1277
  endpoint: string | undefined;
1184
1278
  /**
1279
+ * @public
1185
1280
  * <p>The Amazon Web Services Region.</p>
1186
1281
  */
1187
1282
  awsRegion: string | undefined;
@@ -1192,22 +1287,27 @@ export interface OpenSearchServiceDataSourceConfig {
1192
1287
  */
1193
1288
  export interface RdsHttpEndpointConfig {
1194
1289
  /**
1290
+ * @public
1195
1291
  * <p>Amazon Web Services Region for Amazon RDS HTTP endpoint.</p>
1196
1292
  */
1197
1293
  awsRegion?: string;
1198
1294
  /**
1295
+ * @public
1199
1296
  * <p>Amazon RDS cluster Amazon Resource Name (ARN).</p>
1200
1297
  */
1201
1298
  dbClusterIdentifier?: string;
1202
1299
  /**
1300
+ * @public
1203
1301
  * <p>Logical database name.</p>
1204
1302
  */
1205
1303
  databaseName?: string;
1206
1304
  /**
1305
+ * @public
1207
1306
  * <p>Logical schema name.</p>
1208
1307
  */
1209
1308
  schema?: string;
1210
1309
  /**
1310
+ * @public
1211
1311
  * <p>Amazon Web Services secret store Amazon Resource Name (ARN) for database
1212
1312
  * credentials.</p>
1213
1313
  */
@@ -1230,6 +1330,7 @@ export type RelationalDatabaseSourceType = (typeof RelationalDatabaseSourceType)
1230
1330
  */
1231
1331
  export interface RelationalDatabaseDataSourceConfig {
1232
1332
  /**
1333
+ * @public
1233
1334
  * <p>Source type for the relational database.</p>
1234
1335
  * <ul>
1235
1336
  * <li>
@@ -1242,6 +1343,7 @@ export interface RelationalDatabaseDataSourceConfig {
1242
1343
  */
1243
1344
  relationalDatabaseSourceType?: RelationalDatabaseSourceType | string;
1244
1345
  /**
1346
+ * @public
1245
1347
  * <p>Amazon RDS HTTP endpoint settings.</p>
1246
1348
  */
1247
1349
  rdsHttpEndpointConfig?: RdsHttpEndpointConfig;
@@ -1269,53 +1371,65 @@ export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType
1269
1371
  */
1270
1372
  export interface CreateDataSourceRequest {
1271
1373
  /**
1374
+ * @public
1272
1375
  * <p>The API ID for the GraphQL API for the <code>DataSource</code>.</p>
1273
1376
  */
1274
1377
  apiId: string | undefined;
1275
1378
  /**
1379
+ * @public
1276
1380
  * <p>A user-supplied name for the <code>DataSource</code>.</p>
1277
1381
  */
1278
1382
  name: string | undefined;
1279
1383
  /**
1384
+ * @public
1280
1385
  * <p>A description of the <code>DataSource</code>.</p>
1281
1386
  */
1282
1387
  description?: string;
1283
1388
  /**
1389
+ * @public
1284
1390
  * <p>The type of the <code>DataSource</code>.</p>
1285
1391
  */
1286
1392
  type: DataSourceType | string | undefined;
1287
1393
  /**
1394
+ * @public
1288
1395
  * <p>The Identity and Access Management (IAM) service role Amazon Resource Name (ARN)
1289
1396
  * for the data source. The system assumes this role when accessing the data source.</p>
1290
1397
  */
1291
1398
  serviceRoleArn?: string;
1292
1399
  /**
1400
+ * @public
1293
1401
  * <p>Amazon DynamoDB settings.</p>
1294
1402
  */
1295
1403
  dynamodbConfig?: DynamodbDataSourceConfig;
1296
1404
  /**
1405
+ * @public
1297
1406
  * <p>Lambda settings.</p>
1298
1407
  */
1299
1408
  lambdaConfig?: LambdaDataSourceConfig;
1300
1409
  /**
1410
+ * @public
1301
1411
  * <p>Amazon OpenSearch Service settings.</p>
1302
1412
  * <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This
1303
1413
  * configuration is deprecated. For new data sources, use <a>CreateDataSourceRequest$openSearchServiceConfig</a> to create an OpenSearch data source.</p>
1304
1414
  */
1305
1415
  elasticsearchConfig?: ElasticsearchDataSourceConfig;
1306
1416
  /**
1417
+ * @public
1307
1418
  * <p>Amazon OpenSearch Service settings.</p>
1308
1419
  */
1309
1420
  openSearchServiceConfig?: OpenSearchServiceDataSourceConfig;
1310
1421
  /**
1422
+ * @public
1311
1423
  * <p>HTTP endpoint settings.</p>
1312
1424
  */
1313
1425
  httpConfig?: HttpDataSourceConfig;
1314
1426
  /**
1427
+ * @public
1315
1428
  * <p>Relational database settings.</p>
1316
1429
  */
1317
1430
  relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig;
1318
1431
  /**
1432
+ * @public
1319
1433
  * <p>Amazon EventBridge settings.</p>
1320
1434
  */
1321
1435
  eventBridgeConfig?: EventBridgeDataSourceConfig;
@@ -1326,18 +1440,22 @@ export interface CreateDataSourceRequest {
1326
1440
  */
1327
1441
  export interface DataSource {
1328
1442
  /**
1443
+ * @public
1329
1444
  * <p>The data source Amazon Resource Name (ARN).</p>
1330
1445
  */
1331
1446
  dataSourceArn?: string;
1332
1447
  /**
1448
+ * @public
1333
1449
  * <p>The name of the data source.</p>
1334
1450
  */
1335
1451
  name?: string;
1336
1452
  /**
1453
+ * @public
1337
1454
  * <p>The description of the data source.</p>
1338
1455
  */
1339
1456
  description?: string;
1340
1457
  /**
1458
+ * @public
1341
1459
  * <p>The type of the data source.</p>
1342
1460
  * <ul>
1343
1461
  * <li>
@@ -1384,35 +1502,43 @@ export interface DataSource {
1384
1502
  */
1385
1503
  type?: DataSourceType | string;
1386
1504
  /**
1505
+ * @public
1387
1506
  * <p>The Identity and Access Management (IAM) service role Amazon Resource Name (ARN)
1388
1507
  * for the data source. The system assumes this role when accessing the data source.</p>
1389
1508
  */
1390
1509
  serviceRoleArn?: string;
1391
1510
  /**
1511
+ * @public
1392
1512
  * <p>DynamoDB settings.</p>
1393
1513
  */
1394
1514
  dynamodbConfig?: DynamodbDataSourceConfig;
1395
1515
  /**
1516
+ * @public
1396
1517
  * <p>Lambda settings.</p>
1397
1518
  */
1398
1519
  lambdaConfig?: LambdaDataSourceConfig;
1399
1520
  /**
1521
+ * @public
1400
1522
  * <p>Amazon OpenSearch Service settings.</p>
1401
1523
  */
1402
1524
  elasticsearchConfig?: ElasticsearchDataSourceConfig;
1403
1525
  /**
1526
+ * @public
1404
1527
  * <p>Amazon OpenSearch Service settings.</p>
1405
1528
  */
1406
1529
  openSearchServiceConfig?: OpenSearchServiceDataSourceConfig;
1407
1530
  /**
1531
+ * @public
1408
1532
  * <p>HTTP endpoint settings.</p>
1409
1533
  */
1410
1534
  httpConfig?: HttpDataSourceConfig;
1411
1535
  /**
1536
+ * @public
1412
1537
  * <p>Relational database settings.</p>
1413
1538
  */
1414
1539
  relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig;
1415
1540
  /**
1541
+ * @public
1416
1542
  * <p>Amazon EventBridge settings.</p>
1417
1543
  */
1418
1544
  eventBridgeConfig?: EventBridgeDataSourceConfig;
@@ -1422,6 +1548,7 @@ export interface DataSource {
1422
1548
  */
1423
1549
  export interface CreateDataSourceResponse {
1424
1550
  /**
1551
+ * @public
1425
1552
  * <p>The <code>DataSource</code> object.</p>
1426
1553
  */
1427
1554
  dataSource?: DataSource;
@@ -1431,16 +1558,19 @@ export interface CreateDataSourceResponse {
1431
1558
  */
1432
1559
  export interface CreateDomainNameRequest {
1433
1560
  /**
1561
+ * @public
1434
1562
  * <p>The domain name.</p>
1435
1563
  */
1436
1564
  domainName: string | undefined;
1437
1565
  /**
1566
+ * @public
1438
1567
  * <p>The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager
1439
1568
  * (ACM) certificate or an Identity and Access Management (IAM)
1440
1569
  * server certificate.</p>
1441
1570
  */
1442
1571
  certificateArn: string | undefined;
1443
1572
  /**
1573
+ * @public
1444
1574
  * <p>A description of the <code>DomainName</code>.</p>
1445
1575
  */
1446
1576
  description?: string;
@@ -1451,24 +1581,29 @@ export interface CreateDomainNameRequest {
1451
1581
  */
1452
1582
  export interface DomainNameConfig {
1453
1583
  /**
1584
+ * @public
1454
1585
  * <p>The domain name.</p>
1455
1586
  */
1456
1587
  domainName?: string;
1457
1588
  /**
1589
+ * @public
1458
1590
  * <p>A description of the <code>DomainName</code> configuration.</p>
1459
1591
  */
1460
1592
  description?: string;
1461
1593
  /**
1594
+ * @public
1462
1595
  * <p>The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager
1463
1596
  * (ACM) certificate or an Identity and Access Management (IAM)
1464
1597
  * server certificate.</p>
1465
1598
  */
1466
1599
  certificateArn?: string;
1467
1600
  /**
1601
+ * @public
1468
1602
  * <p>The domain name that AppSync provides.</p>
1469
1603
  */
1470
1604
  appsyncDomainName?: string;
1471
1605
  /**
1606
+ * @public
1472
1607
  * <p>The ID of your Amazon Route 53 hosted zone.</p>
1473
1608
  */
1474
1609
  hostedZoneId?: string;
@@ -1478,6 +1613,7 @@ export interface DomainNameConfig {
1478
1613
  */
1479
1614
  export interface CreateDomainNameResponse {
1480
1615
  /**
1616
+ * @public
1481
1617
  * <p>The configuration for the <code>DomainName</code>.</p>
1482
1618
  */
1483
1619
  domainNameConfig?: DomainNameConfig;
@@ -1515,6 +1651,7 @@ export type ConflictHandlerType = (typeof ConflictHandlerType)[keyof typeof Conf
1515
1651
  */
1516
1652
  export interface LambdaConflictHandlerConfig {
1517
1653
  /**
1654
+ * @public
1518
1655
  * <p>The Amazon Resource Name (ARN) for the Lambda function to use as the
1519
1656
  * Conflict Handler.</p>
1520
1657
  */
@@ -1528,6 +1665,7 @@ export interface LambdaConflictHandlerConfig {
1528
1665
  */
1529
1666
  export interface SyncConfig {
1530
1667
  /**
1668
+ * @public
1531
1669
  * <p>The Conflict Resolution strategy to perform in the event of a conflict.</p>
1532
1670
  * <ul>
1533
1671
  * <li>
@@ -1550,6 +1688,7 @@ export interface SyncConfig {
1550
1688
  */
1551
1689
  conflictHandler?: ConflictHandlerType | string;
1552
1690
  /**
1691
+ * @public
1553
1692
  * <p>The Conflict Detection strategy to use.</p>
1554
1693
  * <ul>
1555
1694
  * <li>
@@ -1566,6 +1705,7 @@ export interface SyncConfig {
1566
1705
  */
1567
1706
  conflictDetection?: ConflictDetectionType | string;
1568
1707
  /**
1708
+ * @public
1569
1709
  * <p>The <code>LambdaConflictHandlerConfig</code> when configuring <code>LAMBDA</code> as the
1570
1710
  * Conflict Handler.</p>
1571
1711
  */
@@ -1576,53 +1716,64 @@ export interface SyncConfig {
1576
1716
  */
1577
1717
  export interface CreateFunctionRequest {
1578
1718
  /**
1719
+ * @public
1579
1720
  * <p>The GraphQL API ID.</p>
1580
1721
  */
1581
1722
  apiId: string | undefined;
1582
1723
  /**
1724
+ * @public
1583
1725
  * <p>The <code>Function</code> name. The function name does not have to be unique.</p>
1584
1726
  */
1585
1727
  name: string | undefined;
1586
1728
  /**
1729
+ * @public
1587
1730
  * <p>The <code>Function</code> description.</p>
1588
1731
  */
1589
1732
  description?: string;
1590
1733
  /**
1734
+ * @public
1591
1735
  * <p>The <code>Function</code>
1592
1736
  * <code>DataSource</code> name.</p>
1593
1737
  */
1594
1738
  dataSourceName: string | undefined;
1595
1739
  /**
1740
+ * @public
1596
1741
  * <p>The <code>Function</code> request mapping template. Functions support only the
1597
1742
  * 2018-05-29 version of the request mapping template.</p>
1598
1743
  */
1599
1744
  requestMappingTemplate?: string;
1600
1745
  /**
1746
+ * @public
1601
1747
  * <p>The <code>Function</code> response mapping template.</p>
1602
1748
  */
1603
1749
  responseMappingTemplate?: string;
1604
1750
  /**
1751
+ * @public
1605
1752
  * <p>The <code>version</code> of the request mapping template. Currently, the supported value
1606
1753
  * is 2018-05-29. Note that when using VTL and mapping templates, the
1607
1754
  * <code>functionVersion</code> is required.</p>
1608
1755
  */
1609
1756
  functionVersion?: string;
1610
1757
  /**
1758
+ * @public
1611
1759
  * <p>Describes a Sync configuration for a resolver.</p>
1612
1760
  * <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
1613
1761
  * resolver is invoked.</p>
1614
1762
  */
1615
1763
  syncConfig?: SyncConfig;
1616
1764
  /**
1765
+ * @public
1617
1766
  * <p>The maximum batching size for a resolver.</p>
1618
1767
  */
1619
1768
  maxBatchSize?: number;
1620
1769
  /**
1770
+ * @public
1621
1771
  * <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note
1622
1772
  * that if a runtime is specified, code must also be specified.</p>
1623
1773
  */
1624
1774
  runtime?: AppSyncRuntime;
1625
1775
  /**
1776
+ * @public
1626
1777
  * <p>The <code>function</code> code that contains the request and response functions. When
1627
1778
  * code is used, the <code>runtime</code> is required. The <code>runtime</code> value must be
1628
1779
  * <code>APPSYNC_JS</code>.</p>
@@ -1636,55 +1787,67 @@ export interface CreateFunctionRequest {
1636
1787
  */
1637
1788
  export interface FunctionConfiguration {
1638
1789
  /**
1790
+ * @public
1639
1791
  * <p>A unique ID representing the <code>Function</code> object.</p>
1640
1792
  */
1641
1793
  functionId?: string;
1642
1794
  /**
1795
+ * @public
1643
1796
  * <p>The Amazon Resource Name (ARN) of the <code>Function</code> object.</p>
1644
1797
  */
1645
1798
  functionArn?: string;
1646
1799
  /**
1800
+ * @public
1647
1801
  * <p>The name of the <code>Function</code> object.</p>
1648
1802
  */
1649
1803
  name?: string;
1650
1804
  /**
1805
+ * @public
1651
1806
  * <p>The <code>Function</code> description.</p>
1652
1807
  */
1653
1808
  description?: string;
1654
1809
  /**
1810
+ * @public
1655
1811
  * <p>The name of the <code>DataSource</code>.</p>
1656
1812
  */
1657
1813
  dataSourceName?: string;
1658
1814
  /**
1815
+ * @public
1659
1816
  * <p>The <code>Function</code> request mapping template. Functions support only the
1660
1817
  * 2018-05-29 version of the request mapping template.</p>
1661
1818
  */
1662
1819
  requestMappingTemplate?: string;
1663
1820
  /**
1821
+ * @public
1664
1822
  * <p>The <code>Function</code> response mapping template.</p>
1665
1823
  */
1666
1824
  responseMappingTemplate?: string;
1667
1825
  /**
1826
+ * @public
1668
1827
  * <p>The version of the request mapping template. Currently, only the 2018-05-29 version of
1669
1828
  * the template is supported.</p>
1670
1829
  */
1671
1830
  functionVersion?: string;
1672
1831
  /**
1832
+ * @public
1673
1833
  * <p>Describes a Sync configuration for a resolver.</p>
1674
1834
  * <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
1675
1835
  * resolver is invoked.</p>
1676
1836
  */
1677
1837
  syncConfig?: SyncConfig;
1678
1838
  /**
1839
+ * @public
1679
1840
  * <p>The maximum batching size for a resolver.</p>
1680
1841
  */
1681
1842
  maxBatchSize?: number;
1682
1843
  /**
1844
+ * @public
1683
1845
  * <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note
1684
1846
  * that if a runtime is specified, code must also be specified.</p>
1685
1847
  */
1686
1848
  runtime?: AppSyncRuntime;
1687
1849
  /**
1850
+ * @public
1688
1851
  * <p>The <code>function</code> code that contains the request and response functions. When
1689
1852
  * code is used, the <code>runtime</code> is required. The <code>runtime</code> value must be
1690
1853
  * <code>APPSYNC_JS</code>.</p>
@@ -1696,6 +1859,7 @@ export interface FunctionConfiguration {
1696
1859
  */
1697
1860
  export interface CreateFunctionResponse {
1698
1861
  /**
1862
+ * @public
1699
1863
  * <p>The <code>Function</code> object.</p>
1700
1864
  */
1701
1865
  functionConfiguration?: FunctionConfiguration;
@@ -1731,6 +1895,7 @@ export type FieldLogLevel = (typeof FieldLogLevel)[keyof typeof FieldLogLevel];
1731
1895
  */
1732
1896
  export interface LogConfig {
1733
1897
  /**
1898
+ * @public
1734
1899
  * <p>The field logging level. Values can be NONE, ERROR, or ALL.</p>
1735
1900
  * <ul>
1736
1901
  * <li>
@@ -1773,11 +1938,13 @@ export interface LogConfig {
1773
1938
  */
1774
1939
  fieldLogLevel: FieldLogLevel | string | undefined;
1775
1940
  /**
1941
+ * @public
1776
1942
  * <p>The service role that AppSync assumes to publish to CloudWatch
1777
1943
  * logs in your account.</p>
1778
1944
  */
1779
1945
  cloudWatchLogsRoleArn: string | undefined;
1780
1946
  /**
1947
+ * @public
1781
1948
  * <p>Set to TRUE to exclude sections that contain information such as headers, context, and
1782
1949
  * evaluated mapping templates, regardless of logging level.</p>
1783
1950
  */
@@ -1801,19 +1968,23 @@ export type DefaultAction = (typeof DefaultAction)[keyof typeof DefaultAction];
1801
1968
  */
1802
1969
  export interface UserPoolConfig {
1803
1970
  /**
1971
+ * @public
1804
1972
  * <p>The user pool ID.</p>
1805
1973
  */
1806
1974
  userPoolId: string | undefined;
1807
1975
  /**
1976
+ * @public
1808
1977
  * <p>The Amazon Web Services Region in which the user pool was created.</p>
1809
1978
  */
1810
1979
  awsRegion: string | undefined;
1811
1980
  /**
1981
+ * @public
1812
1982
  * <p>The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool
1813
1983
  * configuration.</p>
1814
1984
  */
1815
1985
  defaultAction: DefaultAction | string | undefined;
1816
1986
  /**
1987
+ * @public
1817
1988
  * <p>A regular expression for validating the incoming Amazon Cognito user pool app client
1818
1989
  * ID. If this value isn't set, no filtering is applied.</p>
1819
1990
  */
@@ -1836,56 +2007,68 @@ export type GraphQLApiVisibility = (typeof GraphQLApiVisibility)[keyof typeof Gr
1836
2007
  */
1837
2008
  export interface CreateGraphqlApiRequest {
1838
2009
  /**
2010
+ * @public
1839
2011
  * <p>A user-supplied name for the <code>GraphqlApi</code>.</p>
1840
2012
  */
1841
2013
  name: string | undefined;
1842
2014
  /**
2015
+ * @public
1843
2016
  * <p>The Amazon CloudWatch Logs configuration.</p>
1844
2017
  */
1845
2018
  logConfig?: LogConfig;
1846
2019
  /**
2020
+ * @public
1847
2021
  * <p>The authentication type: API key, Identity and Access Management (IAM), OpenID
1848
2022
  * Connect (OIDC), Amazon Cognito user pools, or Lambda.</p>
1849
2023
  */
1850
2024
  authenticationType: AuthenticationType | string | undefined;
1851
2025
  /**
2026
+ * @public
1852
2027
  * <p>The Amazon Cognito user pool configuration.</p>
1853
2028
  */
1854
2029
  userPoolConfig?: UserPoolConfig;
1855
2030
  /**
2031
+ * @public
1856
2032
  * <p>The OIDC configuration.</p>
1857
2033
  */
1858
2034
  openIDConnectConfig?: OpenIDConnectConfig;
1859
2035
  /**
2036
+ * @public
1860
2037
  * <p>A <code>TagMap</code> object.</p>
1861
2038
  */
1862
2039
  tags?: Record<string, string>;
1863
2040
  /**
2041
+ * @public
1864
2042
  * <p>A list of additional authentication providers for the <code>GraphqlApi</code>
1865
2043
  * API.</p>
1866
2044
  */
1867
2045
  additionalAuthenticationProviders?: AdditionalAuthenticationProvider[];
1868
2046
  /**
2047
+ * @public
1869
2048
  * <p>A flag indicating whether to use X-Ray tracing for the
1870
2049
  * <code>GraphqlApi</code>.</p>
1871
2050
  */
1872
2051
  xrayEnabled?: boolean;
1873
2052
  /**
2053
+ * @public
1874
2054
  * <p>Configuration for Lambda function authorization.</p>
1875
2055
  */
1876
2056
  lambdaAuthorizerConfig?: LambdaAuthorizerConfig;
1877
2057
  /**
2058
+ * @public
1878
2059
  * <p>Sets the value of the GraphQL API to public (<code>GLOBAL</code>) or private (<code>PRIVATE</code>). If no
1879
2060
  * value is provided, the visibility will be set to <code>GLOBAL</code> by default. This value cannot be changed
1880
2061
  * once the API has been created.</p>
1881
2062
  */
1882
2063
  visibility?: GraphQLApiVisibility | string;
1883
2064
  /**
2065
+ * @public
1884
2066
  * <p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API
1885
2067
  * (<code>MERGED</code>).</p>
1886
2068
  */
1887
2069
  apiType?: GraphQLApiType | string;
1888
2070
  /**
2071
+ * @public
1889
2072
  * <p>The Identity and Access Management service role ARN for a merged API. The AppSync
1890
2073
  * service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to
1891
2074
  * prompt the <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes
@@ -1893,6 +2076,7 @@ export interface CreateGraphqlApiRequest {
1893
2076
  */
1894
2077
  mergedApiExecutionRoleArn?: string;
1895
2078
  /**
2079
+ * @public
1896
2080
  * <p>The owner contact information for an API resource.</p>
1897
2081
  * <p>This field accepts any string input with a length of 0 - 256 characters.</p>
1898
2082
  */
@@ -1904,76 +2088,93 @@ export interface CreateGraphqlApiRequest {
1904
2088
  */
1905
2089
  export interface GraphqlApi {
1906
2090
  /**
2091
+ * @public
1907
2092
  * <p>The API name.</p>
1908
2093
  */
1909
2094
  name?: string;
1910
2095
  /**
2096
+ * @public
1911
2097
  * <p>The API ID.</p>
1912
2098
  */
1913
2099
  apiId?: string;
1914
2100
  /**
2101
+ * @public
1915
2102
  * <p>The authentication type.</p>
1916
2103
  */
1917
2104
  authenticationType?: AuthenticationType | string;
1918
2105
  /**
2106
+ * @public
1919
2107
  * <p>The Amazon CloudWatch Logs configuration.</p>
1920
2108
  */
1921
2109
  logConfig?: LogConfig;
1922
2110
  /**
2111
+ * @public
1923
2112
  * <p>The Amazon Cognito user pool configuration.</p>
1924
2113
  */
1925
2114
  userPoolConfig?: UserPoolConfig;
1926
2115
  /**
2116
+ * @public
1927
2117
  * <p>The OpenID Connect configuration.</p>
1928
2118
  */
1929
2119
  openIDConnectConfig?: OpenIDConnectConfig;
1930
2120
  /**
2121
+ * @public
1931
2122
  * <p>The Amazon Resource Name (ARN).</p>
1932
2123
  */
1933
2124
  arn?: string;
1934
2125
  /**
2126
+ * @public
1935
2127
  * <p>The URIs.</p>
1936
2128
  */
1937
2129
  uris?: Record<string, string>;
1938
2130
  /**
2131
+ * @public
1939
2132
  * <p>The tags.</p>
1940
2133
  */
1941
2134
  tags?: Record<string, string>;
1942
2135
  /**
2136
+ * @public
1943
2137
  * <p>A list of additional authentication providers for the <code>GraphqlApi</code>
1944
2138
  * API.</p>
1945
2139
  */
1946
2140
  additionalAuthenticationProviders?: AdditionalAuthenticationProvider[];
1947
2141
  /**
2142
+ * @public
1948
2143
  * <p>A flag indicating whether to use X-Ray tracing for this
1949
2144
  * <code>GraphqlApi</code>.</p>
1950
2145
  */
1951
2146
  xrayEnabled?: boolean;
1952
2147
  /**
2148
+ * @public
1953
2149
  * <p>The ARN of the WAF access control list (ACL) associated with this
1954
2150
  * <code>GraphqlApi</code>, if one exists.</p>
1955
2151
  */
1956
2152
  wafWebAclArn?: string;
1957
2153
  /**
2154
+ * @public
1958
2155
  * <p>Configuration for Lambda function authorization.</p>
1959
2156
  */
1960
2157
  lambdaAuthorizerConfig?: LambdaAuthorizerConfig;
1961
2158
  /**
2159
+ * @public
1962
2160
  * <p>The DNS records for the API.</p>
1963
2161
  */
1964
2162
  dns?: Record<string, string>;
1965
2163
  /**
2164
+ * @public
1966
2165
  * <p>Sets the value of the GraphQL API to public (<code>GLOBAL</code>) or private (<code>PRIVATE</code>). If no
1967
2166
  * value is provided, the visibility will be set to <code>GLOBAL</code> by default. This value cannot be changed
1968
2167
  * once the API has been created.</p>
1969
2168
  */
1970
2169
  visibility?: GraphQLApiVisibility | string;
1971
2170
  /**
2171
+ * @public
1972
2172
  * <p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API
1973
2173
  * (<code>MERGED</code>).</p>
1974
2174
  */
1975
2175
  apiType?: GraphQLApiType | string;
1976
2176
  /**
2177
+ * @public
1977
2178
  * <p>The Identity and Access Management service role ARN for a merged API. The AppSync
1978
2179
  * service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to
1979
2180
  * prompt the <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes
@@ -1981,10 +2182,12 @@ export interface GraphqlApi {
1981
2182
  */
1982
2183
  mergedApiExecutionRoleArn?: string;
1983
2184
  /**
2185
+ * @public
1984
2186
  * <p>The account owner of the GraphQL API.</p>
1985
2187
  */
1986
2188
  owner?: string;
1987
2189
  /**
2190
+ * @public
1988
2191
  * <p>The owner contact information for an API resource.</p>
1989
2192
  * <p>This field accepts any string input with a length of 0 - 256 characters.</p>
1990
2193
  */
@@ -1995,6 +2198,7 @@ export interface GraphqlApi {
1995
2198
  */
1996
2199
  export interface CreateGraphqlApiResponse {
1997
2200
  /**
2201
+ * @public
1998
2202
  * <p>The <code>GraphqlApi</code>.</p>
1999
2203
  */
2000
2204
  graphqlApi?: GraphqlApi;
@@ -2005,11 +2209,13 @@ export interface CreateGraphqlApiResponse {
2005
2209
  */
2006
2210
  export interface CachingConfig {
2007
2211
  /**
2212
+ * @public
2008
2213
  * <p>The TTL in seconds for a resolver that has caching activated.</p>
2009
2214
  * <p>Valid values are 1–3,600 seconds.</p>
2010
2215
  */
2011
2216
  ttl: number | undefined;
2012
2217
  /**
2218
+ * @public
2013
2219
  * <p>The caching keys for a resolver that has caching activated.</p>
2014
2220
  * <p>Valid values are entries from the <code>$context.arguments</code>,
2015
2221
  * <code>$context.source</code>, and <code>$context.identity</code> maps.</p>
@@ -2034,6 +2240,7 @@ export type ResolverKind = (typeof ResolverKind)[keyof typeof ResolverKind];
2034
2240
  */
2035
2241
  export interface PipelineConfig {
2036
2242
  /**
2243
+ * @public
2037
2244
  * <p>A list of <code>Function</code> objects.</p>
2038
2245
  */
2039
2246
  functions?: string[];
@@ -2043,22 +2250,27 @@ export interface PipelineConfig {
2043
2250
  */
2044
2251
  export interface CreateResolverRequest {
2045
2252
  /**
2253
+ * @public
2046
2254
  * <p>The ID for the GraphQL API for which the resolver is being created.</p>
2047
2255
  */
2048
2256
  apiId: string | undefined;
2049
2257
  /**
2258
+ * @public
2050
2259
  * <p>The name of the <code>Type</code>.</p>
2051
2260
  */
2052
2261
  typeName: string | undefined;
2053
2262
  /**
2263
+ * @public
2054
2264
  * <p>The name of the field to attach the resolver to.</p>
2055
2265
  */
2056
2266
  fieldName: string | undefined;
2057
2267
  /**
2268
+ * @public
2058
2269
  * <p>The name of the data source for which the resolver is being created.</p>
2059
2270
  */
2060
2271
  dataSourceName?: string;
2061
2272
  /**
2273
+ * @public
2062
2274
  * <p>The mapping template to use for requests.</p>
2063
2275
  * <p>A resolver uses a request mapping template to convert a GraphQL expression into a format
2064
2276
  * that a data source can understand. Mapping templates are written in Apache Velocity
@@ -2069,10 +2281,12 @@ export interface CreateResolverRequest {
2069
2281
  */
2070
2282
  requestMappingTemplate?: string;
2071
2283
  /**
2284
+ * @public
2072
2285
  * <p>The mapping template to use for responses from the data source.</p>
2073
2286
  */
2074
2287
  responseMappingTemplate?: string;
2075
2288
  /**
2289
+ * @public
2076
2290
  * <p>The resolver type.</p>
2077
2291
  * <ul>
2078
2292
  * <li>
@@ -2092,27 +2306,33 @@ export interface CreateResolverRequest {
2092
2306
  */
2093
2307
  kind?: ResolverKind | string;
2094
2308
  /**
2309
+ * @public
2095
2310
  * <p>The <code>PipelineConfig</code>.</p>
2096
2311
  */
2097
2312
  pipelineConfig?: PipelineConfig;
2098
2313
  /**
2314
+ * @public
2099
2315
  * <p>The <code>SyncConfig</code> for a resolver attached to a versioned data source.</p>
2100
2316
  */
2101
2317
  syncConfig?: SyncConfig;
2102
2318
  /**
2319
+ * @public
2103
2320
  * <p>The caching configuration for the resolver.</p>
2104
2321
  */
2105
2322
  cachingConfig?: CachingConfig;
2106
2323
  /**
2324
+ * @public
2107
2325
  * <p>The maximum batching size for a resolver.</p>
2108
2326
  */
2109
2327
  maxBatchSize?: number;
2110
2328
  /**
2329
+ * @public
2111
2330
  * <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note
2112
2331
  * that if a runtime is specified, code must also be specified.</p>
2113
2332
  */
2114
2333
  runtime?: AppSyncRuntime;
2115
2334
  /**
2335
+ * @public
2116
2336
  * <p>The <code>resolver</code> code that contains the request and response functions. When
2117
2337
  * code is used, the <code>runtime</code> is required. The <code>runtime</code> value must be
2118
2338
  * <code>APPSYNC_JS</code>.</p>
@@ -2125,30 +2345,37 @@ export interface CreateResolverRequest {
2125
2345
  */
2126
2346
  export interface Resolver {
2127
2347
  /**
2348
+ * @public
2128
2349
  * <p>The resolver type name.</p>
2129
2350
  */
2130
2351
  typeName?: string;
2131
2352
  /**
2353
+ * @public
2132
2354
  * <p>The resolver field name.</p>
2133
2355
  */
2134
2356
  fieldName?: string;
2135
2357
  /**
2358
+ * @public
2136
2359
  * <p>The resolver data source name.</p>
2137
2360
  */
2138
2361
  dataSourceName?: string;
2139
2362
  /**
2363
+ * @public
2140
2364
  * <p>The resolver Amazon Resource Name (ARN).</p>
2141
2365
  */
2142
2366
  resolverArn?: string;
2143
2367
  /**
2368
+ * @public
2144
2369
  * <p>The request mapping template.</p>
2145
2370
  */
2146
2371
  requestMappingTemplate?: string;
2147
2372
  /**
2373
+ * @public
2148
2374
  * <p>The response mapping template.</p>
2149
2375
  */
2150
2376
  responseMappingTemplate?: string;
2151
2377
  /**
2378
+ * @public
2152
2379
  * <p>The resolver type.</p>
2153
2380
  * <ul>
2154
2381
  * <li>
@@ -2168,27 +2395,33 @@ export interface Resolver {
2168
2395
  */
2169
2396
  kind?: ResolverKind | string;
2170
2397
  /**
2398
+ * @public
2171
2399
  * <p>The <code>PipelineConfig</code>.</p>
2172
2400
  */
2173
2401
  pipelineConfig?: PipelineConfig;
2174
2402
  /**
2403
+ * @public
2175
2404
  * <p>The <code>SyncConfig</code> for a resolver attached to a versioned data source.</p>
2176
2405
  */
2177
2406
  syncConfig?: SyncConfig;
2178
2407
  /**
2408
+ * @public
2179
2409
  * <p>The caching configuration for the resolver.</p>
2180
2410
  */
2181
2411
  cachingConfig?: CachingConfig;
2182
2412
  /**
2413
+ * @public
2183
2414
  * <p>The maximum batching size for a resolver.</p>
2184
2415
  */
2185
2416
  maxBatchSize?: number;
2186
2417
  /**
2418
+ * @public
2187
2419
  * <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note
2188
2420
  * that if a runtime is specified, code must also be specified.</p>
2189
2421
  */
2190
2422
  runtime?: AppSyncRuntime;
2191
2423
  /**
2424
+ * @public
2192
2425
  * <p>The <code>resolver</code> code that contains the request and response functions. When
2193
2426
  * code is used, the <code>runtime</code> is required. The <code>runtime</code> value must be
2194
2427
  * <code>APPSYNC_JS</code>.</p>
@@ -2200,6 +2433,7 @@ export interface Resolver {
2200
2433
  */
2201
2434
  export interface CreateResolverResponse {
2202
2435
  /**
2436
+ * @public
2203
2437
  * <p>The <code>Resolver</code> object.</p>
2204
2438
  */
2205
2439
  resolver?: Resolver;
@@ -2221,16 +2455,19 @@ export type TypeDefinitionFormat = (typeof TypeDefinitionFormat)[keyof typeof Ty
2221
2455
  */
2222
2456
  export interface CreateTypeRequest {
2223
2457
  /**
2458
+ * @public
2224
2459
  * <p>The API ID.</p>
2225
2460
  */
2226
2461
  apiId: string | undefined;
2227
2462
  /**
2463
+ * @public
2228
2464
  * <p>The type definition, in GraphQL Schema Definition Language (SDL) format.</p>
2229
2465
  * <p>For more information, see the <a href="http://graphql.org/learn/schema/">GraphQL SDL
2230
2466
  * documentation</a>.</p>
2231
2467
  */
2232
2468
  definition: string | undefined;
2233
2469
  /**
2470
+ * @public
2234
2471
  * <p>The type format: SDL or JSON.</p>
2235
2472
  */
2236
2473
  format: TypeDefinitionFormat | string | undefined;
@@ -2241,22 +2478,27 @@ export interface CreateTypeRequest {
2241
2478
  */
2242
2479
  export interface Type {
2243
2480
  /**
2481
+ * @public
2244
2482
  * <p>The type name.</p>
2245
2483
  */
2246
2484
  name?: string;
2247
2485
  /**
2486
+ * @public
2248
2487
  * <p>The type description.</p>
2249
2488
  */
2250
2489
  description?: string;
2251
2490
  /**
2491
+ * @public
2252
2492
  * <p>The type Amazon Resource Name (ARN).</p>
2253
2493
  */
2254
2494
  arn?: string;
2255
2495
  /**
2496
+ * @public
2256
2497
  * <p>The type definition.</p>
2257
2498
  */
2258
2499
  definition?: string;
2259
2500
  /**
2501
+ * @public
2260
2502
  * <p>The type format: SDL or JSON.</p>
2261
2503
  */
2262
2504
  format?: TypeDefinitionFormat | string;
@@ -2266,6 +2508,7 @@ export interface Type {
2266
2508
  */
2267
2509
  export interface CreateTypeResponse {
2268
2510
  /**
2511
+ * @public
2269
2512
  * <p>The <code>Type</code> object.</p>
2270
2513
  */
2271
2514
  type?: Type;
@@ -2276,6 +2519,7 @@ export interface CreateTypeResponse {
2276
2519
  */
2277
2520
  export interface DeleteApiCacheRequest {
2278
2521
  /**
2522
+ * @public
2279
2523
  * <p>The API ID.</p>
2280
2524
  */
2281
2525
  apiId: string | undefined;
@@ -2291,10 +2535,12 @@ export interface DeleteApiCacheResponse {
2291
2535
  */
2292
2536
  export interface DeleteApiKeyRequest {
2293
2537
  /**
2538
+ * @public
2294
2539
  * <p>The API ID.</p>
2295
2540
  */
2296
2541
  apiId: string | undefined;
2297
2542
  /**
2543
+ * @public
2298
2544
  * <p>The ID for the API key.</p>
2299
2545
  */
2300
2546
  id: string | undefined;
@@ -2309,10 +2555,12 @@ export interface DeleteApiKeyResponse {
2309
2555
  */
2310
2556
  export interface DeleteDataSourceRequest {
2311
2557
  /**
2558
+ * @public
2312
2559
  * <p>The API ID.</p>
2313
2560
  */
2314
2561
  apiId: string | undefined;
2315
2562
  /**
2563
+ * @public
2316
2564
  * <p>The name of the data source.</p>
2317
2565
  */
2318
2566
  name: string | undefined;
@@ -2327,6 +2575,7 @@ export interface DeleteDataSourceResponse {
2327
2575
  */
2328
2576
  export interface DeleteDomainNameRequest {
2329
2577
  /**
2578
+ * @public
2330
2579
  * <p>The domain name.</p>
2331
2580
  */
2332
2581
  domainName: string | undefined;
@@ -2341,10 +2590,12 @@ export interface DeleteDomainNameResponse {
2341
2590
  */
2342
2591
  export interface DeleteFunctionRequest {
2343
2592
  /**
2593
+ * @public
2344
2594
  * <p>The GraphQL API ID.</p>
2345
2595
  */
2346
2596
  apiId: string | undefined;
2347
2597
  /**
2598
+ * @public
2348
2599
  * <p>The <code>Function</code> ID.</p>
2349
2600
  */
2350
2601
  functionId: string | undefined;
@@ -2359,6 +2610,7 @@ export interface DeleteFunctionResponse {
2359
2610
  */
2360
2611
  export interface DeleteGraphqlApiRequest {
2361
2612
  /**
2613
+ * @public
2362
2614
  * <p>The API ID.</p>
2363
2615
  */
2364
2616
  apiId: string | undefined;
@@ -2373,14 +2625,17 @@ export interface DeleteGraphqlApiResponse {
2373
2625
  */
2374
2626
  export interface DeleteResolverRequest {
2375
2627
  /**
2628
+ * @public
2376
2629
  * <p>The API ID.</p>
2377
2630
  */
2378
2631
  apiId: string | undefined;
2379
2632
  /**
2633
+ * @public
2380
2634
  * <p>The name of the resolver type.</p>
2381
2635
  */
2382
2636
  typeName: string | undefined;
2383
2637
  /**
2638
+ * @public
2384
2639
  * <p>The resolver field name.</p>
2385
2640
  */
2386
2641
  fieldName: string | undefined;
@@ -2395,10 +2650,12 @@ export interface DeleteResolverResponse {
2395
2650
  */
2396
2651
  export interface DeleteTypeRequest {
2397
2652
  /**
2653
+ * @public
2398
2654
  * <p>The API ID.</p>
2399
2655
  */
2400
2656
  apiId: string | undefined;
2401
2657
  /**
2658
+ * @public
2402
2659
  * <p>The type name.</p>
2403
2660
  */
2404
2661
  typeName: string | undefined;
@@ -2413,6 +2670,7 @@ export interface DeleteTypeResponse {
2413
2670
  */
2414
2671
  export interface DisassociateApiRequest {
2415
2672
  /**
2673
+ * @public
2416
2674
  * <p>The domain name.</p>
2417
2675
  */
2418
2676
  domainName: string | undefined;
@@ -2427,12 +2685,14 @@ export interface DisassociateApiResponse {
2427
2685
  */
2428
2686
  export interface DisassociateMergedGraphqlApiRequest {
2429
2687
  /**
2688
+ * @public
2430
2689
  * <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source
2431
2690
  * APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs
2432
2691
  * from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.</p>
2433
2692
  */
2434
2693
  sourceApiIdentifier: string | undefined;
2435
2694
  /**
2695
+ * @public
2436
2696
  * <p>The ID generated by the AppSync service for the source API association.</p>
2437
2697
  */
2438
2698
  associationId: string | undefined;
@@ -2442,6 +2702,7 @@ export interface DisassociateMergedGraphqlApiRequest {
2442
2702
  */
2443
2703
  export interface DisassociateMergedGraphqlApiResponse {
2444
2704
  /**
2705
+ * @public
2445
2706
  * <p>The state of the source API association.</p>
2446
2707
  */
2447
2708
  sourceApiAssociationStatus?: SourceApiAssociationStatus | string;
@@ -2451,10 +2712,12 @@ export interface DisassociateMergedGraphqlApiResponse {
2451
2712
  */
2452
2713
  export interface DisassociateSourceGraphqlApiRequest {
2453
2714
  /**
2715
+ * @public
2454
2716
  * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
2455
2717
  */
2456
2718
  mergedApiIdentifier: string | undefined;
2457
2719
  /**
2720
+ * @public
2458
2721
  * <p>The ID generated by the AppSync service for the source API association.</p>
2459
2722
  */
2460
2723
  associationId: string | undefined;
@@ -2464,6 +2727,7 @@ export interface DisassociateSourceGraphqlApiRequest {
2464
2727
  */
2465
2728
  export interface DisassociateSourceGraphqlApiResponse {
2466
2729
  /**
2730
+ * @public
2467
2731
  * <p>The state of the source API association.</p>
2468
2732
  */
2469
2733
  sourceApiAssociationStatus?: SourceApiAssociationStatus | string;
@@ -2473,22 +2737,26 @@ export interface DisassociateSourceGraphqlApiResponse {
2473
2737
  */
2474
2738
  export interface EvaluateCodeRequest {
2475
2739
  /**
2740
+ * @public
2476
2741
  * <p>The runtime to be used when evaluating the code. Currently, only the
2477
2742
  * <code>APPSYNC_JS</code> runtime is supported.</p>
2478
2743
  */
2479
2744
  runtime: AppSyncRuntime | undefined;
2480
2745
  /**
2746
+ * @public
2481
2747
  * <p>The code definition to be evaluated. Note that <code>code</code> and
2482
2748
  * <code>runtime</code> are both required for this action. The <code>runtime</code> value
2483
2749
  * must be <code>APPSYNC_JS</code>.</p>
2484
2750
  */
2485
2751
  code: string | undefined;
2486
2752
  /**
2753
+ * @public
2487
2754
  * <p>The map that holds all of the contextual information for your resolver invocation. A
2488
2755
  * <code>context</code> is required for this action.</p>
2489
2756
  */
2490
2757
  context: string | undefined;
2491
2758
  /**
2759
+ * @public
2492
2760
  * <p>The function within the code to be evaluated. If provided, the valid values are
2493
2761
  * <code>request</code> and <code>response</code>.</p>
2494
2762
  */
@@ -2500,10 +2768,12 @@ export interface EvaluateCodeRequest {
2500
2768
  */
2501
2769
  export interface EvaluateCodeErrorDetail {
2502
2770
  /**
2771
+ * @public
2503
2772
  * <p>The error payload.</p>
2504
2773
  */
2505
2774
  message?: string;
2506
2775
  /**
2776
+ * @public
2507
2777
  * <p>Contains the list of <code>CodeError</code> objects.</p>
2508
2778
  */
2509
2779
  codeErrors?: CodeError[];
@@ -2513,14 +2783,17 @@ export interface EvaluateCodeErrorDetail {
2513
2783
  */
2514
2784
  export interface EvaluateCodeResponse {
2515
2785
  /**
2786
+ * @public
2516
2787
  * <p>The result of the evaluation operation.</p>
2517
2788
  */
2518
2789
  evaluationResult?: string;
2519
2790
  /**
2791
+ * @public
2520
2792
  * <p>Contains the payload of the response error.</p>
2521
2793
  */
2522
2794
  error?: EvaluateCodeErrorDetail;
2523
2795
  /**
2796
+ * @public
2524
2797
  * <p>A list of logs that were generated by calls to <code>util.log.info</code> and
2525
2798
  * <code>util.log.error</code> in the evaluated code.</p>
2526
2799
  */
@@ -2531,11 +2804,13 @@ export interface EvaluateCodeResponse {
2531
2804
  */
2532
2805
  export interface EvaluateMappingTemplateRequest {
2533
2806
  /**
2807
+ * @public
2534
2808
  * <p>The mapping template; this can be a request or response template. A
2535
2809
  * <code>template</code> is required for this action.</p>
2536
2810
  */
2537
2811
  template: string | undefined;
2538
2812
  /**
2813
+ * @public
2539
2814
  * <p>The map that holds all of the contextual information for your resolver invocation. A
2540
2815
  * <code>context</code> is required for this action.</p>
2541
2816
  */
@@ -2548,6 +2823,7 @@ export interface EvaluateMappingTemplateRequest {
2548
2823
  */
2549
2824
  export interface ErrorDetail {
2550
2825
  /**
2826
+ * @public
2551
2827
  * <p>The error payload.</p>
2552
2828
  */
2553
2829
  message?: string;
@@ -2557,14 +2833,17 @@ export interface ErrorDetail {
2557
2833
  */
2558
2834
  export interface EvaluateMappingTemplateResponse {
2559
2835
  /**
2836
+ * @public
2560
2837
  * <p>The mapping template; this can be a request or response template.</p>
2561
2838
  */
2562
2839
  evaluationResult?: string;
2563
2840
  /**
2841
+ * @public
2564
2842
  * <p>The <code>ErrorDetail</code> object.</p>
2565
2843
  */
2566
2844
  error?: ErrorDetail;
2567
2845
  /**
2846
+ * @public
2568
2847
  * <p>A list of logs that were generated by calls to <code>util.log.info</code> and
2569
2848
  * <code>util.log.error</code> in the evaluated code.</p>
2570
2849
  */
@@ -2576,6 +2855,7 @@ export interface EvaluateMappingTemplateResponse {
2576
2855
  */
2577
2856
  export interface FlushApiCacheRequest {
2578
2857
  /**
2858
+ * @public
2579
2859
  * <p>The API ID.</p>
2580
2860
  */
2581
2861
  apiId: string | undefined;
@@ -2591,6 +2871,7 @@ export interface FlushApiCacheResponse {
2591
2871
  */
2592
2872
  export interface GetApiAssociationRequest {
2593
2873
  /**
2874
+ * @public
2594
2875
  * <p>The domain name.</p>
2595
2876
  */
2596
2877
  domainName: string | undefined;
@@ -2600,6 +2881,7 @@ export interface GetApiAssociationRequest {
2600
2881
  */
2601
2882
  export interface GetApiAssociationResponse {
2602
2883
  /**
2884
+ * @public
2603
2885
  * <p>The <code>ApiAssociation</code> object.</p>
2604
2886
  */
2605
2887
  apiAssociation?: ApiAssociation;
@@ -2610,6 +2892,7 @@ export interface GetApiAssociationResponse {
2610
2892
  */
2611
2893
  export interface GetApiCacheRequest {
2612
2894
  /**
2895
+ * @public
2613
2896
  * <p>The API ID.</p>
2614
2897
  */
2615
2898
  apiId: string | undefined;
@@ -2620,6 +2903,7 @@ export interface GetApiCacheRequest {
2620
2903
  */
2621
2904
  export interface GetApiCacheResponse {
2622
2905
  /**
2906
+ * @public
2623
2907
  * <p>The <code>ApiCache</code> object.</p>
2624
2908
  */
2625
2909
  apiCache?: ApiCache;
@@ -2629,10 +2913,12 @@ export interface GetApiCacheResponse {
2629
2913
  */
2630
2914
  export interface GetDataSourceRequest {
2631
2915
  /**
2916
+ * @public
2632
2917
  * <p>The API ID.</p>
2633
2918
  */
2634
2919
  apiId: string | undefined;
2635
2920
  /**
2921
+ * @public
2636
2922
  * <p>The name of the data source.</p>
2637
2923
  */
2638
2924
  name: string | undefined;
@@ -2642,6 +2928,7 @@ export interface GetDataSourceRequest {
2642
2928
  */
2643
2929
  export interface GetDataSourceResponse {
2644
2930
  /**
2931
+ * @public
2645
2932
  * <p>The <code>DataSource</code> object.</p>
2646
2933
  */
2647
2934
  dataSource?: DataSource;
@@ -2651,6 +2938,7 @@ export interface GetDataSourceResponse {
2651
2938
  */
2652
2939
  export interface GetDomainNameRequest {
2653
2940
  /**
2941
+ * @public
2654
2942
  * <p>The domain name.</p>
2655
2943
  */
2656
2944
  domainName: string | undefined;
@@ -2660,6 +2948,7 @@ export interface GetDomainNameRequest {
2660
2948
  */
2661
2949
  export interface GetDomainNameResponse {
2662
2950
  /**
2951
+ * @public
2663
2952
  * <p>The configuration for the <code>DomainName</code>.</p>
2664
2953
  */
2665
2954
  domainNameConfig?: DomainNameConfig;
@@ -2669,10 +2958,12 @@ export interface GetDomainNameResponse {
2669
2958
  */
2670
2959
  export interface GetFunctionRequest {
2671
2960
  /**
2961
+ * @public
2672
2962
  * <p>The GraphQL API ID.</p>
2673
2963
  */
2674
2964
  apiId: string | undefined;
2675
2965
  /**
2966
+ * @public
2676
2967
  * <p>The <code>Function</code> ID.</p>
2677
2968
  */
2678
2969
  functionId: string | undefined;
@@ -2682,6 +2973,7 @@ export interface GetFunctionRequest {
2682
2973
  */
2683
2974
  export interface GetFunctionResponse {
2684
2975
  /**
2976
+ * @public
2685
2977
  * <p>The <code>Function</code> object.</p>
2686
2978
  */
2687
2979
  functionConfiguration?: FunctionConfiguration;
@@ -2691,6 +2983,7 @@ export interface GetFunctionResponse {
2691
2983
  */
2692
2984
  export interface GetGraphqlApiRequest {
2693
2985
  /**
2986
+ * @public
2694
2987
  * <p>The API ID for the GraphQL API.</p>
2695
2988
  */
2696
2989
  apiId: string | undefined;
@@ -2700,6 +2993,7 @@ export interface GetGraphqlApiRequest {
2700
2993
  */
2701
2994
  export interface GetGraphqlApiResponse {
2702
2995
  /**
2996
+ * @public
2703
2997
  * <p>The <code>GraphqlApi</code> object.</p>
2704
2998
  */
2705
2999
  graphqlApi?: GraphqlApi;
@@ -2721,14 +3015,17 @@ export type OutputType = (typeof OutputType)[keyof typeof OutputType];
2721
3015
  */
2722
3016
  export interface GetIntrospectionSchemaRequest {
2723
3017
  /**
3018
+ * @public
2724
3019
  * <p>The API ID.</p>
2725
3020
  */
2726
3021
  apiId: string | undefined;
2727
3022
  /**
3023
+ * @public
2728
3024
  * <p>The schema format: SDL or JSON.</p>
2729
3025
  */
2730
3026
  format: OutputType | string | undefined;
2731
3027
  /**
3028
+ * @public
2732
3029
  * <p>A flag that specifies whether the schema introspection should contain directives.</p>
2733
3030
  */
2734
3031
  includeDirectives?: boolean;
@@ -2738,6 +3035,7 @@ export interface GetIntrospectionSchemaRequest {
2738
3035
  */
2739
3036
  export interface GetIntrospectionSchemaResponse {
2740
3037
  /**
3038
+ * @public
2741
3039
  * <p>The schema, in GraphQL Schema Definition Language (SDL) format.</p>
2742
3040
  * <p>For more information, see the <a href="http://graphql.org/learn/schema/">GraphQL SDL
2743
3041
  * documentation</a>.</p>
@@ -2761,14 +3059,17 @@ export declare class GraphQLSchemaException extends __BaseException {
2761
3059
  */
2762
3060
  export interface GetResolverRequest {
2763
3061
  /**
3062
+ * @public
2764
3063
  * <p>The API ID.</p>
2765
3064
  */
2766
3065
  apiId: string | undefined;
2767
3066
  /**
3067
+ * @public
2768
3068
  * <p>The resolver type name.</p>
2769
3069
  */
2770
3070
  typeName: string | undefined;
2771
3071
  /**
3072
+ * @public
2772
3073
  * <p>The resolver field name.</p>
2773
3074
  */
2774
3075
  fieldName: string | undefined;
@@ -2778,6 +3079,7 @@ export interface GetResolverRequest {
2778
3079
  */
2779
3080
  export interface GetResolverResponse {
2780
3081
  /**
3082
+ * @public
2781
3083
  * <p>The <code>Resolver</code> object.</p>
2782
3084
  */
2783
3085
  resolver?: Resolver;
@@ -2787,6 +3089,7 @@ export interface GetResolverResponse {
2787
3089
  */
2788
3090
  export interface GetSchemaCreationStatusRequest {
2789
3091
  /**
3092
+ * @public
2790
3093
  * <p>The API ID.</p>
2791
3094
  */
2792
3095
  apiId: string | undefined;
@@ -2812,11 +3115,13 @@ export type SchemaStatus = (typeof SchemaStatus)[keyof typeof SchemaStatus];
2812
3115
  */
2813
3116
  export interface GetSchemaCreationStatusResponse {
2814
3117
  /**
3118
+ * @public
2815
3119
  * <p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When
2816
3120
  * the schema is in the ACTIVE state, you can add data.</p>
2817
3121
  */
2818
3122
  status?: SchemaStatus | string;
2819
3123
  /**
3124
+ * @public
2820
3125
  * <p>Detailed information about the status of the schema creation operation.</p>
2821
3126
  */
2822
3127
  details?: string;
@@ -2826,10 +3131,12 @@ export interface GetSchemaCreationStatusResponse {
2826
3131
  */
2827
3132
  export interface GetSourceApiAssociationRequest {
2828
3133
  /**
3134
+ * @public
2829
3135
  * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
2830
3136
  */
2831
3137
  mergedApiIdentifier: string | undefined;
2832
3138
  /**
3139
+ * @public
2833
3140
  * <p>The ID generated by the AppSync service for the source API association.</p>
2834
3141
  */
2835
3142
  associationId: string | undefined;
@@ -2839,6 +3146,7 @@ export interface GetSourceApiAssociationRequest {
2839
3146
  */
2840
3147
  export interface GetSourceApiAssociationResponse {
2841
3148
  /**
3149
+ * @public
2842
3150
  * <p>The <code>SourceApiAssociation</code> object data.</p>
2843
3151
  */
2844
3152
  sourceApiAssociation?: SourceApiAssociation;
@@ -2848,14 +3156,17 @@ export interface GetSourceApiAssociationResponse {
2848
3156
  */
2849
3157
  export interface GetTypeRequest {
2850
3158
  /**
3159
+ * @public
2851
3160
  * <p>The API ID.</p>
2852
3161
  */
2853
3162
  apiId: string | undefined;
2854
3163
  /**
3164
+ * @public
2855
3165
  * <p>The type name.</p>
2856
3166
  */
2857
3167
  typeName: string | undefined;
2858
3168
  /**
3169
+ * @public
2859
3170
  * <p>The type format: SDL or JSON.</p>
2860
3171
  */
2861
3172
  format: TypeDefinitionFormat | string | undefined;
@@ -2865,6 +3176,7 @@ export interface GetTypeRequest {
2865
3176
  */
2866
3177
  export interface GetTypeResponse {
2867
3178
  /**
3179
+ * @public
2868
3180
  * <p>The <code>Type</code> object.</p>
2869
3181
  */
2870
3182
  type?: Type;
@@ -2874,15 +3186,18 @@ export interface GetTypeResponse {
2874
3186
  */
2875
3187
  export interface ListApiKeysRequest {
2876
3188
  /**
3189
+ * @public
2877
3190
  * <p>The API ID.</p>
2878
3191
  */
2879
3192
  apiId: string | undefined;
2880
3193
  /**
3194
+ * @public
2881
3195
  * <p>An identifier that was returned from the previous call to this operation, which you can
2882
3196
  * use to return the next set of items in the list.</p>
2883
3197
  */
2884
3198
  nextToken?: string;
2885
3199
  /**
3200
+ * @public
2886
3201
  * <p>The maximum number of results that you want the request to return.</p>
2887
3202
  */
2888
3203
  maxResults?: number;
@@ -2892,10 +3207,12 @@ export interface ListApiKeysRequest {
2892
3207
  */
2893
3208
  export interface ListApiKeysResponse {
2894
3209
  /**
3210
+ * @public
2895
3211
  * <p>The <code>ApiKey</code> objects.</p>
2896
3212
  */
2897
3213
  apiKeys?: ApiKey[];
2898
3214
  /**
3215
+ * @public
2899
3216
  * <p>An identifier to pass in the next request to this operation to return the next set of
2900
3217
  * items in the list.</p>
2901
3218
  */
@@ -2906,15 +3223,18 @@ export interface ListApiKeysResponse {
2906
3223
  */
2907
3224
  export interface ListDataSourcesRequest {
2908
3225
  /**
3226
+ * @public
2909
3227
  * <p>The API ID.</p>
2910
3228
  */
2911
3229
  apiId: string | undefined;
2912
3230
  /**
3231
+ * @public
2913
3232
  * <p>An identifier that was returned from the previous call to this operation, which you can
2914
3233
  * use to return the next set of items in the list.</p>
2915
3234
  */
2916
3235
  nextToken?: string;
2917
3236
  /**
3237
+ * @public
2918
3238
  * <p>The maximum number of results that you want the request to return.</p>
2919
3239
  */
2920
3240
  maxResults?: number;
@@ -2924,10 +3244,12 @@ export interface ListDataSourcesRequest {
2924
3244
  */
2925
3245
  export interface ListDataSourcesResponse {
2926
3246
  /**
3247
+ * @public
2927
3248
  * <p>The <code>DataSource</code> objects.</p>
2928
3249
  */
2929
3250
  dataSources?: DataSource[];
2930
3251
  /**
3252
+ * @public
2931
3253
  * <p>An identifier to pass in the next request to this operation to return the next set of
2932
3254
  * items in the list.</p>
2933
3255
  */
@@ -2938,11 +3260,13 @@ export interface ListDataSourcesResponse {
2938
3260
  */
2939
3261
  export interface ListDomainNamesRequest {
2940
3262
  /**
3263
+ * @public
2941
3264
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
2942
3265
  * next set of items in the list.</p>
2943
3266
  */
2944
3267
  nextToken?: string;
2945
3268
  /**
3269
+ * @public
2946
3270
  * <p>The maximum number of results that you want the request to return.</p>
2947
3271
  */
2948
3272
  maxResults?: number;
@@ -2952,10 +3276,12 @@ export interface ListDomainNamesRequest {
2952
3276
  */
2953
3277
  export interface ListDomainNamesResponse {
2954
3278
  /**
3279
+ * @public
2955
3280
  * <p>Lists configurations for multiple domain names.</p>
2956
3281
  */
2957
3282
  domainNameConfigs?: DomainNameConfig[];
2958
3283
  /**
3284
+ * @public
2959
3285
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
2960
3286
  * next set of items in the list.</p>
2961
3287
  */
@@ -2966,15 +3292,18 @@ export interface ListDomainNamesResponse {
2966
3292
  */
2967
3293
  export interface ListFunctionsRequest {
2968
3294
  /**
3295
+ * @public
2969
3296
  * <p>The GraphQL API ID.</p>
2970
3297
  */
2971
3298
  apiId: string | undefined;
2972
3299
  /**
3300
+ * @public
2973
3301
  * <p>An identifier that was returned from the previous call to this operation, which you can
2974
3302
  * use to return the next set of items in the list.</p>
2975
3303
  */
2976
3304
  nextToken?: string;
2977
3305
  /**
3306
+ * @public
2978
3307
  * <p>The maximum number of results that you want the request to return.</p>
2979
3308
  */
2980
3309
  maxResults?: number;
@@ -2984,10 +3313,12 @@ export interface ListFunctionsRequest {
2984
3313
  */
2985
3314
  export interface ListFunctionsResponse {
2986
3315
  /**
3316
+ * @public
2987
3317
  * <p>A list of <code>Function</code> objects.</p>
2988
3318
  */
2989
3319
  functions?: FunctionConfiguration[];
2990
3320
  /**
3321
+ * @public
2991
3322
  * <p>An identifier that was returned from the previous call to this operation, which you can
2992
3323
  * use to return the next set of items in the list.</p>
2993
3324
  */
@@ -3010,20 +3341,24 @@ export type Ownership = (typeof Ownership)[keyof typeof Ownership];
3010
3341
  */
3011
3342
  export interface ListGraphqlApisRequest {
3012
3343
  /**
3344
+ * @public
3013
3345
  * <p>An identifier that was returned from the previous call to this operation, which you can
3014
3346
  * use to return the next set of items in the list.</p>
3015
3347
  */
3016
3348
  nextToken?: string;
3017
3349
  /**
3350
+ * @public
3018
3351
  * <p>The maximum number of results that you want the request to return.</p>
3019
3352
  */
3020
3353
  maxResults?: number;
3021
3354
  /**
3355
+ * @public
3022
3356
  * <p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API
3023
3357
  * (<code>MERGED</code>).</p>
3024
3358
  */
3025
3359
  apiType?: GraphQLApiType | string;
3026
3360
  /**
3361
+ * @public
3027
3362
  * <p>The account owner of the GraphQL API.</p>
3028
3363
  */
3029
3364
  owner?: Ownership | string;
@@ -3033,10 +3368,12 @@ export interface ListGraphqlApisRequest {
3033
3368
  */
3034
3369
  export interface ListGraphqlApisResponse {
3035
3370
  /**
3371
+ * @public
3036
3372
  * <p>The <code>GraphqlApi</code> objects.</p>
3037
3373
  */
3038
3374
  graphqlApis?: GraphqlApi[];
3039
3375
  /**
3376
+ * @public
3040
3377
  * <p>An identifier to pass in the next request to this operation to return the next set of
3041
3378
  * items in the list.</p>
3042
3379
  */
@@ -3047,19 +3384,23 @@ export interface ListGraphqlApisResponse {
3047
3384
  */
3048
3385
  export interface ListResolversRequest {
3049
3386
  /**
3387
+ * @public
3050
3388
  * <p>The API ID.</p>
3051
3389
  */
3052
3390
  apiId: string | undefined;
3053
3391
  /**
3392
+ * @public
3054
3393
  * <p>The type name.</p>
3055
3394
  */
3056
3395
  typeName: string | undefined;
3057
3396
  /**
3397
+ * @public
3058
3398
  * <p>An identifier that was returned from the previous call to this operation, which you can
3059
3399
  * use to return the next set of items in the list.</p>
3060
3400
  */
3061
3401
  nextToken?: string;
3062
3402
  /**
3403
+ * @public
3063
3404
  * <p>The maximum number of results that you want the request to return.</p>
3064
3405
  */
3065
3406
  maxResults?: number;
@@ -3069,10 +3410,12 @@ export interface ListResolversRequest {
3069
3410
  */
3070
3411
  export interface ListResolversResponse {
3071
3412
  /**
3413
+ * @public
3072
3414
  * <p>The <code>Resolver</code> objects.</p>
3073
3415
  */
3074
3416
  resolvers?: Resolver[];
3075
3417
  /**
3418
+ * @public
3076
3419
  * <p>An identifier to pass in the next request to this operation to return the next set of
3077
3420
  * items in the list.</p>
3078
3421
  */
@@ -3083,19 +3426,23 @@ export interface ListResolversResponse {
3083
3426
  */
3084
3427
  export interface ListResolversByFunctionRequest {
3085
3428
  /**
3429
+ * @public
3086
3430
  * <p>The API ID.</p>
3087
3431
  */
3088
3432
  apiId: string | undefined;
3089
3433
  /**
3434
+ * @public
3090
3435
  * <p>The function ID.</p>
3091
3436
  */
3092
3437
  functionId: string | undefined;
3093
3438
  /**
3439
+ * @public
3094
3440
  * <p>An identifier that was returned from the previous call to this operation, which you can
3095
3441
  * use to return the next set of items in the list.</p>
3096
3442
  */
3097
3443
  nextToken?: string;
3098
3444
  /**
3445
+ * @public
3099
3446
  * <p>The maximum number of results that you want the request to return.</p>
3100
3447
  */
3101
3448
  maxResults?: number;
@@ -3105,10 +3452,12 @@ export interface ListResolversByFunctionRequest {
3105
3452
  */
3106
3453
  export interface ListResolversByFunctionResponse {
3107
3454
  /**
3455
+ * @public
3108
3456
  * <p>The list of resolvers.</p>
3109
3457
  */
3110
3458
  resolvers?: Resolver[];
3111
3459
  /**
3460
+ * @public
3112
3461
  * <p>An identifier that you can use to return the next set of items in the list.</p>
3113
3462
  */
3114
3463
  nextToken?: string;
@@ -3118,15 +3467,18 @@ export interface ListResolversByFunctionResponse {
3118
3467
  */
3119
3468
  export interface ListSourceApiAssociationsRequest {
3120
3469
  /**
3470
+ * @public
3121
3471
  * <p>The API ID.</p>
3122
3472
  */
3123
3473
  apiId: string | undefined;
3124
3474
  /**
3475
+ * @public
3125
3476
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3126
3477
  * next set of items in the list.</p>
3127
3478
  */
3128
3479
  nextToken?: string;
3129
3480
  /**
3481
+ * @public
3130
3482
  * <p>The maximum number of results that you want the request to return.</p>
3131
3483
  */
3132
3484
  maxResults?: number;
@@ -3137,30 +3489,37 @@ export interface ListSourceApiAssociationsRequest {
3137
3489
  */
3138
3490
  export interface SourceApiAssociationSummary {
3139
3491
  /**
3492
+ * @public
3140
3493
  * <p>The ID generated by the AppSync service for the source API association.</p>
3141
3494
  */
3142
3495
  associationId?: string;
3143
3496
  /**
3497
+ * @public
3144
3498
  * <p>The Amazon Resource Name (ARN) of the source API association.</p>
3145
3499
  */
3146
3500
  associationArn?: string;
3147
3501
  /**
3502
+ * @public
3148
3503
  * <p>The ID of the AppSync source API.</p>
3149
3504
  */
3150
3505
  sourceApiId?: string;
3151
3506
  /**
3507
+ * @public
3152
3508
  * <p>The Amazon Resource Name (ARN) of the AppSync Source API.</p>
3153
3509
  */
3154
3510
  sourceApiArn?: string;
3155
3511
  /**
3512
+ * @public
3156
3513
  * <p>The ID of the AppSync Merged API.</p>
3157
3514
  */
3158
3515
  mergedApiId?: string;
3159
3516
  /**
3517
+ * @public
3160
3518
  * <p>The Amazon Resource Name (ARN) of the AppSync Merged API.</p>
3161
3519
  */
3162
3520
  mergedApiArn?: string;
3163
3521
  /**
3522
+ * @public
3164
3523
  * <p>The description field.</p>
3165
3524
  */
3166
3525
  description?: string;
@@ -3170,10 +3529,12 @@ export interface SourceApiAssociationSummary {
3170
3529
  */
3171
3530
  export interface ListSourceApiAssociationsResponse {
3172
3531
  /**
3532
+ * @public
3173
3533
  * <p>The <code>SourceApiAssociationSummary</code> object data.</p>
3174
3534
  */
3175
3535
  sourceApiAssociationSummaries?: SourceApiAssociationSummary[];
3176
3536
  /**
3537
+ * @public
3177
3538
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3178
3539
  * next set of items in the list.</p>
3179
3540
  */
@@ -3184,6 +3545,7 @@ export interface ListSourceApiAssociationsResponse {
3184
3545
  */
3185
3546
  export interface ListTagsForResourceRequest {
3186
3547
  /**
3548
+ * @public
3187
3549
  * <p>The <code>GraphqlApi</code> Amazon Resource Name (ARN).</p>
3188
3550
  */
3189
3551
  resourceArn: string | undefined;
@@ -3193,6 +3555,7 @@ export interface ListTagsForResourceRequest {
3193
3555
  */
3194
3556
  export interface ListTagsForResourceResponse {
3195
3557
  /**
3558
+ * @public
3196
3559
  * <p>A <code>TagMap</code> object.</p>
3197
3560
  */
3198
3561
  tags?: Record<string, string>;
@@ -3202,19 +3565,23 @@ export interface ListTagsForResourceResponse {
3202
3565
  */
3203
3566
  export interface ListTypesRequest {
3204
3567
  /**
3568
+ * @public
3205
3569
  * <p>The API ID.</p>
3206
3570
  */
3207
3571
  apiId: string | undefined;
3208
3572
  /**
3573
+ * @public
3209
3574
  * <p>The type format: SDL or JSON.</p>
3210
3575
  */
3211
3576
  format: TypeDefinitionFormat | string | undefined;
3212
3577
  /**
3578
+ * @public
3213
3579
  * <p>An identifier that was returned from the previous call to this operation, which you can
3214
3580
  * use to return the next set of items in the list.</p>
3215
3581
  */
3216
3582
  nextToken?: string;
3217
3583
  /**
3584
+ * @public
3218
3585
  * <p>The maximum number of results that you want the request to return.</p>
3219
3586
  */
3220
3587
  maxResults?: number;
@@ -3224,10 +3591,12 @@ export interface ListTypesRequest {
3224
3591
  */
3225
3592
  export interface ListTypesResponse {
3226
3593
  /**
3594
+ * @public
3227
3595
  * <p>The <code>Type</code> objects.</p>
3228
3596
  */
3229
3597
  types?: Type[];
3230
3598
  /**
3599
+ * @public
3231
3600
  * <p>An identifier to pass in the next request to this operation to return the next set of
3232
3601
  * items in the list.</p>
3233
3602
  */
@@ -3238,23 +3607,28 @@ export interface ListTypesResponse {
3238
3607
  */
3239
3608
  export interface ListTypesByAssociationRequest {
3240
3609
  /**
3610
+ * @public
3241
3611
  * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
3242
3612
  */
3243
3613
  mergedApiIdentifier: string | undefined;
3244
3614
  /**
3615
+ * @public
3245
3616
  * <p>The ID generated by the AppSync service for the source API association.</p>
3246
3617
  */
3247
3618
  associationId: string | undefined;
3248
3619
  /**
3620
+ * @public
3249
3621
  * <p>The format type.</p>
3250
3622
  */
3251
3623
  format: TypeDefinitionFormat | string | undefined;
3252
3624
  /**
3625
+ * @public
3253
3626
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3254
3627
  * next set of items in the list.</p>
3255
3628
  */
3256
3629
  nextToken?: string;
3257
3630
  /**
3631
+ * @public
3258
3632
  * <p>The maximum number of results that you want the request to return.</p>
3259
3633
  */
3260
3634
  maxResults?: number;
@@ -3264,10 +3638,12 @@ export interface ListTypesByAssociationRequest {
3264
3638
  */
3265
3639
  export interface ListTypesByAssociationResponse {
3266
3640
  /**
3641
+ * @public
3267
3642
  * <p>The <code>Type</code> objects.</p>
3268
3643
  */
3269
3644
  types?: Type[];
3270
3645
  /**
3646
+ * @public
3271
3647
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3272
3648
  * next set of items in the list.</p>
3273
3649
  */
@@ -3278,10 +3654,12 @@ export interface ListTypesByAssociationResponse {
3278
3654
  */
3279
3655
  export interface StartSchemaCreationRequest {
3280
3656
  /**
3657
+ * @public
3281
3658
  * <p>The API ID.</p>
3282
3659
  */
3283
3660
  apiId: string | undefined;
3284
3661
  /**
3662
+ * @public
3285
3663
  * <p>The schema definition, in GraphQL schema language format.</p>
3286
3664
  */
3287
3665
  definition: Uint8Array | undefined;
@@ -3291,6 +3669,7 @@ export interface StartSchemaCreationRequest {
3291
3669
  */
3292
3670
  export interface StartSchemaCreationResponse {
3293
3671
  /**
3672
+ * @public
3294
3673
  * <p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When
3295
3674
  * the schema is in the ACTIVE state, you can add data.</p>
3296
3675
  */
@@ -3301,10 +3680,12 @@ export interface StartSchemaCreationResponse {
3301
3680
  */
3302
3681
  export interface StartSchemaMergeRequest {
3303
3682
  /**
3683
+ * @public
3304
3684
  * <p>The ID generated by the AppSync service for the source API association.</p>
3305
3685
  */
3306
3686
  associationId: string | undefined;
3307
3687
  /**
3688
+ * @public
3308
3689
  * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
3309
3690
  */
3310
3691
  mergedApiIdentifier: string | undefined;
@@ -3314,6 +3695,7 @@ export interface StartSchemaMergeRequest {
3314
3695
  */
3315
3696
  export interface StartSchemaMergeResponse {
3316
3697
  /**
3698
+ * @public
3317
3699
  * <p>The state of the source API association.</p>
3318
3700
  */
3319
3701
  sourceApiAssociationStatus?: SourceApiAssociationStatus | string;
@@ -3323,10 +3705,12 @@ export interface StartSchemaMergeResponse {
3323
3705
  */
3324
3706
  export interface TagResourceRequest {
3325
3707
  /**
3708
+ * @public
3326
3709
  * <p>The <code>GraphqlApi</code> Amazon Resource Name (ARN).</p>
3327
3710
  */
3328
3711
  resourceArn: string | undefined;
3329
3712
  /**
3713
+ * @public
3330
3714
  * <p>A <code>TagMap</code> object.</p>
3331
3715
  */
3332
3716
  tags: Record<string, string> | undefined;
@@ -3341,10 +3725,12 @@ export interface TagResourceResponse {
3341
3725
  */
3342
3726
  export interface UntagResourceRequest {
3343
3727
  /**
3728
+ * @public
3344
3729
  * <p>The <code>GraphqlApi</code> Amazon Resource Name (ARN).</p>
3345
3730
  */
3346
3731
  resourceArn: string | undefined;
3347
3732
  /**
3733
+ * @public
3348
3734
  * <p>A list of <code>TagKey</code> objects.</p>
3349
3735
  */
3350
3736
  tagKeys: string[] | undefined;
@@ -3360,15 +3746,18 @@ export interface UntagResourceResponse {
3360
3746
  */
3361
3747
  export interface UpdateApiCacheRequest {
3362
3748
  /**
3749
+ * @public
3363
3750
  * <p>The GraphQL API ID.</p>
3364
3751
  */
3365
3752
  apiId: string | undefined;
3366
3753
  /**
3754
+ * @public
3367
3755
  * <p>TTL in seconds for cache entries.</p>
3368
3756
  * <p>Valid values are 1–3,600 seconds.</p>
3369
3757
  */
3370
3758
  ttl: number | undefined;
3371
3759
  /**
3760
+ * @public
3372
3761
  * <p>Caching behavior.</p>
3373
3762
  * <ul>
3374
3763
  * <li>
@@ -3385,6 +3774,7 @@ export interface UpdateApiCacheRequest {
3385
3774
  */
3386
3775
  apiCachingBehavior: ApiCachingBehavior | string | undefined;
3387
3776
  /**
3777
+ * @public
3388
3778
  * <p>The cache instance type. Valid values are </p>
3389
3779
  * <ul>
3390
3780
  * <li>
@@ -3468,6 +3858,7 @@ export interface UpdateApiCacheRequest {
3468
3858
  */
3469
3859
  export interface UpdateApiCacheResponse {
3470
3860
  /**
3861
+ * @public
3471
3862
  * <p>The <code>ApiCache</code> object.</p>
3472
3863
  */
3473
3864
  apiCache?: ApiCache;
@@ -3477,18 +3868,22 @@ export interface UpdateApiCacheResponse {
3477
3868
  */
3478
3869
  export interface UpdateApiKeyRequest {
3479
3870
  /**
3871
+ * @public
3480
3872
  * <p>The ID for the GraphQL API.</p>
3481
3873
  */
3482
3874
  apiId: string | undefined;
3483
3875
  /**
3876
+ * @public
3484
3877
  * <p>The API key ID.</p>
3485
3878
  */
3486
3879
  id: string | undefined;
3487
3880
  /**
3881
+ * @public
3488
3882
  * <p>A description of the purpose of the API key.</p>
3489
3883
  */
3490
3884
  description?: string;
3491
3885
  /**
3886
+ * @public
3492
3887
  * <p>From the update time, the time after which the API key expires. The date is represented
3493
3888
  * as seconds since the epoch. For more information, see .</p>
3494
3889
  */
@@ -3499,6 +3894,7 @@ export interface UpdateApiKeyRequest {
3499
3894
  */
3500
3895
  export interface UpdateApiKeyResponse {
3501
3896
  /**
3897
+ * @public
3502
3898
  * <p>The API key.</p>
3503
3899
  */
3504
3900
  apiKey?: ApiKey;
@@ -3508,52 +3904,64 @@ export interface UpdateApiKeyResponse {
3508
3904
  */
3509
3905
  export interface UpdateDataSourceRequest {
3510
3906
  /**
3907
+ * @public
3511
3908
  * <p>The API ID.</p>
3512
3909
  */
3513
3910
  apiId: string | undefined;
3514
3911
  /**
3912
+ * @public
3515
3913
  * <p>The new name for the data source.</p>
3516
3914
  */
3517
3915
  name: string | undefined;
3518
3916
  /**
3917
+ * @public
3519
3918
  * <p>The new description for the data source.</p>
3520
3919
  */
3521
3920
  description?: string;
3522
3921
  /**
3922
+ * @public
3523
3923
  * <p>The new data source type.</p>
3524
3924
  */
3525
3925
  type: DataSourceType | string | undefined;
3526
3926
  /**
3927
+ * @public
3527
3928
  * <p>The new service role Amazon Resource Name (ARN) for the data source.</p>
3528
3929
  */
3529
3930
  serviceRoleArn?: string;
3530
3931
  /**
3932
+ * @public
3531
3933
  * <p>The new Amazon DynamoDB configuration.</p>
3532
3934
  */
3533
3935
  dynamodbConfig?: DynamodbDataSourceConfig;
3534
3936
  /**
3937
+ * @public
3535
3938
  * <p>The new Lambda configuration.</p>
3536
3939
  */
3537
3940
  lambdaConfig?: LambdaDataSourceConfig;
3538
3941
  /**
3942
+ * @public
3539
3943
  * <p>The new OpenSearch configuration.</p>
3540
3944
  * <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This
3541
3945
  * configuration is deprecated. Instead, use <a>UpdateDataSourceRequest$openSearchServiceConfig</a> to update an OpenSearch data source.</p>
3542
3946
  */
3543
3947
  elasticsearchConfig?: ElasticsearchDataSourceConfig;
3544
3948
  /**
3949
+ * @public
3545
3950
  * <p>The new OpenSearch configuration.</p>
3546
3951
  */
3547
3952
  openSearchServiceConfig?: OpenSearchServiceDataSourceConfig;
3548
3953
  /**
3954
+ * @public
3549
3955
  * <p>The new HTTP endpoint configuration.</p>
3550
3956
  */
3551
3957
  httpConfig?: HttpDataSourceConfig;
3552
3958
  /**
3959
+ * @public
3553
3960
  * <p>The new relational database configuration.</p>
3554
3961
  */
3555
3962
  relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig;
3556
3963
  /**
3964
+ * @public
3557
3965
  * <p>The new Amazon EventBridge settings.</p>
3558
3966
  */
3559
3967
  eventBridgeConfig?: EventBridgeDataSourceConfig;
@@ -3563,6 +3971,7 @@ export interface UpdateDataSourceRequest {
3563
3971
  */
3564
3972
  export interface UpdateDataSourceResponse {
3565
3973
  /**
3974
+ * @public
3566
3975
  * <p>The updated <code>DataSource</code> object.</p>
3567
3976
  */
3568
3977
  dataSource?: DataSource;
@@ -3572,10 +3981,12 @@ export interface UpdateDataSourceResponse {
3572
3981
  */
3573
3982
  export interface UpdateDomainNameRequest {
3574
3983
  /**
3984
+ * @public
3575
3985
  * <p>The domain name.</p>
3576
3986
  */
3577
3987
  domainName: string | undefined;
3578
3988
  /**
3989
+ * @public
3579
3990
  * <p>A description of the <code>DomainName</code>.</p>
3580
3991
  */
3581
3992
  description?: string;
@@ -3585,6 +3996,7 @@ export interface UpdateDomainNameRequest {
3585
3996
  */
3586
3997
  export interface UpdateDomainNameResponse {
3587
3998
  /**
3999
+ * @public
3588
4000
  * <p>The configuration for the <code>DomainName</code>.</p>
3589
4001
  */
3590
4002
  domainNameConfig?: DomainNameConfig;
@@ -3594,57 +4006,69 @@ export interface UpdateDomainNameResponse {
3594
4006
  */
3595
4007
  export interface UpdateFunctionRequest {
3596
4008
  /**
4009
+ * @public
3597
4010
  * <p>The GraphQL API ID.</p>
3598
4011
  */
3599
4012
  apiId: string | undefined;
3600
4013
  /**
4014
+ * @public
3601
4015
  * <p>The <code>Function</code> name.</p>
3602
4016
  */
3603
4017
  name: string | undefined;
3604
4018
  /**
4019
+ * @public
3605
4020
  * <p>The <code>Function</code> description.</p>
3606
4021
  */
3607
4022
  description?: string;
3608
4023
  /**
4024
+ * @public
3609
4025
  * <p>The function ID.</p>
3610
4026
  */
3611
4027
  functionId: string | undefined;
3612
4028
  /**
4029
+ * @public
3613
4030
  * <p>The <code>Function</code>
3614
4031
  * <code>DataSource</code> name.</p>
3615
4032
  */
3616
4033
  dataSourceName: string | undefined;
3617
4034
  /**
4035
+ * @public
3618
4036
  * <p>The <code>Function</code> request mapping template. Functions support only the
3619
4037
  * 2018-05-29 version of the request mapping template.</p>
3620
4038
  */
3621
4039
  requestMappingTemplate?: string;
3622
4040
  /**
4041
+ * @public
3623
4042
  * <p>The <code>Function</code> request mapping template.</p>
3624
4043
  */
3625
4044
  responseMappingTemplate?: string;
3626
4045
  /**
4046
+ * @public
3627
4047
  * <p>The <code>version</code> of the request mapping template. Currently, the supported value
3628
4048
  * is 2018-05-29. Note that when using VTL and mapping templates, the
3629
4049
  * <code>functionVersion</code> is required.</p>
3630
4050
  */
3631
4051
  functionVersion?: string;
3632
4052
  /**
4053
+ * @public
3633
4054
  * <p>Describes a Sync configuration for a resolver.</p>
3634
4055
  * <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
3635
4056
  * resolver is invoked.</p>
3636
4057
  */
3637
4058
  syncConfig?: SyncConfig;
3638
4059
  /**
4060
+ * @public
3639
4061
  * <p>The maximum batching size for a resolver.</p>
3640
4062
  */
3641
4063
  maxBatchSize?: number;
3642
4064
  /**
4065
+ * @public
3643
4066
  * <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note
3644
4067
  * that if a runtime is specified, code must also be specified.</p>
3645
4068
  */
3646
4069
  runtime?: AppSyncRuntime;
3647
4070
  /**
4071
+ * @public
3648
4072
  * <p>The <code>function</code> code that contains the request and response functions. When
3649
4073
  * code is used, the <code>runtime</code> is required. The <code>runtime</code> value must be
3650
4074
  * <code>APPSYNC_JS</code>.</p>
@@ -3656,6 +4080,7 @@ export interface UpdateFunctionRequest {
3656
4080
  */
3657
4081
  export interface UpdateFunctionResponse {
3658
4082
  /**
4083
+ * @public
3659
4084
  * <p>The <code>Function</code> object.</p>
3660
4085
  */
3661
4086
  functionConfiguration?: FunctionConfiguration;
@@ -3665,45 +4090,55 @@ export interface UpdateFunctionResponse {
3665
4090
  */
3666
4091
  export interface UpdateGraphqlApiRequest {
3667
4092
  /**
4093
+ * @public
3668
4094
  * <p>The API ID.</p>
3669
4095
  */
3670
4096
  apiId: string | undefined;
3671
4097
  /**
4098
+ * @public
3672
4099
  * <p>The new name for the <code>GraphqlApi</code> object.</p>
3673
4100
  */
3674
4101
  name: string | undefined;
3675
4102
  /**
4103
+ * @public
3676
4104
  * <p>The Amazon CloudWatch Logs configuration for the <code>GraphqlApi</code> object.</p>
3677
4105
  */
3678
4106
  logConfig?: LogConfig;
3679
4107
  /**
4108
+ * @public
3680
4109
  * <p>The new authentication type for the <code>GraphqlApi</code> object.</p>
3681
4110
  */
3682
4111
  authenticationType?: AuthenticationType | string;
3683
4112
  /**
4113
+ * @public
3684
4114
  * <p>The new Amazon Cognito user pool configuration for the <code>~GraphqlApi</code>
3685
4115
  * object.</p>
3686
4116
  */
3687
4117
  userPoolConfig?: UserPoolConfig;
3688
4118
  /**
4119
+ * @public
3689
4120
  * <p>The OpenID Connect configuration for the <code>GraphqlApi</code> object.</p>
3690
4121
  */
3691
4122
  openIDConnectConfig?: OpenIDConnectConfig;
3692
4123
  /**
4124
+ * @public
3693
4125
  * <p>A list of additional authentication providers for the <code>GraphqlApi</code>
3694
4126
  * API.</p>
3695
4127
  */
3696
4128
  additionalAuthenticationProviders?: AdditionalAuthenticationProvider[];
3697
4129
  /**
4130
+ * @public
3698
4131
  * <p>A flag indicating whether to use X-Ray tracing for the
3699
4132
  * <code>GraphqlApi</code>.</p>
3700
4133
  */
3701
4134
  xrayEnabled?: boolean;
3702
4135
  /**
4136
+ * @public
3703
4137
  * <p>Configuration for Lambda function authorization.</p>
3704
4138
  */
3705
4139
  lambdaAuthorizerConfig?: LambdaAuthorizerConfig;
3706
4140
  /**
4141
+ * @public
3707
4142
  * <p>The Identity and Access Management service role ARN for a merged API. The AppSync
3708
4143
  * service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to
3709
4144
  * prompt the <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes
@@ -3711,6 +4146,7 @@ export interface UpdateGraphqlApiRequest {
3711
4146
  */
3712
4147
  mergedApiExecutionRoleArn?: string;
3713
4148
  /**
4149
+ * @public
3714
4150
  * <p>The owner contact information for an API resource.</p>
3715
4151
  * <p>This field accepts any string input with a length of 0 - 256 characters.</p>
3716
4152
  */
@@ -3721,6 +4157,7 @@ export interface UpdateGraphqlApiRequest {
3721
4157
  */
3722
4158
  export interface UpdateGraphqlApiResponse {
3723
4159
  /**
4160
+ * @public
3724
4161
  * <p>The updated <code>GraphqlApi</code> object.</p>
3725
4162
  */
3726
4163
  graphqlApi?: GraphqlApi;
@@ -3730,22 +4167,27 @@ export interface UpdateGraphqlApiResponse {
3730
4167
  */
3731
4168
  export interface UpdateResolverRequest {
3732
4169
  /**
4170
+ * @public
3733
4171
  * <p>The API ID.</p>
3734
4172
  */
3735
4173
  apiId: string | undefined;
3736
4174
  /**
4175
+ * @public
3737
4176
  * <p>The new type name.</p>
3738
4177
  */
3739
4178
  typeName: string | undefined;
3740
4179
  /**
4180
+ * @public
3741
4181
  * <p>The new field name.</p>
3742
4182
  */
3743
4183
  fieldName: string | undefined;
3744
4184
  /**
4185
+ * @public
3745
4186
  * <p>The new data source name.</p>
3746
4187
  */
3747
4188
  dataSourceName?: string;
3748
4189
  /**
4190
+ * @public
3749
4191
  * <p>The new request mapping template.</p>
3750
4192
  * <p>A resolver uses a request mapping template to convert a GraphQL expression into a format
3751
4193
  * that a data source can understand. Mapping templates are written in Apache Velocity
@@ -3756,10 +4198,12 @@ export interface UpdateResolverRequest {
3756
4198
  */
3757
4199
  requestMappingTemplate?: string;
3758
4200
  /**
4201
+ * @public
3759
4202
  * <p>The new response mapping template.</p>
3760
4203
  */
3761
4204
  responseMappingTemplate?: string;
3762
4205
  /**
4206
+ * @public
3763
4207
  * <p>The resolver type.</p>
3764
4208
  * <ul>
3765
4209
  * <li>
@@ -3779,27 +4223,33 @@ export interface UpdateResolverRequest {
3779
4223
  */
3780
4224
  kind?: ResolverKind | string;
3781
4225
  /**
4226
+ * @public
3782
4227
  * <p>The <code>PipelineConfig</code>.</p>
3783
4228
  */
3784
4229
  pipelineConfig?: PipelineConfig;
3785
4230
  /**
4231
+ * @public
3786
4232
  * <p>The <code>SyncConfig</code> for a resolver attached to a versioned data source.</p>
3787
4233
  */
3788
4234
  syncConfig?: SyncConfig;
3789
4235
  /**
4236
+ * @public
3790
4237
  * <p>The caching configuration for the resolver.</p>
3791
4238
  */
3792
4239
  cachingConfig?: CachingConfig;
3793
4240
  /**
4241
+ * @public
3794
4242
  * <p>The maximum batching size for a resolver.</p>
3795
4243
  */
3796
4244
  maxBatchSize?: number;
3797
4245
  /**
4246
+ * @public
3798
4247
  * <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note
3799
4248
  * that if a runtime is specified, code must also be specified.</p>
3800
4249
  */
3801
4250
  runtime?: AppSyncRuntime;
3802
4251
  /**
4252
+ * @public
3803
4253
  * <p>The <code>resolver</code> code that contains the request and response functions. When
3804
4254
  * code is used, the <code>runtime</code> is required. The <code>runtime</code> value must be
3805
4255
  * <code>APPSYNC_JS</code>.</p>
@@ -3811,6 +4261,7 @@ export interface UpdateResolverRequest {
3811
4261
  */
3812
4262
  export interface UpdateResolverResponse {
3813
4263
  /**
4264
+ * @public
3814
4265
  * <p>The updated <code>Resolver</code> object.</p>
3815
4266
  */
3816
4267
  resolver?: Resolver;
@@ -3820,18 +4271,22 @@ export interface UpdateResolverResponse {
3820
4271
  */
3821
4272
  export interface UpdateSourceApiAssociationRequest {
3822
4273
  /**
4274
+ * @public
3823
4275
  * <p>The ID generated by the AppSync service for the source API association.</p>
3824
4276
  */
3825
4277
  associationId: string | undefined;
3826
4278
  /**
4279
+ * @public
3827
4280
  * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
3828
4281
  */
3829
4282
  mergedApiIdentifier: string | undefined;
3830
4283
  /**
4284
+ * @public
3831
4285
  * <p>The description field.</p>
3832
4286
  */
3833
4287
  description?: string;
3834
4288
  /**
4289
+ * @public
3835
4290
  * <p>The <code>SourceApiAssociationConfig</code> object data.</p>
3836
4291
  */
3837
4292
  sourceApiAssociationConfig?: SourceApiAssociationConfig;
@@ -3841,6 +4296,7 @@ export interface UpdateSourceApiAssociationRequest {
3841
4296
  */
3842
4297
  export interface UpdateSourceApiAssociationResponse {
3843
4298
  /**
4299
+ * @public
3844
4300
  * <p>The <code>SourceApiAssociation</code> object data.</p>
3845
4301
  */
3846
4302
  sourceApiAssociation?: SourceApiAssociation;
@@ -3850,18 +4306,22 @@ export interface UpdateSourceApiAssociationResponse {
3850
4306
  */
3851
4307
  export interface UpdateTypeRequest {
3852
4308
  /**
4309
+ * @public
3853
4310
  * <p>The API ID.</p>
3854
4311
  */
3855
4312
  apiId: string | undefined;
3856
4313
  /**
4314
+ * @public
3857
4315
  * <p>The new type name.</p>
3858
4316
  */
3859
4317
  typeName: string | undefined;
3860
4318
  /**
4319
+ * @public
3861
4320
  * <p>The new definition.</p>
3862
4321
  */
3863
4322
  definition?: string;
3864
4323
  /**
4324
+ * @public
3865
4325
  * <p>The new type format: SDL or JSON.</p>
3866
4326
  */
3867
4327
  format: TypeDefinitionFormat | string | undefined;
@@ -3871,6 +4331,7 @@ export interface UpdateTypeRequest {
3871
4331
  */
3872
4332
  export interface UpdateTypeResponse {
3873
4333
  /**
4334
+ * @public
3874
4335
  * <p>The updated <code>Type</code> object.</p>
3875
4336
  */
3876
4337
  type?: Type;