@aws-sdk/client-cognito-sync 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>;
@@ -17,6 +17,7 @@
17
17
  */
18
18
  export * from "./CognitoSyncClient";
19
19
  export * from "./CognitoSync";
20
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
20
21
  export * from "./commands";
21
22
  export * from "./models";
22
23
  export { CognitoSyncServiceException } from "./models/CognitoSyncServiceException";
@@ -18,6 +18,7 @@ export declare class AlreadyStreamedException extends __BaseException {
18
18
  */
19
19
  export interface BulkPublishRequest {
20
20
  /**
21
+ * @public
21
22
  * A name-spaced GUID (for example,
22
23
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
23
24
  * unique within a region.
@@ -30,6 +31,7 @@ export interface BulkPublishRequest {
30
31
  */
31
32
  export interface BulkPublishResponse {
32
33
  /**
34
+ * @public
33
35
  * A name-spaced GUID (for example,
34
36
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
35
37
  * unique within a region.
@@ -107,18 +109,21 @@ export declare class ResourceNotFoundException extends __BaseException {
107
109
  */
108
110
  export interface DeleteDatasetRequest {
109
111
  /**
112
+ * @public
110
113
  * A name-spaced GUID (for example,
111
114
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
112
115
  * unique within a region.
113
116
  */
114
117
  IdentityPoolId: string | undefined;
115
118
  /**
119
+ * @public
116
120
  * A name-spaced GUID (for example,
117
121
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
118
122
  * unique within a region.
119
123
  */
120
124
  IdentityId: string | undefined;
121
125
  /**
126
+ * @public
122
127
  * A string of up to 128 characters.
123
128
  * Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'
124
129
  * (dot).
@@ -135,37 +140,44 @@ export interface DeleteDatasetRequest {
135
140
  */
136
141
  export interface Dataset {
137
142
  /**
143
+ * @public
138
144
  * A name-spaced GUID (for example,
139
145
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
140
146
  * unique within a region.
141
147
  */
142
148
  IdentityId?: string;
143
149
  /**
150
+ * @public
144
151
  * A string of up to 128 characters. Allowed characters
145
152
  * are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
146
153
  */
147
154
  DatasetName?: string;
148
155
  /**
156
+ * @public
149
157
  * Date on which the dataset was
150
158
  * created.
151
159
  */
152
160
  CreationDate?: Date;
153
161
  /**
162
+ * @public
154
163
  * Date when the dataset was last
155
164
  * modified.
156
165
  */
157
166
  LastModifiedDate?: Date;
158
167
  /**
168
+ * @public
159
169
  * The device that made the last change to this
160
170
  * dataset.
161
171
  */
162
172
  LastModifiedBy?: string;
163
173
  /**
174
+ * @public
164
175
  * Total size in bytes of the records in this
165
176
  * dataset.
166
177
  */
167
178
  DataStorage?: number;
168
179
  /**
180
+ * @public
169
181
  * Number of records in this dataset.
170
182
  */
171
183
  NumRecords?: number;
@@ -177,6 +189,7 @@ export interface Dataset {
177
189
  */
178
190
  export interface DeleteDatasetResponse {
179
191
  /**
192
+ * @public
180
193
  * A collection of data for an identity pool.
181
194
  * An identity pool can have multiple datasets. A dataset is per identity and can be general or
182
195
  * associated with a particular entity in an application (like a saved game). Datasets are
@@ -218,18 +231,21 @@ export declare class TooManyRequestsException extends __BaseException {
218
231
  */
219
232
  export interface DescribeDatasetRequest {
220
233
  /**
234
+ * @public
221
235
  * A name-spaced GUID (for example,
222
236
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
223
237
  * unique within a region.
224
238
  */
225
239
  IdentityPoolId: string | undefined;
226
240
  /**
241
+ * @public
227
242
  * A name-spaced GUID (for example,
228
243
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
229
244
  * unique within a region.
230
245
  */
231
246
  IdentityId: string | undefined;
232
247
  /**
248
+ * @public
233
249
  * A string of up to 128 characters.
234
250
  * Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'
235
251
  * (dot).
@@ -243,6 +259,7 @@ export interface DescribeDatasetRequest {
243
259
  */
244
260
  export interface DescribeDatasetResponse {
245
261
  /**
262
+ * @public
246
263
  * Meta data for a collection of data for an
247
264
  * identity. An identity can have multiple datasets. A dataset can be general or associated with
248
265
  * a particular entity in an application (like a saved game). Datasets are automatically created
@@ -258,6 +275,7 @@ export interface DescribeDatasetResponse {
258
275
  */
259
276
  export interface DescribeIdentityPoolUsageRequest {
260
277
  /**
278
+ * @public
261
279
  * A name-spaced GUID (for
262
280
  * example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
263
281
  * generation is unique within a region.
@@ -271,22 +289,26 @@ export interface DescribeIdentityPoolUsageRequest {
271
289
  */
272
290
  export interface IdentityPoolUsage {
273
291
  /**
292
+ * @public
274
293
  * A name-spaced GUID (for example,
275
294
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
276
295
  * unique within a region.
277
296
  */
278
297
  IdentityPoolId?: string;
279
298
  /**
299
+ * @public
280
300
  * Number of sync sessions for the
281
301
  * identity pool.
282
302
  */
283
303
  SyncSessionsCount?: number;
284
304
  /**
305
+ * @public
285
306
  * Data storage information for the identity
286
307
  * pool.
287
308
  */
288
309
  DataStorage?: number;
289
310
  /**
311
+ * @public
290
312
  * Date on which the identity pool was
291
313
  * last modified.
292
314
  */
@@ -299,6 +321,7 @@ export interface IdentityPoolUsage {
299
321
  */
300
322
  export interface DescribeIdentityPoolUsageResponse {
301
323
  /**
324
+ * @public
302
325
  * Information about the
303
326
  * usage of the identity pool.
304
327
  */
@@ -311,12 +334,14 @@ export interface DescribeIdentityPoolUsageResponse {
311
334
  */
312
335
  export interface DescribeIdentityUsageRequest {
313
336
  /**
337
+ * @public
314
338
  * A name-spaced GUID (for
315
339
  * example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
316
340
  * generation is unique within a region.
317
341
  */
318
342
  IdentityPoolId: string | undefined;
319
343
  /**
344
+ * @public
320
345
  * A name-spaced GUID (for example,
321
346
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
322
347
  * unique within a region.
@@ -329,28 +354,33 @@ export interface DescribeIdentityUsageRequest {
329
354
  */
330
355
  export interface IdentityUsage {
331
356
  /**
357
+ * @public
332
358
  * A name-spaced GUID (for example,
333
359
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
334
360
  * unique within a region.
335
361
  */
336
362
  IdentityId?: string;
337
363
  /**
364
+ * @public
338
365
  * A name-spaced GUID (for example,
339
366
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
340
367
  * unique within a region.
341
368
  */
342
369
  IdentityPoolId?: string;
343
370
  /**
371
+ * @public
344
372
  * Date on which the identity was last
345
373
  * modified.
346
374
  */
347
375
  LastModifiedDate?: Date;
348
376
  /**
377
+ * @public
349
378
  * Number of datasets for the
350
379
  * identity.
351
380
  */
352
381
  DatasetCount?: number;
353
382
  /**
383
+ * @public
354
384
  * Total data storage for this
355
385
  * identity.
356
386
  */
@@ -363,6 +393,7 @@ export interface IdentityUsage {
363
393
  */
364
394
  export interface DescribeIdentityUsageResponse {
365
395
  /**
396
+ * @public
366
397
  * Usage information for the
367
398
  * identity.
368
399
  */
@@ -374,6 +405,7 @@ export interface DescribeIdentityUsageResponse {
374
405
  */
375
406
  export interface GetBulkPublishDetailsRequest {
376
407
  /**
408
+ * @public
377
409
  * A name-spaced GUID (for example,
378
410
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
379
411
  * unique within a region.
@@ -400,20 +432,24 @@ export type BulkPublishStatus = (typeof BulkPublishStatus)[keyof typeof BulkPubl
400
432
  */
401
433
  export interface GetBulkPublishDetailsResponse {
402
434
  /**
435
+ * @public
403
436
  * A name-spaced GUID (for example,
404
437
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
405
438
  * unique within a region.
406
439
  */
407
440
  IdentityPoolId?: string;
408
441
  /**
442
+ * @public
409
443
  * The date/time at which the last bulk publish was initiated.
410
444
  */
411
445
  BulkPublishStartTime?: Date;
412
446
  /**
447
+ * @public
413
448
  * If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.
414
449
  */
415
450
  BulkPublishCompleteTime?: Date;
416
451
  /**
452
+ * @public
417
453
  * Status of the last bulk publish operation, valid values are:
418
454
  * <p>NOT_STARTED - No bulk publish has been requested for this identity pool</p>
419
455
  * <p>IN_PROGRESS - Data is being published to the configured stream</p>
@@ -422,6 +458,7 @@ export interface GetBulkPublishDetailsResponse {
422
458
  */
423
459
  BulkPublishStatus?: BulkPublishStatus | string;
424
460
  /**
461
+ * @public
425
462
  * If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.
426
463
  */
427
464
  FailureMessage?: string;
@@ -432,6 +469,7 @@ export interface GetBulkPublishDetailsResponse {
432
469
  */
433
470
  export interface GetCognitoEventsRequest {
434
471
  /**
472
+ * @public
435
473
  * <p>The Cognito Identity Pool ID for the request</p>
436
474
  */
437
475
  IdentityPoolId: string | undefined;
@@ -442,6 +480,7 @@ export interface GetCognitoEventsRequest {
442
480
  */
443
481
  export interface GetCognitoEventsResponse {
444
482
  /**
483
+ * @public
445
484
  * <p>The Cognito Events returned from the GetCognitoEvents request</p>
446
485
  */
447
486
  Events?: Record<string, string>;
@@ -452,6 +491,7 @@ export interface GetCognitoEventsResponse {
452
491
  */
453
492
  export interface GetIdentityPoolConfigurationRequest {
454
493
  /**
494
+ * @public
455
495
  * <p>A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by
456
496
  * Amazon Cognito. This is the ID of the pool for which to return a configuration.</p>
457
497
  */
@@ -467,14 +507,17 @@ export type StreamingStatus = "DISABLED" | "ENABLED";
467
507
  */
468
508
  export interface CognitoStreams {
469
509
  /**
510
+ * @public
470
511
  * The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.
471
512
  */
472
513
  StreamName?: string;
473
514
  /**
515
+ * @public
474
516
  * The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.
475
517
  */
476
518
  RoleArn?: string;
477
519
  /**
520
+ * @public
478
521
  * Status of the Cognito streams. Valid values are:
479
522
  * <p>ENABLED - Streaming of updates to identity pool is enabled.</p>
480
523
  * <p>DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.</p>
@@ -487,10 +530,12 @@ export interface CognitoStreams {
487
530
  */
488
531
  export interface PushSync {
489
532
  /**
533
+ * @public
490
534
  * <p>List of SNS platform application ARNs that could be used by clients.</p>
491
535
  */
492
536
  ApplicationArns?: string[];
493
537
  /**
538
+ * @public
494
539
  * <p>A role configured to allow Cognito to call SNS on behalf of the developer.</p>
495
540
  */
496
541
  RoleArn?: string;
@@ -501,15 +546,18 @@ export interface PushSync {
501
546
  */
502
547
  export interface GetIdentityPoolConfigurationResponse {
503
548
  /**
549
+ * @public
504
550
  * <p>A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by
505
551
  * Amazon Cognito.</p>
506
552
  */
507
553
  IdentityPoolId?: string;
508
554
  /**
555
+ * @public
509
556
  * <p>Options to apply to this identity pool for push synchronization.</p>
510
557
  */
511
558
  PushSync?: PushSync;
512
559
  /**
560
+ * @public
513
561
  * Options to apply to this identity pool for Amazon Cognito streams.
514
562
  */
515
563
  CognitoStreams?: CognitoStreams;
@@ -521,23 +569,27 @@ export interface GetIdentityPoolConfigurationResponse {
521
569
  */
522
570
  export interface ListDatasetsRequest {
523
571
  /**
572
+ * @public
524
573
  * A name-spaced GUID (for example,
525
574
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
526
575
  * unique within a region.
527
576
  */
528
577
  IdentityPoolId: string | undefined;
529
578
  /**
579
+ * @public
530
580
  * A name-spaced GUID (for example,
531
581
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
532
582
  * unique within a region.
533
583
  */
534
584
  IdentityId: string | undefined;
535
585
  /**
586
+ * @public
536
587
  * A pagination token for obtaining the next
537
588
  * page of results.
538
589
  */
539
590
  NextToken?: string;
540
591
  /**
592
+ * @public
541
593
  * The maximum number of results to be
542
594
  * returned.
543
595
  */
@@ -550,14 +602,17 @@ export interface ListDatasetsRequest {
550
602
  */
551
603
  export interface ListDatasetsResponse {
552
604
  /**
605
+ * @public
553
606
  * A set of datasets.
554
607
  */
555
608
  Datasets?: Dataset[];
556
609
  /**
610
+ * @public
557
611
  * Number of datasets returned.
558
612
  */
559
613
  Count?: number;
560
614
  /**
615
+ * @public
561
616
  * A pagination token for obtaining the next
562
617
  * page of results.
563
618
  */
@@ -570,11 +625,13 @@ export interface ListDatasetsResponse {
570
625
  */
571
626
  export interface ListIdentityPoolUsageRequest {
572
627
  /**
628
+ * @public
573
629
  * A pagination token for obtaining
574
630
  * the next page of results.
575
631
  */
576
632
  NextToken?: string;
577
633
  /**
634
+ * @public
578
635
  * The maximum number of results to
579
636
  * be returned.
580
637
  */
@@ -587,21 +644,25 @@ export interface ListIdentityPoolUsageRequest {
587
644
  */
588
645
  export interface ListIdentityPoolUsageResponse {
589
646
  /**
647
+ * @public
590
648
  * Usage information for
591
649
  * the identity pools.
592
650
  */
593
651
  IdentityPoolUsages?: IdentityPoolUsage[];
594
652
  /**
653
+ * @public
595
654
  * The maximum number of results to
596
655
  * be returned.
597
656
  */
598
657
  MaxResults?: number;
599
658
  /**
659
+ * @public
600
660
  * Total number of identities for the
601
661
  * identity pool.
602
662
  */
603
663
  Count?: number;
604
664
  /**
665
+ * @public
605
666
  * A pagination token for obtaining
606
667
  * the next page of results.
607
668
  */
@@ -613,38 +674,45 @@ export interface ListIdentityPoolUsageResponse {
613
674
  */
614
675
  export interface ListRecordsRequest {
615
676
  /**
677
+ * @public
616
678
  * A name-spaced GUID (for example,
617
679
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
618
680
  * unique within a region.
619
681
  */
620
682
  IdentityPoolId: string | undefined;
621
683
  /**
684
+ * @public
622
685
  * A name-spaced GUID (for example,
623
686
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
624
687
  * unique within a region.
625
688
  */
626
689
  IdentityId: string | undefined;
627
690
  /**
691
+ * @public
628
692
  * A string of up to 128 characters. Allowed
629
693
  * characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
630
694
  */
631
695
  DatasetName: string | undefined;
632
696
  /**
697
+ * @public
633
698
  * The last server sync count for this
634
699
  * record.
635
700
  */
636
701
  LastSyncCount?: number;
637
702
  /**
703
+ * @public
638
704
  * A pagination token for obtaining the next
639
705
  * page of results.
640
706
  */
641
707
  NextToken?: string;
642
708
  /**
709
+ * @public
643
710
  * The maximum number of results to be
644
711
  * returned.
645
712
  */
646
713
  MaxResults?: number;
647
714
  /**
715
+ * @public
648
716
  * A token containing a session ID,
649
717
  * identity ID, and expiration.
650
718
  */
@@ -656,28 +724,34 @@ export interface ListRecordsRequest {
656
724
  */
657
725
  export interface _Record {
658
726
  /**
727
+ * @public
659
728
  * The key for the record.
660
729
  */
661
730
  Key?: string;
662
731
  /**
732
+ * @public
663
733
  * The value for the record.
664
734
  */
665
735
  Value?: string;
666
736
  /**
737
+ * @public
667
738
  * The server sync count for this record.
668
739
  */
669
740
  SyncCount?: number;
670
741
  /**
742
+ * @public
671
743
  * The date on which the record was last
672
744
  * modified.
673
745
  */
674
746
  LastModifiedDate?: Date;
675
747
  /**
748
+ * @public
676
749
  * The user/device that made the last change to this
677
750
  * record.
678
751
  */
679
752
  LastModifiedBy?: string;
680
753
  /**
754
+ * @public
681
755
  * The last modified date of the client
682
756
  * device.
683
757
  */
@@ -690,44 +764,53 @@ export interface _Record {
690
764
  */
691
765
  export interface ListRecordsResponse {
692
766
  /**
767
+ * @public
693
768
  * A list of all records.
694
769
  */
695
770
  Records?: _Record[];
696
771
  /**
772
+ * @public
697
773
  * A pagination token for obtaining the next
698
774
  * page of results.
699
775
  */
700
776
  NextToken?: string;
701
777
  /**
778
+ * @public
702
779
  * Total number of records.
703
780
  */
704
781
  Count?: number;
705
782
  /**
783
+ * @public
706
784
  * Server sync count for this
707
785
  * dataset.
708
786
  */
709
787
  DatasetSyncCount?: number;
710
788
  /**
789
+ * @public
711
790
  * The user/device that made the last
712
791
  * change to this record.
713
792
  */
714
793
  LastModifiedBy?: string;
715
794
  /**
795
+ * @public
716
796
  * Names of merged
717
797
  * datasets.
718
798
  */
719
799
  MergedDatasetNames?: string[];
720
800
  /**
801
+ * @public
721
802
  * Indicates whether the dataset
722
803
  * exists.
723
804
  */
724
805
  DatasetExists?: boolean;
725
806
  /**
807
+ * @public
726
808
  * A boolean value
727
809
  * specifying whether to delete the dataset locally.
728
810
  */
729
811
  DatasetDeletedAfterRequestedSyncCount?: boolean;
730
812
  /**
813
+ * @public
731
814
  * A token containing a session ID,
732
815
  * identity ID, and expiration.
733
816
  */
@@ -754,19 +837,23 @@ export type Platform = "ADM" | "APNS" | "APNS_SANDBOX" | "GCM";
754
837
  */
755
838
  export interface RegisterDeviceRequest {
756
839
  /**
840
+ * @public
757
841
  * <p>A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by
758
842
  * Amazon Cognito. Here, the ID of the pool that the identity belongs to.</p>
759
843
  */
760
844
  IdentityPoolId: string | undefined;
761
845
  /**
846
+ * @public
762
847
  * <p>The unique ID for this identity.</p>
763
848
  */
764
849
  IdentityId: string | undefined;
765
850
  /**
851
+ * @public
766
852
  * <p>The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).</p>
767
853
  */
768
854
  Platform: Platform | string | undefined;
769
855
  /**
856
+ * @public
770
857
  * <p>The push token.</p>
771
858
  */
772
859
  Token: string | undefined;
@@ -777,6 +864,7 @@ export interface RegisterDeviceRequest {
777
864
  */
778
865
  export interface RegisterDeviceResponse {
779
866
  /**
867
+ * @public
780
868
  * <p>The unique ID generated for this device by Cognito.</p>
781
869
  */
782
870
  DeviceId?: string;
@@ -787,10 +875,12 @@ export interface RegisterDeviceResponse {
787
875
  */
788
876
  export interface SetCognitoEventsRequest {
789
877
  /**
878
+ * @public
790
879
  * <p>The Cognito Identity Pool to use when configuring Cognito Events</p>
791
880
  */
792
881
  IdentityPoolId: string | undefined;
793
882
  /**
883
+ * @public
794
884
  * <p>The events to configure</p>
795
885
  */
796
886
  Events: Record<string, string> | undefined;
@@ -813,15 +903,18 @@ export declare class ConcurrentModificationException extends __BaseException {
813
903
  */
814
904
  export interface SetIdentityPoolConfigurationRequest {
815
905
  /**
906
+ * @public
816
907
  * <p>A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by
817
908
  * Amazon Cognito. This is the ID of the pool to modify.</p>
818
909
  */
819
910
  IdentityPoolId: string | undefined;
820
911
  /**
912
+ * @public
821
913
  * <p>Options to apply to this identity pool for push synchronization.</p>
822
914
  */
823
915
  PushSync?: PushSync;
824
916
  /**
917
+ * @public
825
918
  * Options to apply to this identity pool for Amazon Cognito streams.
826
919
  */
827
920
  CognitoStreams?: CognitoStreams;
@@ -832,15 +925,18 @@ export interface SetIdentityPoolConfigurationRequest {
832
925
  */
833
926
  export interface SetIdentityPoolConfigurationResponse {
834
927
  /**
928
+ * @public
835
929
  * <p>A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by
836
930
  * Amazon Cognito.</p>
837
931
  */
838
932
  IdentityPoolId?: string;
839
933
  /**
934
+ * @public
840
935
  * <p>Options to apply to this identity pool for push synchronization.</p>
841
936
  */
842
937
  PushSync?: PushSync;
843
938
  /**
939
+ * @public
844
940
  * Options to apply to this identity pool for Amazon Cognito streams.
845
941
  */
846
942
  CognitoStreams?: CognitoStreams;
@@ -851,19 +947,23 @@ export interface SetIdentityPoolConfigurationResponse {
851
947
  */
852
948
  export interface SubscribeToDatasetRequest {
853
949
  /**
950
+ * @public
854
951
  * <p>A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by
855
952
  * Amazon Cognito. The ID of the pool to which the identity belongs.</p>
856
953
  */
857
954
  IdentityPoolId: string | undefined;
858
955
  /**
956
+ * @public
859
957
  * <p>Unique ID for this identity.</p>
860
958
  */
861
959
  IdentityId: string | undefined;
862
960
  /**
961
+ * @public
863
962
  * <p>The name of the dataset to subcribe to.</p>
864
963
  */
865
964
  DatasetName: string | undefined;
866
965
  /**
966
+ * @public
867
967
  * <p>The unique ID generated for this device by Cognito.</p>
868
968
  */
869
969
  DeviceId: string | undefined;
@@ -880,19 +980,23 @@ export interface SubscribeToDatasetResponse {
880
980
  */
881
981
  export interface UnsubscribeFromDatasetRequest {
882
982
  /**
983
+ * @public
883
984
  * <p>A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by
884
985
  * Amazon Cognito. The ID of the pool to which this identity belongs.</p>
885
986
  */
886
987
  IdentityPoolId: string | undefined;
887
988
  /**
989
+ * @public
888
990
  * <p>Unique ID for this identity.</p>
889
991
  */
890
992
  IdentityId: string | undefined;
891
993
  /**
994
+ * @public
892
995
  * <p>The name of the dataset from which to unsubcribe.</p>
893
996
  */
894
997
  DatasetName: string | undefined;
895
998
  /**
999
+ * @public
896
1000
  * <p>The unique ID generated for this device by Cognito.</p>
897
1001
  */
898
1002
  DeviceId: string | undefined;
@@ -950,24 +1054,29 @@ export type Operation = "remove" | "replace";
950
1054
  */
951
1055
  export interface RecordPatch {
952
1056
  /**
1057
+ * @public
953
1058
  * An operation, either replace or remove.
954
1059
  */
955
1060
  Op: Operation | string | undefined;
956
1061
  /**
1062
+ * @public
957
1063
  * The key associated with the record patch.
958
1064
  */
959
1065
  Key: string | undefined;
960
1066
  /**
1067
+ * @public
961
1068
  * The value associated with the record
962
1069
  * patch.
963
1070
  */
964
1071
  Value?: string;
965
1072
  /**
1073
+ * @public
966
1074
  * Last known server sync count for this record. Set
967
1075
  * to 0 if unknown.
968
1076
  */
969
1077
  SyncCount: number | undefined;
970
1078
  /**
1079
+ * @public
971
1080
  * The last modified date of the client
972
1081
  * device.
973
1082
  */
@@ -980,38 +1089,45 @@ export interface RecordPatch {
980
1089
  */
981
1090
  export interface UpdateRecordsRequest {
982
1091
  /**
1092
+ * @public
983
1093
  * A name-spaced GUID (for example,
984
1094
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
985
1095
  * unique within a region.
986
1096
  */
987
1097
  IdentityPoolId: string | undefined;
988
1098
  /**
1099
+ * @public
989
1100
  * A name-spaced GUID (for example,
990
1101
  * us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is
991
1102
  * unique within a region.
992
1103
  */
993
1104
  IdentityId: string | undefined;
994
1105
  /**
1106
+ * @public
995
1107
  * A string of up to 128 characters.
996
1108
  * Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'
997
1109
  * (dot).
998
1110
  */
999
1111
  DatasetName: string | undefined;
1000
1112
  /**
1113
+ * @public
1001
1114
  * <p>The unique ID generated for this device by Cognito.</p>
1002
1115
  */
1003
1116
  DeviceId?: string;
1004
1117
  /**
1118
+ * @public
1005
1119
  * A list of patch
1006
1120
  * operations.
1007
1121
  */
1008
1122
  RecordPatches?: RecordPatch[];
1009
1123
  /**
1124
+ * @public
1010
1125
  * The SyncSessionToken returned by a
1011
1126
  * previous call to ListRecords for this dataset and identity.
1012
1127
  */
1013
1128
  SyncSessionToken: string | undefined;
1014
1129
  /**
1130
+ * @public
1015
1131
  * Intended to supply a device ID that
1016
1132
  * will populate the lastModifiedBy field referenced in other methods. The
1017
1133
  * ClientContext field is not yet implemented.
@@ -1025,6 +1141,7 @@ export interface UpdateRecordsRequest {
1025
1141
  */
1026
1142
  export interface UpdateRecordsResponse {
1027
1143
  /**
1144
+ * @public
1028
1145
  * A list of records that have been
1029
1146
  * updated.
1030
1147
  */
@@ -37,6 +37,9 @@ export declare const getRuntimeConfig: (config: CognitoSyncClientConfig) => {
37
37
  signingEscapePath?: boolean | undefined;
38
38
  systemClockOffset?: number | undefined;
39
39
  signingRegion?: string | undefined;
40
+ /**
41
+ * @internal
42
+ */
40
43
  signerConstructor?: (new (options: import("@smithy/signature-v4").SignatureV4Init & import("@smithy/signature-v4").SignatureV4CryptoInit) => import("@smithy/types").RequestSigner) | undefined;
41
44
  customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
42
45
  };
@@ -1,5 +1,6 @@
1
1
  export * from "./CognitoSyncClient";
2
2
  export * from "./CognitoSync";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./models";
5
6
  export { CognitoSyncServiceException } from "./models/CognitoSyncServiceException";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cognito-sync",
3
3
  "description": "AWS SDK for JavaScript Cognito Sync 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",