@aws-sdk/client-schemas 3.378.0 → 3.382.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.
@@ -1,4 +1,7 @@
1
1
  import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface ClientInputEndpointParameters {
3
6
  region?: string | Provider<string>;
4
7
  useDualstackEndpoint?: boolean | Provider<boolean>;
@@ -5,6 +5,7 @@
5
5
  */
6
6
  export * from "./SchemasClient";
7
7
  export * from "./Schemas";
8
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
8
9
  export * from "./commands";
9
10
  export * from "./pagination";
10
11
  export * from "./waiters";
@@ -17,26 +17,32 @@ export type DiscovererState = (typeof DiscovererState)[keyof typeof DiscovererSt
17
17
  */
18
18
  export interface DiscovererSummary {
19
19
  /**
20
+ * @public
20
21
  * <p>The ARN of the discoverer.</p>
21
22
  */
22
23
  DiscovererArn?: string;
23
24
  /**
25
+ * @public
24
26
  * <p>The ID of the discoverer.</p>
25
27
  */
26
28
  DiscovererId?: string;
27
29
  /**
30
+ * @public
28
31
  * <p>The ARN of the event bus.</p>
29
32
  */
30
33
  SourceArn?: string;
31
34
  /**
35
+ * @public
32
36
  * <p>The state of the discoverer.</p>
33
37
  */
34
38
  State?: DiscovererState | string;
35
39
  /**
40
+ * @public
36
41
  * <p>The Status if the discoverer will discover schemas from events sent from another account.</p>
37
42
  */
38
43
  CrossAccount?: boolean;
39
44
  /**
45
+ * @public
40
46
  * <p>Tags associated with the resource.</p>
41
47
  */
42
48
  Tags?: Record<string, string>;
@@ -46,14 +52,17 @@ export interface DiscovererSummary {
46
52
  */
47
53
  export interface RegistrySummary {
48
54
  /**
55
+ * @public
49
56
  * <p>The ARN of the registry.</p>
50
57
  */
51
58
  RegistryArn?: string;
52
59
  /**
60
+ * @public
53
61
  * <p>The name of the registry.</p>
54
62
  */
55
63
  RegistryName?: string;
56
64
  /**
65
+ * @public
57
66
  * <p>Tags associated with the registry.</p>
58
67
  */
59
68
  Tags?: Record<string, string>;
@@ -64,22 +73,27 @@ export interface RegistrySummary {
64
73
  */
65
74
  export interface SchemaSummary {
66
75
  /**
76
+ * @public
67
77
  * <p>The date and time that schema was modified.</p>
68
78
  */
69
79
  LastModified?: Date;
70
80
  /**
81
+ * @public
71
82
  * <p>The ARN of the schema.</p>
72
83
  */
73
84
  SchemaArn?: string;
74
85
  /**
86
+ * @public
75
87
  * <p>The name of the schema.</p>
76
88
  */
77
89
  SchemaName?: string;
78
90
  /**
91
+ * @public
79
92
  * <p>Tags associated with the schema.</p>
80
93
  */
81
94
  Tags?: Record<string, string>;
82
95
  /**
96
+ * @public
83
97
  * <p>The number of versions available for the schema.</p>
84
98
  */
85
99
  VersionCount?: number;
@@ -101,18 +115,22 @@ export type Type = (typeof Type)[keyof typeof Type];
101
115
  */
102
116
  export interface SchemaVersionSummary {
103
117
  /**
118
+ * @public
104
119
  * <p>The ARN of the schema version.</p>
105
120
  */
106
121
  SchemaArn?: string;
107
122
  /**
123
+ * @public
108
124
  * <p>The name of the schema.</p>
109
125
  */
110
126
  SchemaName?: string;
111
127
  /**
128
+ * @public
112
129
  * <p>The version number of the schema.</p>
113
130
  */
114
131
  SchemaVersion?: string;
115
132
  /**
133
+ * @public
116
134
  * <p>The type of schema.</p>
117
135
  */
118
136
  Type?: Type | string;
@@ -122,14 +140,17 @@ export interface SchemaVersionSummary {
122
140
  */
123
141
  export interface SearchSchemaVersionSummary {
124
142
  /**
143
+ * @public
125
144
  * <p>The date the schema version was created.</p>
126
145
  */
127
146
  CreatedDate?: Date;
128
147
  /**
148
+ * @public
129
149
  * <p>The version number of the schema</p>
130
150
  */
131
151
  SchemaVersion?: string;
132
152
  /**
153
+ * @public
133
154
  * <p>The type of schema.</p>
134
155
  */
135
156
  Type?: Type | string;
@@ -139,18 +160,22 @@ export interface SearchSchemaVersionSummary {
139
160
  */
140
161
  export interface SearchSchemaSummary {
141
162
  /**
163
+ * @public
142
164
  * <p>The name of the registry.</p>
143
165
  */
144
166
  RegistryName?: string;
145
167
  /**
168
+ * @public
146
169
  * <p>The ARN of the schema.</p>
147
170
  */
148
171
  SchemaArn?: string;
149
172
  /**
173
+ * @public
150
174
  * <p>The name of the schema.</p>
151
175
  */
152
176
  SchemaName?: string;
153
177
  /**
178
+ * @public
154
179
  * <p>An array of schema version summaries.</p>
155
180
  */
156
181
  SchemaVersions?: SearchSchemaVersionSummary[];
@@ -162,10 +187,12 @@ export declare class BadRequestException extends __BaseException {
162
187
  readonly name: "BadRequestException";
163
188
  readonly $fault: "client";
164
189
  /**
190
+ * @public
165
191
  * <p>The error code.</p>
166
192
  */
167
193
  Code: string | undefined;
168
194
  /**
195
+ * @public
169
196
  * <p>The message string of the error output.</p>
170
197
  */
171
198
  Message: string | undefined;
@@ -194,10 +221,12 @@ export declare class ConflictException extends __BaseException {
194
221
  readonly name: "ConflictException";
195
222
  readonly $fault: "client";
196
223
  /**
224
+ * @public
197
225
  * <p>The error code.</p>
198
226
  */
199
227
  Code: string | undefined;
200
228
  /**
229
+ * @public
201
230
  * <p>The message string of the error output.</p>
202
231
  */
203
232
  Message: string | undefined;
@@ -211,18 +240,22 @@ export declare class ConflictException extends __BaseException {
211
240
  */
212
241
  export interface CreateDiscovererRequest {
213
242
  /**
243
+ * @public
214
244
  * <p>A description for the discoverer.</p>
215
245
  */
216
246
  Description?: string;
217
247
  /**
248
+ * @public
218
249
  * <p>The ARN of the event bus.</p>
219
250
  */
220
251
  SourceArn: string | undefined;
221
252
  /**
253
+ * @public
222
254
  * <p>Support discovery of schemas in events sent to the bus from another account. (default: true).</p>
223
255
  */
224
256
  CrossAccount?: boolean;
225
257
  /**
258
+ * @public
226
259
  * <p>Tags associated with the resource.</p>
227
260
  */
228
261
  Tags?: Record<string, string>;
@@ -232,30 +265,37 @@ export interface CreateDiscovererRequest {
232
265
  */
233
266
  export interface CreateDiscovererResponse {
234
267
  /**
268
+ * @public
235
269
  * <p>The description of the discoverer.</p>
236
270
  */
237
271
  Description?: string;
238
272
  /**
273
+ * @public
239
274
  * <p>The ARN of the discoverer.</p>
240
275
  */
241
276
  DiscovererArn?: string;
242
277
  /**
278
+ * @public
243
279
  * <p>The ID of the discoverer.</p>
244
280
  */
245
281
  DiscovererId?: string;
246
282
  /**
283
+ * @public
247
284
  * <p>The ARN of the event bus.</p>
248
285
  */
249
286
  SourceArn?: string;
250
287
  /**
288
+ * @public
251
289
  * <p>The state of the discoverer.</p>
252
290
  */
253
291
  State?: DiscovererState | string;
254
292
  /**
293
+ * @public
255
294
  * <p>The Status if the discoverer will discover schemas from events sent from another account.</p>
256
295
  */
257
296
  CrossAccount?: boolean;
258
297
  /**
298
+ * @public
259
299
  * <p>Tags associated with the resource.</p>
260
300
  */
261
301
  Tags?: Record<string, string>;
@@ -267,10 +307,12 @@ export declare class ForbiddenException extends __BaseException {
267
307
  readonly name: "ForbiddenException";
268
308
  readonly $fault: "client";
269
309
  /**
310
+ * @public
270
311
  * <p>The error code.</p>
271
312
  */
272
313
  Code: string | undefined;
273
314
  /**
315
+ * @public
274
316
  * <p>The message string of the error output.</p>
275
317
  */
276
318
  Message: string | undefined;
@@ -286,10 +328,12 @@ export declare class InternalServerErrorException extends __BaseException {
286
328
  readonly name: "InternalServerErrorException";
287
329
  readonly $fault: "server";
288
330
  /**
331
+ * @public
289
332
  * <p>The error code.</p>
290
333
  */
291
334
  Code: string | undefined;
292
335
  /**
336
+ * @public
293
337
  * <p>The message string of the error output.</p>
294
338
  */
295
339
  Message: string | undefined;
@@ -305,10 +349,12 @@ export declare class ServiceUnavailableException extends __BaseException {
305
349
  readonly name: "ServiceUnavailableException";
306
350
  readonly $fault: "server";
307
351
  /**
352
+ * @public
308
353
  * <p>The error code.</p>
309
354
  */
310
355
  Code: string | undefined;
311
356
  /**
357
+ * @public
312
358
  * <p>The message string of the error output.</p>
313
359
  */
314
360
  Message: string | undefined;
@@ -324,10 +370,12 @@ export declare class UnauthorizedException extends __BaseException {
324
370
  readonly name: "UnauthorizedException";
325
371
  readonly $fault: "client";
326
372
  /**
373
+ * @public
327
374
  * <p>The error code.</p>
328
375
  */
329
376
  Code: string | undefined;
330
377
  /**
378
+ * @public
331
379
  * <p>The message string of the error output.</p>
332
380
  */
333
381
  Message: string | undefined;
@@ -341,14 +389,17 @@ export declare class UnauthorizedException extends __BaseException {
341
389
  */
342
390
  export interface CreateRegistryRequest {
343
391
  /**
392
+ * @public
344
393
  * <p>A description of the registry to be created.</p>
345
394
  */
346
395
  Description?: string;
347
396
  /**
397
+ * @public
348
398
  * <p>The name of the registry.</p>
349
399
  */
350
400
  RegistryName: string | undefined;
351
401
  /**
402
+ * @public
352
403
  * <p>Tags to associate with the registry.</p>
353
404
  */
354
405
  Tags?: Record<string, string>;
@@ -358,18 +409,22 @@ export interface CreateRegistryRequest {
358
409
  */
359
410
  export interface CreateRegistryResponse {
360
411
  /**
412
+ * @public
361
413
  * <p>The description of the registry.</p>
362
414
  */
363
415
  Description?: string;
364
416
  /**
417
+ * @public
365
418
  * <p>The ARN of the registry.</p>
366
419
  */
367
420
  RegistryArn?: string;
368
421
  /**
422
+ * @public
369
423
  * <p>The name of the registry.</p>
370
424
  */
371
425
  RegistryName?: string;
372
426
  /**
427
+ * @public
373
428
  * <p>Tags associated with the registry.</p>
374
429
  */
375
430
  Tags?: Record<string, string>;
@@ -379,26 +434,32 @@ export interface CreateRegistryResponse {
379
434
  */
380
435
  export interface CreateSchemaRequest {
381
436
  /**
437
+ * @public
382
438
  * <p>The source of the schema definition.</p>
383
439
  */
384
440
  Content: string | undefined;
385
441
  /**
442
+ * @public
386
443
  * <p>A description of the schema.</p>
387
444
  */
388
445
  Description?: string;
389
446
  /**
447
+ * @public
390
448
  * <p>The name of the registry.</p>
391
449
  */
392
450
  RegistryName: string | undefined;
393
451
  /**
452
+ * @public
394
453
  * <p>The name of the schema.</p>
395
454
  */
396
455
  SchemaName: string | undefined;
397
456
  /**
457
+ * @public
398
458
  * <p>Tags associated with the schema.</p>
399
459
  */
400
460
  Tags?: Record<string, string>;
401
461
  /**
462
+ * @public
402
463
  * <p>The type of schema.</p>
403
464
  */
404
465
  Type: Type | string | undefined;
@@ -408,34 +469,42 @@ export interface CreateSchemaRequest {
408
469
  */
409
470
  export interface CreateSchemaResponse {
410
471
  /**
472
+ * @public
411
473
  * <p>The description of the schema.</p>
412
474
  */
413
475
  Description?: string;
414
476
  /**
477
+ * @public
415
478
  * <p>The date and time that schema was modified.</p>
416
479
  */
417
480
  LastModified?: Date;
418
481
  /**
482
+ * @public
419
483
  * <p>The ARN of the schema.</p>
420
484
  */
421
485
  SchemaArn?: string;
422
486
  /**
487
+ * @public
423
488
  * <p>The name of the schema.</p>
424
489
  */
425
490
  SchemaName?: string;
426
491
  /**
492
+ * @public
427
493
  * <p>The version number of the schema</p>
428
494
  */
429
495
  SchemaVersion?: string;
430
496
  /**
497
+ * @public
431
498
  * <p>Key-value pairs associated with a resource.</p>
432
499
  */
433
500
  Tags?: Record<string, string>;
434
501
  /**
502
+ * @public
435
503
  * <p>The type of the schema.</p>
436
504
  */
437
505
  Type?: string;
438
506
  /**
507
+ * @public
439
508
  * <p>The date the schema version was created.</p>
440
509
  */
441
510
  VersionCreatedDate?: Date;
@@ -445,6 +514,7 @@ export interface CreateSchemaResponse {
445
514
  */
446
515
  export interface DeleteDiscovererRequest {
447
516
  /**
517
+ * @public
448
518
  * <p>The ID of the discoverer.</p>
449
519
  */
450
520
  DiscovererId: string | undefined;
@@ -456,10 +526,12 @@ export declare class NotFoundException extends __BaseException {
456
526
  readonly name: "NotFoundException";
457
527
  readonly $fault: "client";
458
528
  /**
529
+ * @public
459
530
  * <p>The error code.</p>
460
531
  */
461
532
  Code: string | undefined;
462
533
  /**
534
+ * @public
463
535
  * <p>The message string of the error output.</p>
464
536
  */
465
537
  Message: string | undefined;
@@ -473,6 +545,7 @@ export declare class NotFoundException extends __BaseException {
473
545
  */
474
546
  export interface DeleteRegistryRequest {
475
547
  /**
548
+ * @public
476
549
  * <p>The name of the registry.</p>
477
550
  */
478
551
  RegistryName: string | undefined;
@@ -482,6 +555,7 @@ export interface DeleteRegistryRequest {
482
555
  */
483
556
  export interface DeleteResourcePolicyRequest {
484
557
  /**
558
+ * @public
485
559
  * <p>The name of the registry.</p>
486
560
  */
487
561
  RegistryName?: string;
@@ -491,10 +565,12 @@ export interface DeleteResourcePolicyRequest {
491
565
  */
492
566
  export interface DeleteSchemaRequest {
493
567
  /**
568
+ * @public
494
569
  * <p>The name of the registry.</p>
495
570
  */
496
571
  RegistryName: string | undefined;
497
572
  /**
573
+ * @public
498
574
  * <p>The name of the schema.</p>
499
575
  */
500
576
  SchemaName: string | undefined;
@@ -504,14 +580,17 @@ export interface DeleteSchemaRequest {
504
580
  */
505
581
  export interface DeleteSchemaVersionRequest {
506
582
  /**
583
+ * @public
507
584
  * <p>The name of the registry.</p>
508
585
  */
509
586
  RegistryName: string | undefined;
510
587
  /**
588
+ * @public
511
589
  * <p>The name of the schema.</p>
512
590
  */
513
591
  SchemaName: string | undefined;
514
592
  /**
593
+ * @public
515
594
  * The version number of the schema
516
595
  */
517
596
  SchemaVersion: string | undefined;
@@ -521,18 +600,22 @@ export interface DeleteSchemaVersionRequest {
521
600
  */
522
601
  export interface DescribeCodeBindingRequest {
523
602
  /**
603
+ * @public
524
604
  * <p>The language of the code binding.</p>
525
605
  */
526
606
  Language: string | undefined;
527
607
  /**
608
+ * @public
528
609
  * <p>The name of the registry.</p>
529
610
  */
530
611
  RegistryName: string | undefined;
531
612
  /**
613
+ * @public
532
614
  * <p>The name of the schema.</p>
533
615
  */
534
616
  SchemaName: string | undefined;
535
617
  /**
618
+ * @public
536
619
  * <p>Specifying this limits the results to only this schema version.</p>
537
620
  */
538
621
  SchemaVersion?: string;
@@ -542,18 +625,22 @@ export interface DescribeCodeBindingRequest {
542
625
  */
543
626
  export interface DescribeCodeBindingResponse {
544
627
  /**
628
+ * @public
545
629
  * <p>The time and date that the code binding was created.</p>
546
630
  */
547
631
  CreationDate?: Date;
548
632
  /**
633
+ * @public
549
634
  * <p>The date and time that code bindings were modified.</p>
550
635
  */
551
636
  LastModified?: Date;
552
637
  /**
638
+ * @public
553
639
  * <p>The version number of the schema.</p>
554
640
  */
555
641
  SchemaVersion?: string;
556
642
  /**
643
+ * @public
557
644
  * <p>The current status of code binding generation.</p>
558
645
  */
559
646
  Status?: CodeGenerationStatus | string;
@@ -565,10 +652,12 @@ export declare class TooManyRequestsException extends __BaseException {
565
652
  readonly name: "TooManyRequestsException";
566
653
  readonly $fault: "client";
567
654
  /**
655
+ * @public
568
656
  * <p>The error code.</p>
569
657
  */
570
658
  Code: string | undefined;
571
659
  /**
660
+ * @public
572
661
  * <p>The message string of the error output.</p>
573
662
  */
574
663
  Message: string | undefined;
@@ -582,6 +671,7 @@ export declare class TooManyRequestsException extends __BaseException {
582
671
  */
583
672
  export interface DescribeDiscovererRequest {
584
673
  /**
674
+ * @public
585
675
  * <p>The ID of the discoverer.</p>
586
676
  */
587
677
  DiscovererId: string | undefined;
@@ -591,30 +681,37 @@ export interface DescribeDiscovererRequest {
591
681
  */
592
682
  export interface DescribeDiscovererResponse {
593
683
  /**
684
+ * @public
594
685
  * <p>The description of the discoverer.</p>
595
686
  */
596
687
  Description?: string;
597
688
  /**
689
+ * @public
598
690
  * <p>The ARN of the discoverer.</p>
599
691
  */
600
692
  DiscovererArn?: string;
601
693
  /**
694
+ * @public
602
695
  * <p>The ID of the discoverer.</p>
603
696
  */
604
697
  DiscovererId?: string;
605
698
  /**
699
+ * @public
606
700
  * <p>The ARN of the event bus.</p>
607
701
  */
608
702
  SourceArn?: string;
609
703
  /**
704
+ * @public
610
705
  * <p>The state of the discoverer.</p>
611
706
  */
612
707
  State?: DiscovererState | string;
613
708
  /**
709
+ * @public
614
710
  * <p>The Status if the discoverer will discover schemas from events sent from another account.</p>
615
711
  */
616
712
  CrossAccount?: boolean;
617
713
  /**
714
+ * @public
618
715
  * <p>Tags associated with the resource.</p>
619
716
  */
620
717
  Tags?: Record<string, string>;
@@ -624,6 +721,7 @@ export interface DescribeDiscovererResponse {
624
721
  */
625
722
  export interface DescribeRegistryRequest {
626
723
  /**
724
+ * @public
627
725
  * <p>The name of the registry.</p>
628
726
  */
629
727
  RegistryName: string | undefined;
@@ -633,18 +731,22 @@ export interface DescribeRegistryRequest {
633
731
  */
634
732
  export interface DescribeRegistryResponse {
635
733
  /**
734
+ * @public
636
735
  * <p>The description of the registry.</p>
637
736
  */
638
737
  Description?: string;
639
738
  /**
739
+ * @public
640
740
  * <p>The ARN of the registry.</p>
641
741
  */
642
742
  RegistryArn?: string;
643
743
  /**
744
+ * @public
644
745
  * <p>The name of the registry.</p>
645
746
  */
646
747
  RegistryName?: string;
647
748
  /**
749
+ * @public
648
750
  * <p>Tags associated with the registry.</p>
649
751
  */
650
752
  Tags?: Record<string, string>;
@@ -654,14 +756,17 @@ export interface DescribeRegistryResponse {
654
756
  */
655
757
  export interface DescribeSchemaRequest {
656
758
  /**
759
+ * @public
657
760
  * <p>The name of the registry.</p>
658
761
  */
659
762
  RegistryName: string | undefined;
660
763
  /**
764
+ * @public
661
765
  * <p>The name of the schema.</p>
662
766
  */
663
767
  SchemaName: string | undefined;
664
768
  /**
769
+ * @public
665
770
  * <p>Specifying this limits the results to only this schema version.</p>
666
771
  */
667
772
  SchemaVersion?: string;
@@ -671,38 +776,47 @@ export interface DescribeSchemaRequest {
671
776
  */
672
777
  export interface DescribeSchemaResponse {
673
778
  /**
779
+ * @public
674
780
  * <p>The source of the schema definition.</p>
675
781
  */
676
782
  Content?: string;
677
783
  /**
784
+ * @public
678
785
  * <p>The description of the schema.</p>
679
786
  */
680
787
  Description?: string;
681
788
  /**
789
+ * @public
682
790
  * <p>The date and time that schema was modified.</p>
683
791
  */
684
792
  LastModified?: Date;
685
793
  /**
794
+ * @public
686
795
  * <p>The ARN of the schema.</p>
687
796
  */
688
797
  SchemaArn?: string;
689
798
  /**
799
+ * @public
690
800
  * <p>The name of the schema.</p>
691
801
  */
692
802
  SchemaName?: string;
693
803
  /**
804
+ * @public
694
805
  * <p>The version number of the schema</p>
695
806
  */
696
807
  SchemaVersion?: string;
697
808
  /**
809
+ * @public
698
810
  * <p>Tags associated with the resource.</p>
699
811
  */
700
812
  Tags?: Record<string, string>;
701
813
  /**
814
+ * @public
702
815
  * <p>The type of the schema.</p>
703
816
  */
704
817
  Type?: string;
705
818
  /**
819
+ * @public
706
820
  * <p>The date the schema version was created.</p>
707
821
  */
708
822
  VersionCreatedDate?: Date;
@@ -712,14 +826,17 @@ export interface DescribeSchemaResponse {
712
826
  */
713
827
  export interface ExportSchemaRequest {
714
828
  /**
829
+ * @public
715
830
  * <p>The name of the registry.</p>
716
831
  */
717
832
  RegistryName: string | undefined;
718
833
  /**
834
+ * @public
719
835
  * <p>The name of the schema.</p>
720
836
  */
721
837
  SchemaName: string | undefined;
722
838
  /**
839
+ * @public
723
840
  * <p>Specifying this limits the results to only this schema version.</p>
724
841
  */
725
842
  SchemaVersion?: string;
@@ -740,18 +857,22 @@ export interface ExportSchemaResponse {
740
857
  */
741
858
  export interface GetCodeBindingSourceRequest {
742
859
  /**
860
+ * @public
743
861
  * <p>The language of the code binding.</p>
744
862
  */
745
863
  Language: string | undefined;
746
864
  /**
865
+ * @public
747
866
  * <p>The name of the registry.</p>
748
867
  */
749
868
  RegistryName: string | undefined;
750
869
  /**
870
+ * @public
751
871
  * <p>The name of the schema.</p>
752
872
  */
753
873
  SchemaName: string | undefined;
754
874
  /**
875
+ * @public
755
876
  * <p>Specifying this limits the results to only this schema version.</p>
756
877
  */
757
878
  SchemaVersion?: string;
@@ -767,10 +888,12 @@ export interface GetCodeBindingSourceResponse {
767
888
  */
768
889
  export interface GetDiscoveredSchemaRequest {
769
890
  /**
891
+ * @public
770
892
  * <p>An array of strings where each string is a JSON event. These are the events that were used to generate the schema. The array includes a single type of event and has a maximum size of 10 events.</p>
771
893
  */
772
894
  Events: string[] | undefined;
773
895
  /**
896
+ * @public
774
897
  * <p>The type of event.</p>
775
898
  */
776
899
  Type: Type | string | undefined;
@@ -780,6 +903,7 @@ export interface GetDiscoveredSchemaRequest {
780
903
  */
781
904
  export interface GetDiscoveredSchemaResponse {
782
905
  /**
906
+ * @public
783
907
  * <p>The source of the schema definition.</p>
784
908
  */
785
909
  Content?: string;
@@ -789,6 +913,7 @@ export interface GetDiscoveredSchemaResponse {
789
913
  */
790
914
  export interface GetResourcePolicyRequest {
791
915
  /**
916
+ * @public
792
917
  * <p>The name of the registry.</p>
793
918
  */
794
919
  RegistryName?: string;
@@ -798,10 +923,12 @@ export interface GetResourcePolicyRequest {
798
923
  */
799
924
  export interface GetResourcePolicyResponse {
800
925
  /**
926
+ * @public
801
927
  * <p>The resource-based policy.</p>
802
928
  */
803
929
  Policy?: __LazyJsonString | string;
804
930
  /**
931
+ * @public
805
932
  * <p>The revision ID.</p>
806
933
  */
807
934
  RevisionId?: string;
@@ -813,10 +940,12 @@ export declare class GoneException extends __BaseException {
813
940
  readonly name: "GoneException";
814
941
  readonly $fault: "client";
815
942
  /**
943
+ * @public
816
944
  * <p>The error code.</p>
817
945
  */
818
946
  Code: string | undefined;
819
947
  /**
948
+ * @public
820
949
  * <p>The message string of the error output.</p>
821
950
  */
822
951
  Message: string | undefined;
@@ -830,15 +959,18 @@ export declare class GoneException extends __BaseException {
830
959
  */
831
960
  export interface ListDiscoverersRequest {
832
961
  /**
962
+ * @public
833
963
  * <p>Specifying this limits the results to only those discoverer IDs that start with the specified prefix.</p>
834
964
  */
835
965
  DiscovererIdPrefix?: string;
836
966
  Limit?: number;
837
967
  /**
968
+ * @public
838
969
  * <p>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</p>
839
970
  */
840
971
  NextToken?: string;
841
972
  /**
973
+ * @public
842
974
  * <p>Specifying this limits the results to only those ARNs that start with the specified prefix.</p>
843
975
  */
844
976
  SourceArnPrefix?: string;
@@ -848,10 +980,12 @@ export interface ListDiscoverersRequest {
848
980
  */
849
981
  export interface ListDiscoverersResponse {
850
982
  /**
983
+ * @public
851
984
  * <p>An array of DiscovererSummary information.</p>
852
985
  */
853
986
  Discoverers?: DiscovererSummary[];
854
987
  /**
988
+ * @public
855
989
  * <p>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</p>
856
990
  */
857
991
  NextToken?: string;
@@ -862,14 +996,17 @@ export interface ListDiscoverersResponse {
862
996
  export interface ListRegistriesRequest {
863
997
  Limit?: number;
864
998
  /**
999
+ * @public
865
1000
  * <p>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</p>
866
1001
  */
867
1002
  NextToken?: string;
868
1003
  /**
1004
+ * @public
869
1005
  * <p>Specifying this limits the results to only those registry names that start with the specified prefix.</p>
870
1006
  */
871
1007
  RegistryNamePrefix?: string;
872
1008
  /**
1009
+ * @public
873
1010
  * <p>Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.</p>
874
1011
  */
875
1012
  Scope?: string;
@@ -879,10 +1016,12 @@ export interface ListRegistriesRequest {
879
1016
  */
880
1017
  export interface ListRegistriesResponse {
881
1018
  /**
1019
+ * @public
882
1020
  * <p>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</p>
883
1021
  */
884
1022
  NextToken?: string;
885
1023
  /**
1024
+ * @public
886
1025
  * <p>An array of registry summaries.</p>
887
1026
  */
888
1027
  Registries?: RegistrySummary[];
@@ -893,14 +1032,17 @@ export interface ListRegistriesResponse {
893
1032
  export interface ListSchemasRequest {
894
1033
  Limit?: number;
895
1034
  /**
1035
+ * @public
896
1036
  * <p>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</p>
897
1037
  */
898
1038
  NextToken?: string;
899
1039
  /**
1040
+ * @public
900
1041
  * <p>The name of the registry.</p>
901
1042
  */
902
1043
  RegistryName: string | undefined;
903
1044
  /**
1045
+ * @public
904
1046
  * <p>Specifying this limits the results to only those schema names that start with the specified prefix.</p>
905
1047
  */
906
1048
  SchemaNamePrefix?: string;
@@ -910,10 +1052,12 @@ export interface ListSchemasRequest {
910
1052
  */
911
1053
  export interface ListSchemasResponse {
912
1054
  /**
1055
+ * @public
913
1056
  * <p>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</p>
914
1057
  */
915
1058
  NextToken?: string;
916
1059
  /**
1060
+ * @public
917
1061
  * <p>An array of schema summaries.</p>
918
1062
  */
919
1063
  Schemas?: SchemaSummary[];
@@ -924,14 +1068,17 @@ export interface ListSchemasResponse {
924
1068
  export interface ListSchemaVersionsRequest {
925
1069
  Limit?: number;
926
1070
  /**
1071
+ * @public
927
1072
  * <p>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</p>
928
1073
  */
929
1074
  NextToken?: string;
930
1075
  /**
1076
+ * @public
931
1077
  * <p>The name of the registry.</p>
932
1078
  */
933
1079
  RegistryName: string | undefined;
934
1080
  /**
1081
+ * @public
935
1082
  * <p>The name of the schema.</p>
936
1083
  */
937
1084
  SchemaName: string | undefined;
@@ -941,10 +1088,12 @@ export interface ListSchemaVersionsRequest {
941
1088
  */
942
1089
  export interface ListSchemaVersionsResponse {
943
1090
  /**
1091
+ * @public
944
1092
  * <p>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</p>
945
1093
  */
946
1094
  NextToken?: string;
947
1095
  /**
1096
+ * @public
948
1097
  * <p>An array of schema version summaries.</p>
949
1098
  */
950
1099
  SchemaVersions?: SchemaVersionSummary[];
@@ -954,6 +1103,7 @@ export interface ListSchemaVersionsResponse {
954
1103
  */
955
1104
  export interface ListTagsForResourceRequest {
956
1105
  /**
1106
+ * @public
957
1107
  * <p>The ARN of the resource.</p>
958
1108
  */
959
1109
  ResourceArn: string | undefined;
@@ -963,6 +1113,7 @@ export interface ListTagsForResourceRequest {
963
1113
  */
964
1114
  export interface ListTagsForResourceResponse {
965
1115
  /**
1116
+ * @public
966
1117
  * <p>Key-value pairs associated with a resource.</p>
967
1118
  */
968
1119
  Tags?: Record<string, string>;
@@ -974,10 +1125,12 @@ export declare class PreconditionFailedException extends __BaseException {
974
1125
  readonly name: "PreconditionFailedException";
975
1126
  readonly $fault: "client";
976
1127
  /**
1128
+ * @public
977
1129
  * <p>The error code.</p>
978
1130
  */
979
1131
  Code: string | undefined;
980
1132
  /**
1133
+ * @public
981
1134
  * <p>The message string of the error output.</p>
982
1135
  */
983
1136
  Message: string | undefined;
@@ -991,18 +1144,22 @@ export declare class PreconditionFailedException extends __BaseException {
991
1144
  */
992
1145
  export interface PutCodeBindingRequest {
993
1146
  /**
1147
+ * @public
994
1148
  * <p>The language of the code binding.</p>
995
1149
  */
996
1150
  Language: string | undefined;
997
1151
  /**
1152
+ * @public
998
1153
  * <p>The name of the registry.</p>
999
1154
  */
1000
1155
  RegistryName: string | undefined;
1001
1156
  /**
1157
+ * @public
1002
1158
  * <p>The name of the schema.</p>
1003
1159
  */
1004
1160
  SchemaName: string | undefined;
1005
1161
  /**
1162
+ * @public
1006
1163
  * <p>Specifying this limits the results to only this schema version.</p>
1007
1164
  */
1008
1165
  SchemaVersion?: string;
@@ -1012,18 +1169,22 @@ export interface PutCodeBindingRequest {
1012
1169
  */
1013
1170
  export interface PutCodeBindingResponse {
1014
1171
  /**
1172
+ * @public
1015
1173
  * <p>The time and date that the code binding was created.</p>
1016
1174
  */
1017
1175
  CreationDate?: Date;
1018
1176
  /**
1177
+ * @public
1019
1178
  * <p>The date and time that code bindings were modified.</p>
1020
1179
  */
1021
1180
  LastModified?: Date;
1022
1181
  /**
1182
+ * @public
1023
1183
  * <p>The version number of the schema.</p>
1024
1184
  */
1025
1185
  SchemaVersion?: string;
1026
1186
  /**
1187
+ * @public
1027
1188
  * <p>The current status of code binding generation.</p>
1028
1189
  */
1029
1190
  Status?: CodeGenerationStatus | string;
@@ -1034,14 +1195,17 @@ export interface PutCodeBindingResponse {
1034
1195
  */
1035
1196
  export interface PutResourcePolicyRequest {
1036
1197
  /**
1198
+ * @public
1037
1199
  * <p>The resource-based policy.</p>
1038
1200
  */
1039
1201
  Policy: __LazyJsonString | string | undefined;
1040
1202
  /**
1203
+ * @public
1041
1204
  * <p>The name of the registry.</p>
1042
1205
  */
1043
1206
  RegistryName?: string;
1044
1207
  /**
1208
+ * @public
1045
1209
  * <p>The revision ID of the policy.</p>
1046
1210
  */
1047
1211
  RevisionId?: string;
@@ -1051,10 +1215,12 @@ export interface PutResourcePolicyRequest {
1051
1215
  */
1052
1216
  export interface PutResourcePolicyResponse {
1053
1217
  /**
1218
+ * @public
1054
1219
  * <p>The resource-based policy.</p>
1055
1220
  */
1056
1221
  Policy?: __LazyJsonString | string;
1057
1222
  /**
1223
+ * @public
1058
1224
  * <p>The revision ID of the policy.</p>
1059
1225
  */
1060
1226
  RevisionId?: string;
@@ -1064,15 +1230,18 @@ export interface PutResourcePolicyResponse {
1064
1230
  */
1065
1231
  export interface SearchSchemasRequest {
1066
1232
  /**
1233
+ * @public
1067
1234
  * <p>Specifying this limits the results to only schemas that include the provided keywords.</p>
1068
1235
  */
1069
1236
  Keywords: string | undefined;
1070
1237
  Limit?: number;
1071
1238
  /**
1239
+ * @public
1072
1240
  * <p>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</p>
1073
1241
  */
1074
1242
  NextToken?: string;
1075
1243
  /**
1244
+ * @public
1076
1245
  * <p>The name of the registry.</p>
1077
1246
  */
1078
1247
  RegistryName: string | undefined;
@@ -1082,10 +1251,12 @@ export interface SearchSchemasRequest {
1082
1251
  */
1083
1252
  export interface SearchSchemasResponse {
1084
1253
  /**
1254
+ * @public
1085
1255
  * <p>The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.</p>
1086
1256
  */
1087
1257
  NextToken?: string;
1088
1258
  /**
1259
+ * @public
1089
1260
  * <p>An array of SearchSchemaSummary information.</p>
1090
1261
  */
1091
1262
  Schemas?: SearchSchemaSummary[];
@@ -1095,6 +1266,7 @@ export interface SearchSchemasResponse {
1095
1266
  */
1096
1267
  export interface StartDiscovererRequest {
1097
1268
  /**
1269
+ * @public
1098
1270
  * <p>The ID of the discoverer.</p>
1099
1271
  */
1100
1272
  DiscovererId: string | undefined;
@@ -1104,10 +1276,12 @@ export interface StartDiscovererRequest {
1104
1276
  */
1105
1277
  export interface StartDiscovererResponse {
1106
1278
  /**
1279
+ * @public
1107
1280
  * <p>The ID of the discoverer.</p>
1108
1281
  */
1109
1282
  DiscovererId?: string;
1110
1283
  /**
1284
+ * @public
1111
1285
  * <p>The state of the discoverer.</p>
1112
1286
  */
1113
1287
  State?: DiscovererState | string;
@@ -1117,6 +1291,7 @@ export interface StartDiscovererResponse {
1117
1291
  */
1118
1292
  export interface StopDiscovererRequest {
1119
1293
  /**
1294
+ * @public
1120
1295
  * <p>The ID of the discoverer.</p>
1121
1296
  */
1122
1297
  DiscovererId: string | undefined;
@@ -1126,10 +1301,12 @@ export interface StopDiscovererRequest {
1126
1301
  */
1127
1302
  export interface StopDiscovererResponse {
1128
1303
  /**
1304
+ * @public
1129
1305
  * <p>The ID of the discoverer.</p>
1130
1306
  */
1131
1307
  DiscovererId?: string;
1132
1308
  /**
1309
+ * @public
1133
1310
  * <p>The state of the discoverer.</p>
1134
1311
  */
1135
1312
  State?: DiscovererState | string;
@@ -1140,10 +1317,12 @@ export interface StopDiscovererResponse {
1140
1317
  */
1141
1318
  export interface TagResourceRequest {
1142
1319
  /**
1320
+ * @public
1143
1321
  * <p>The ARN of the resource.</p>
1144
1322
  */
1145
1323
  ResourceArn: string | undefined;
1146
1324
  /**
1325
+ * @public
1147
1326
  * <p>Tags associated with the resource.</p>
1148
1327
  */
1149
1328
  Tags: Record<string, string> | undefined;
@@ -1153,10 +1332,12 @@ export interface TagResourceRequest {
1153
1332
  */
1154
1333
  export interface UntagResourceRequest {
1155
1334
  /**
1335
+ * @public
1156
1336
  * <p>The ARN of the resource.</p>
1157
1337
  */
1158
1338
  ResourceArn: string | undefined;
1159
1339
  /**
1340
+ * @public
1160
1341
  * <p>Keys of key-value pairs.</p>
1161
1342
  */
1162
1343
  TagKeys: string[] | undefined;
@@ -1166,14 +1347,17 @@ export interface UntagResourceRequest {
1166
1347
  */
1167
1348
  export interface UpdateDiscovererRequest {
1168
1349
  /**
1350
+ * @public
1169
1351
  * <p>The description of the discoverer to update.</p>
1170
1352
  */
1171
1353
  Description?: string;
1172
1354
  /**
1355
+ * @public
1173
1356
  * <p>The ID of the discoverer.</p>
1174
1357
  */
1175
1358
  DiscovererId: string | undefined;
1176
1359
  /**
1360
+ * @public
1177
1361
  * <p>Support discovery of schemas in events sent to the bus from another account. (default: true)</p>
1178
1362
  */
1179
1363
  CrossAccount?: boolean;
@@ -1183,30 +1367,37 @@ export interface UpdateDiscovererRequest {
1183
1367
  */
1184
1368
  export interface UpdateDiscovererResponse {
1185
1369
  /**
1370
+ * @public
1186
1371
  * <p>The description of the discoverer.</p>
1187
1372
  */
1188
1373
  Description?: string;
1189
1374
  /**
1375
+ * @public
1190
1376
  * <p>The ARN of the discoverer.</p>
1191
1377
  */
1192
1378
  DiscovererArn?: string;
1193
1379
  /**
1380
+ * @public
1194
1381
  * <p>The ID of the discoverer.</p>
1195
1382
  */
1196
1383
  DiscovererId?: string;
1197
1384
  /**
1385
+ * @public
1198
1386
  * <p>The ARN of the event bus.</p>
1199
1387
  */
1200
1388
  SourceArn?: string;
1201
1389
  /**
1390
+ * @public
1202
1391
  * <p>The state of the discoverer.</p>
1203
1392
  */
1204
1393
  State?: DiscovererState | string;
1205
1394
  /**
1395
+ * @public
1206
1396
  * <p>The Status if the discoverer will discover schemas from events sent from another account.</p>
1207
1397
  */
1208
1398
  CrossAccount?: boolean;
1209
1399
  /**
1400
+ * @public
1210
1401
  * <p>Tags associated with the resource.</p>
1211
1402
  */
1212
1403
  Tags?: Record<string, string>;
@@ -1217,10 +1408,12 @@ export interface UpdateDiscovererResponse {
1217
1408
  */
1218
1409
  export interface UpdateRegistryRequest {
1219
1410
  /**
1411
+ * @public
1220
1412
  * <p>The description of the registry to update.</p>
1221
1413
  */
1222
1414
  Description?: string;
1223
1415
  /**
1416
+ * @public
1224
1417
  * <p>The name of the registry.</p>
1225
1418
  */
1226
1419
  RegistryName: string | undefined;
@@ -1230,18 +1423,22 @@ export interface UpdateRegistryRequest {
1230
1423
  */
1231
1424
  export interface UpdateRegistryResponse {
1232
1425
  /**
1426
+ * @public
1233
1427
  * <p>The description of the registry.</p>
1234
1428
  */
1235
1429
  Description?: string;
1236
1430
  /**
1431
+ * @public
1237
1432
  * <p>The ARN of the registry.</p>
1238
1433
  */
1239
1434
  RegistryArn?: string;
1240
1435
  /**
1436
+ * @public
1241
1437
  * <p>The name of the registry.</p>
1242
1438
  */
1243
1439
  RegistryName?: string;
1244
1440
  /**
1441
+ * @public
1245
1442
  * <p>Tags associated with the registry.</p>
1246
1443
  */
1247
1444
  Tags?: Record<string, string>;
@@ -1251,26 +1448,32 @@ export interface UpdateRegistryResponse {
1251
1448
  */
1252
1449
  export interface UpdateSchemaRequest {
1253
1450
  /**
1451
+ * @public
1254
1452
  * <p>The ID of the client token.</p>
1255
1453
  */
1256
1454
  ClientTokenId?: string;
1257
1455
  /**
1456
+ * @public
1258
1457
  * <p>The source of the schema definition.</p>
1259
1458
  */
1260
1459
  Content?: string;
1261
1460
  /**
1461
+ * @public
1262
1462
  * <p>The description of the schema.</p>
1263
1463
  */
1264
1464
  Description?: string;
1265
1465
  /**
1466
+ * @public
1266
1467
  * <p>The name of the registry.</p>
1267
1468
  */
1268
1469
  RegistryName: string | undefined;
1269
1470
  /**
1471
+ * @public
1270
1472
  * <p>The name of the schema.</p>
1271
1473
  */
1272
1474
  SchemaName: string | undefined;
1273
1475
  /**
1476
+ * @public
1274
1477
  * <p>The schema type for the events schema.</p>
1275
1478
  */
1276
1479
  Type?: Type | string;
@@ -1280,34 +1483,42 @@ export interface UpdateSchemaRequest {
1280
1483
  */
1281
1484
  export interface UpdateSchemaResponse {
1282
1485
  /**
1486
+ * @public
1283
1487
  * <p>The description of the schema.</p>
1284
1488
  */
1285
1489
  Description?: string;
1286
1490
  /**
1491
+ * @public
1287
1492
  * <p>The date and time that schema was modified.</p>
1288
1493
  */
1289
1494
  LastModified?: Date;
1290
1495
  /**
1496
+ * @public
1291
1497
  * <p>The ARN of the schema.</p>
1292
1498
  */
1293
1499
  SchemaArn?: string;
1294
1500
  /**
1501
+ * @public
1295
1502
  * <p>The name of the schema.</p>
1296
1503
  */
1297
1504
  SchemaName?: string;
1298
1505
  /**
1506
+ * @public
1299
1507
  * <p>The version number of the schema</p>
1300
1508
  */
1301
1509
  SchemaVersion?: string;
1302
1510
  /**
1511
+ * @public
1303
1512
  * <p>Key-value pairs associated with a resource.</p>
1304
1513
  */
1305
1514
  Tags?: Record<string, string>;
1306
1515
  /**
1516
+ * @public
1307
1517
  * <p>The type of the schema.</p>
1308
1518
  */
1309
1519
  Type?: string;
1310
1520
  /**
1521
+ * @public
1311
1522
  * <p>The date the schema version was created.</p>
1312
1523
  */
1313
1524
  VersionCreatedDate?: Date;
@@ -1,5 +1,6 @@
1
1
  export * from "./SchemasClient";
2
2
  export * from "./Schemas";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./pagination";
5
6
  export * from "./waiters";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-schemas",
3
3
  "description": "AWS SDK for JavaScript Schemas Client for Node.js, Browser and React Native",
4
- "version": "3.378.0",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.378.0",
25
- "@aws-sdk/credential-provider-node": "3.378.0",
26
- "@aws-sdk/middleware-host-header": "3.378.0",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
+ "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
- "@aws-sdk/middleware-signing": "3.378.0",
30
- "@aws-sdk/middleware-user-agent": "3.378.0",
29
+ "@aws-sdk/middleware-signing": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",