@aws-sdk/client-cognito-identity 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.
@@ -18,15 +18,18 @@ export type AmbiguousRoleResolutionType = (typeof AmbiguousRoleResolutionType)[k
18
18
  */
19
19
  export interface CognitoIdentityProvider {
20
20
  /**
21
+ * @public
21
22
  * <p>The provider name for an Amazon Cognito user pool. For example,
22
23
  * <code>cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789</code>.</p>
23
24
  */
24
25
  ProviderName?: string;
25
26
  /**
27
+ * @public
26
28
  * <p>The client ID for the Amazon Cognito user pool.</p>
27
29
  */
28
30
  ClientId?: string;
29
31
  /**
32
+ * @public
30
33
  * <p>TRUE if server-side token validation is enabled for the identity provider’s
31
34
  * token.</p>
32
35
  * <p>Once you set <code>ServerSideTokenCheck</code> to TRUE for an identity pool, that
@@ -44,23 +47,28 @@ export interface CognitoIdentityProvider {
44
47
  */
45
48
  export interface CreateIdentityPoolInput {
46
49
  /**
50
+ * @public
47
51
  * <p>A string that you provide.</p>
48
52
  */
49
53
  IdentityPoolName: string | undefined;
50
54
  /**
55
+ * @public
51
56
  * <p>TRUE if the identity pool supports unauthenticated logins.</p>
52
57
  */
53
58
  AllowUnauthenticatedIdentities: boolean | undefined;
54
59
  /**
60
+ * @public
55
61
  * <p>Enables or disables the Basic (Classic) authentication flow. For more information, see
56
62
  * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Identity Pools (Federated Identities) Authentication Flow</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
57
63
  */
58
64
  AllowClassicFlow?: boolean;
59
65
  /**
66
+ * @public
60
67
  * <p>Optional key:value pairs mapping provider names to provider app IDs.</p>
61
68
  */
62
69
  SupportedLoginProviders?: Record<string, string>;
63
70
  /**
71
+ * @public
64
72
  * <p>The "domain" by which Cognito will refer to your users. This name acts as a
65
73
  * placeholder that allows your backend and the Cognito service to communicate about the
66
74
  * developer provider. For the <code>DeveloperProviderName</code>, you can use letters as well
@@ -71,19 +79,23 @@ export interface CreateIdentityPoolInput {
71
79
  */
72
80
  DeveloperProviderName?: string;
73
81
  /**
82
+ * @public
74
83
  * <p>The Amazon Resource Names (ARN) of the OpenID Connect providers.</p>
75
84
  */
76
85
  OpenIdConnectProviderARNs?: string[];
77
86
  /**
87
+ * @public
78
88
  * <p>An array of Amazon Cognito user pools and their client IDs.</p>
79
89
  */
80
90
  CognitoIdentityProviders?: CognitoIdentityProvider[];
81
91
  /**
92
+ * @public
82
93
  * <p>An array of Amazon Resource Names (ARNs) of the SAML provider for your identity
83
94
  * pool.</p>
84
95
  */
85
96
  SamlProviderARNs?: string[];
86
97
  /**
98
+ * @public
87
99
  * <p>Tags to assign to the identity pool. A tag is a label that you can apply to identity
88
100
  * pools to categorize and manage them in different ways, such as by purpose, owner,
89
101
  * environment, or other criteria.</p>
@@ -96,44 +108,54 @@ export interface CreateIdentityPoolInput {
96
108
  */
97
109
  export interface IdentityPool {
98
110
  /**
111
+ * @public
99
112
  * <p>An identity pool ID in the format REGION:GUID.</p>
100
113
  */
101
114
  IdentityPoolId: string | undefined;
102
115
  /**
116
+ * @public
103
117
  * <p>A string that you provide.</p>
104
118
  */
105
119
  IdentityPoolName: string | undefined;
106
120
  /**
121
+ * @public
107
122
  * <p>TRUE if the identity pool supports unauthenticated logins.</p>
108
123
  */
109
124
  AllowUnauthenticatedIdentities: boolean | undefined;
110
125
  /**
126
+ * @public
111
127
  * <p>Enables or disables the Basic (Classic) authentication flow. For more information, see
112
128
  * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Identity Pools (Federated Identities) Authentication Flow</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
113
129
  */
114
130
  AllowClassicFlow?: boolean;
115
131
  /**
132
+ * @public
116
133
  * <p>Optional key:value pairs mapping provider names to provider app IDs.</p>
117
134
  */
118
135
  SupportedLoginProviders?: Record<string, string>;
119
136
  /**
137
+ * @public
120
138
  * <p>The "domain" by which Cognito will refer to your users.</p>
121
139
  */
122
140
  DeveloperProviderName?: string;
123
141
  /**
142
+ * @public
124
143
  * <p>The ARNs of the OpenID Connect providers.</p>
125
144
  */
126
145
  OpenIdConnectProviderARNs?: string[];
127
146
  /**
147
+ * @public
128
148
  * <p>A list representing an Amazon Cognito user pool and its client ID.</p>
129
149
  */
130
150
  CognitoIdentityProviders?: CognitoIdentityProvider[];
131
151
  /**
152
+ * @public
132
153
  * <p>An array of Amazon Resource Names (ARNs) of the SAML provider for your identity
133
154
  * pool.</p>
134
155
  */
135
156
  SamlProviderARNs?: string[];
136
157
  /**
158
+ * @public
137
159
  * <p>The tags that are assigned to the identity pool. A tag is a label that you can apply to
138
160
  * identity pools to categorize and manage them in different ways, such as by purpose, owner,
139
161
  * environment, or other criteria.</p>
@@ -219,6 +241,7 @@ export declare class TooManyRequestsException extends __BaseException {
219
241
  */
220
242
  export interface DeleteIdentitiesInput {
221
243
  /**
244
+ * @public
222
245
  * <p>A list of 1-60 identities that you want to delete.</p>
223
246
  */
224
247
  IdentityIdsToDelete: string[] | undefined;
@@ -242,10 +265,12 @@ export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
242
265
  */
243
266
  export interface UnprocessedIdentityId {
244
267
  /**
268
+ * @public
245
269
  * <p>A unique identifier in the format REGION:GUID.</p>
246
270
  */
247
271
  IdentityId?: string;
248
272
  /**
273
+ * @public
249
274
  * <p>The error code indicating the type of error that occurred.</p>
250
275
  */
251
276
  ErrorCode?: ErrorCode | string;
@@ -257,6 +282,7 @@ export interface UnprocessedIdentityId {
257
282
  */
258
283
  export interface DeleteIdentitiesResponse {
259
284
  /**
285
+ * @public
260
286
  * <p>An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and
261
287
  * IdentityId.</p>
262
288
  */
@@ -268,6 +294,7 @@ export interface DeleteIdentitiesResponse {
268
294
  */
269
295
  export interface DeleteIdentityPoolInput {
270
296
  /**
297
+ * @public
271
298
  * <p>An identity pool ID in the format REGION:GUID.</p>
272
299
  */
273
300
  IdentityPoolId: string | undefined;
@@ -291,6 +318,7 @@ export declare class ResourceNotFoundException extends __BaseException {
291
318
  */
292
319
  export interface DescribeIdentityInput {
293
320
  /**
321
+ * @public
294
322
  * <p>A unique identifier in the format REGION:GUID.</p>
295
323
  */
296
324
  IdentityId: string | undefined;
@@ -301,18 +329,22 @@ export interface DescribeIdentityInput {
301
329
  */
302
330
  export interface IdentityDescription {
303
331
  /**
332
+ * @public
304
333
  * <p>A unique identifier in the format REGION:GUID.</p>
305
334
  */
306
335
  IdentityId?: string;
307
336
  /**
337
+ * @public
308
338
  * <p>The provider names.</p>
309
339
  */
310
340
  Logins?: string[];
311
341
  /**
342
+ * @public
312
343
  * <p>Date on which the identity was created.</p>
313
344
  */
314
345
  CreationDate?: Date;
315
346
  /**
347
+ * @public
316
348
  * <p>Date on which the identity was last modified.</p>
317
349
  */
318
350
  LastModifiedDate?: Date;
@@ -323,6 +355,7 @@ export interface IdentityDescription {
323
355
  */
324
356
  export interface DescribeIdentityPoolInput {
325
357
  /**
358
+ * @public
326
359
  * <p>An identity pool ID in the format REGION:GUID.</p>
327
360
  */
328
361
  IdentityPoolId: string | undefined;
@@ -346,10 +379,12 @@ export declare class ExternalServiceException extends __BaseException {
346
379
  */
347
380
  export interface GetCredentialsForIdentityInput {
348
381
  /**
382
+ * @public
349
383
  * <p>A unique identifier in the format REGION:GUID.</p>
350
384
  */
351
385
  IdentityId: string | undefined;
352
386
  /**
387
+ * @public
353
388
  * <p>A set of optional name-value pairs that map provider names to provider tokens. The
354
389
  * name-value pair will follow the syntax "provider_name":
355
390
  * "provider_user_identifier".</p>
@@ -362,6 +397,7 @@ export interface GetCredentialsForIdentityInput {
362
397
  */
363
398
  Logins?: Record<string, string>;
364
399
  /**
400
+ * @public
365
401
  * <p>The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were
366
402
  * received in the token from the identity provider. For example, a SAML-based identity
367
403
  * provider. This parameter is optional for identity providers that do not support role
@@ -375,18 +411,22 @@ export interface GetCredentialsForIdentityInput {
375
411
  */
376
412
  export interface Credentials {
377
413
  /**
414
+ * @public
378
415
  * <p>The Access Key portion of the credentials.</p>
379
416
  */
380
417
  AccessKeyId?: string;
381
418
  /**
419
+ * @public
382
420
  * <p>The Secret Access Key portion of the credentials</p>
383
421
  */
384
422
  SecretKey?: string;
385
423
  /**
424
+ * @public
386
425
  * <p>The Session Token portion of the credentials</p>
387
426
  */
388
427
  SessionToken?: string;
389
428
  /**
429
+ * @public
390
430
  * <p>The date at which these credentials will expire.</p>
391
431
  */
392
432
  Expiration?: Date;
@@ -398,10 +438,12 @@ export interface Credentials {
398
438
  */
399
439
  export interface GetCredentialsForIdentityResponse {
400
440
  /**
441
+ * @public
401
442
  * <p>A unique identifier in the format REGION:GUID.</p>
402
443
  */
403
444
  IdentityId?: string;
404
445
  /**
446
+ * @public
405
447
  * <p>Credentials for the provided identity ID.</p>
406
448
  */
407
449
  Credentials?: Credentials;
@@ -425,14 +467,17 @@ export declare class InvalidIdentityPoolConfigurationException extends __BaseExc
425
467
  */
426
468
  export interface GetIdInput {
427
469
  /**
470
+ * @public
428
471
  * <p>A standard AWS account ID (9+ digits).</p>
429
472
  */
430
473
  AccountId?: string;
431
474
  /**
475
+ * @public
432
476
  * <p>An identity pool ID in the format REGION:GUID.</p>
433
477
  */
434
478
  IdentityPoolId: string | undefined;
435
479
  /**
480
+ * @public
436
481
  * <p>A set of optional name-value pairs that map provider names to provider tokens. The
437
482
  * available provider names for <code>Logins</code> are as follows:</p>
438
483
  * <ul>
@@ -472,6 +517,7 @@ export interface GetIdInput {
472
517
  */
473
518
  export interface GetIdResponse {
474
519
  /**
520
+ * @public
475
521
  * <p>A unique identifier in the format REGION:GUID.</p>
476
522
  */
477
523
  IdentityId?: string;
@@ -482,6 +528,7 @@ export interface GetIdResponse {
482
528
  */
483
529
  export interface GetIdentityPoolRolesInput {
484
530
  /**
531
+ * @public
485
532
  * <p>An identity pool ID in the format REGION:GUID.</p>
486
533
  */
487
534
  IdentityPoolId: string | undefined;
@@ -507,20 +554,24 @@ export type MappingRuleMatchType = (typeof MappingRuleMatchType)[keyof typeof Ma
507
554
  */
508
555
  export interface MappingRule {
509
556
  /**
557
+ * @public
510
558
  * <p>The claim name that must be present in the token, for example, "isAdmin" or
511
559
  * "paid".</p>
512
560
  */
513
561
  Claim: string | undefined;
514
562
  /**
563
+ * @public
515
564
  * <p>The match condition that specifies how closely the claim value in the IdP token must
516
565
  * match <code>Value</code>.</p>
517
566
  */
518
567
  MatchType: MappingRuleMatchType | string | undefined;
519
568
  /**
569
+ * @public
520
570
  * <p>A brief string that the claim must match, for example, "paid" or "yes".</p>
521
571
  */
522
572
  Value: string | undefined;
523
573
  /**
574
+ * @public
524
575
  * <p>The role ARN.</p>
525
576
  */
526
577
  RoleARN: string | undefined;
@@ -531,6 +582,7 @@ export interface MappingRule {
531
582
  */
532
583
  export interface RulesConfigurationType {
533
584
  /**
585
+ * @public
534
586
  * <p>An array of rules. You can specify up to 25 rules per identity provider.</p>
535
587
  * <p>Rules are evaluated in order. The first one to match specifies the role.</p>
536
588
  */
@@ -554,6 +606,7 @@ export type RoleMappingType = (typeof RoleMappingType)[keyof typeof RoleMappingT
554
606
  */
555
607
  export interface RoleMapping {
556
608
  /**
609
+ * @public
557
610
  * <p>The role mapping type. Token will use <code>cognito:roles</code> and
558
611
  * <code>cognito:preferred_role</code> claims from the Cognito identity provider token to
559
612
  * map groups to roles. Rules will attempt to match claims from the token to map to a
@@ -561,6 +614,7 @@ export interface RoleMapping {
561
614
  */
562
615
  Type: RoleMappingType | string | undefined;
563
616
  /**
617
+ * @public
564
618
  * <p>If you specify Token or Rules as the <code>Type</code>,
565
619
  * <code>AmbiguousRoleResolution</code> is required.</p>
566
620
  * <p>Specifies the action to be taken if either no rules match the claim value for the
@@ -570,6 +624,7 @@ export interface RoleMapping {
570
624
  */
571
625
  AmbiguousRoleResolution?: AmbiguousRoleResolutionType | string;
572
626
  /**
627
+ * @public
573
628
  * <p>The rules to be used for mapping users to roles.</p>
574
629
  * <p>If you specify Rules as the role mapping type, <code>RulesConfiguration</code> is
575
630
  * required.</p>
@@ -583,15 +638,18 @@ export interface RoleMapping {
583
638
  */
584
639
  export interface GetIdentityPoolRolesResponse {
585
640
  /**
641
+ * @public
586
642
  * <p>An identity pool ID in the format REGION:GUID.</p>
587
643
  */
588
644
  IdentityPoolId?: string;
589
645
  /**
646
+ * @public
590
647
  * <p>The map of roles associated with this pool. Currently only authenticated and
591
648
  * unauthenticated roles are supported.</p>
592
649
  */
593
650
  Roles?: Record<string, string>;
594
651
  /**
652
+ * @public
595
653
  * <p>How users for a specific identity provider are to mapped to roles. This is a
596
654
  * String-to-<a>RoleMapping</a> object map. The string identifies the identity
597
655
  * provider, for example, "graph.facebook.com" or
@@ -605,10 +663,12 @@ export interface GetIdentityPoolRolesResponse {
605
663
  */
606
664
  export interface GetOpenIdTokenInput {
607
665
  /**
666
+ * @public
608
667
  * <p>A unique identifier in the format REGION:GUID.</p>
609
668
  */
610
669
  IdentityId: string | undefined;
611
670
  /**
671
+ * @public
612
672
  * <p>A set of optional name-value pairs that map provider names to provider tokens. When
613
673
  * using graph.facebook.com and www.amazon.com, supply the access_token returned from the
614
674
  * provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any
@@ -622,11 +682,13 @@ export interface GetOpenIdTokenInput {
622
682
  */
623
683
  export interface GetOpenIdTokenResponse {
624
684
  /**
685
+ * @public
625
686
  * <p>A unique identifier in the format REGION:GUID. Note that the IdentityId returned may
626
687
  * not match the one passed on input.</p>
627
688
  */
628
689
  IdentityId?: string;
629
690
  /**
691
+ * @public
630
692
  * <p>An OpenID token, valid for 10 minutes.</p>
631
693
  */
632
694
  Token?: string;
@@ -650,14 +712,17 @@ export declare class DeveloperUserAlreadyRegisteredException extends __BaseExcep
650
712
  */
651
713
  export interface GetOpenIdTokenForDeveloperIdentityInput {
652
714
  /**
715
+ * @public
653
716
  * <p>An identity pool ID in the format REGION:GUID.</p>
654
717
  */
655
718
  IdentityPoolId: string | undefined;
656
719
  /**
720
+ * @public
657
721
  * <p>A unique identifier in the format REGION:GUID.</p>
658
722
  */
659
723
  IdentityId?: string;
660
724
  /**
725
+ * @public
661
726
  * <p>A set of optional name-value pairs that map provider names to provider tokens. Each
662
727
  * name-value pair represents a user from a public provider or developer provider. If the user
663
728
  * is from a developer provider, the name-value pair will follow the syntax
@@ -669,10 +734,12 @@ export interface GetOpenIdTokenForDeveloperIdentityInput {
669
734
  */
670
735
  Logins: Record<string, string> | undefined;
671
736
  /**
737
+ * @public
672
738
  * <p>Use this operation to configure attribute mappings for custom providers. </p>
673
739
  */
674
740
  PrincipalTags?: Record<string, string>;
675
741
  /**
742
+ * @public
676
743
  * <p>The expiration time of the token, in seconds. You can specify a custom expiration
677
744
  * time for the token so that you can cache it. If you don't provide an expiration time, the
678
745
  * token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS
@@ -693,10 +760,12 @@ export interface GetOpenIdTokenForDeveloperIdentityInput {
693
760
  */
694
761
  export interface GetOpenIdTokenForDeveloperIdentityResponse {
695
762
  /**
763
+ * @public
696
764
  * <p>A unique identifier in the format REGION:GUID.</p>
697
765
  */
698
766
  IdentityId?: string;
699
767
  /**
768
+ * @public
700
769
  * <p>An OpenID token.</p>
701
770
  */
702
771
  Token?: string;
@@ -706,10 +775,12 @@ export interface GetOpenIdTokenForDeveloperIdentityResponse {
706
775
  */
707
776
  export interface GetPrincipalTagAttributeMapInput {
708
777
  /**
778
+ * @public
709
779
  * <p>You can use this operation to get the ID of the Identity Pool you setup attribute mappings for.</p>
710
780
  */
711
781
  IdentityPoolId: string | undefined;
712
782
  /**
783
+ * @public
713
784
  * <p>You can use this operation to get the provider name.</p>
714
785
  */
715
786
  IdentityProviderName: string | undefined;
@@ -719,18 +790,22 @@ export interface GetPrincipalTagAttributeMapInput {
719
790
  */
720
791
  export interface GetPrincipalTagAttributeMapResponse {
721
792
  /**
793
+ * @public
722
794
  * <p>You can use this operation to get the ID of the Identity Pool you setup attribute mappings for.</p>
723
795
  */
724
796
  IdentityPoolId?: string;
725
797
  /**
798
+ * @public
726
799
  * <p>You can use this operation to get the provider name.</p>
727
800
  */
728
801
  IdentityProviderName?: string;
729
802
  /**
803
+ * @public
730
804
  * <p>You can use this operation to list </p>
731
805
  */
732
806
  UseDefaults?: boolean;
733
807
  /**
808
+ * @public
734
809
  * <p>You can use this operation to add principal tags. The <code>PrincipalTags</code>operation enables you to reference user attributes in your IAM permissions policy.</p>
735
810
  */
736
811
  PrincipalTags?: Record<string, string>;
@@ -741,18 +816,22 @@ export interface GetPrincipalTagAttributeMapResponse {
741
816
  */
742
817
  export interface ListIdentitiesInput {
743
818
  /**
819
+ * @public
744
820
  * <p>An identity pool ID in the format REGION:GUID.</p>
745
821
  */
746
822
  IdentityPoolId: string | undefined;
747
823
  /**
824
+ * @public
748
825
  * <p>The maximum number of identities to return.</p>
749
826
  */
750
827
  MaxResults: number | undefined;
751
828
  /**
829
+ * @public
752
830
  * <p>A pagination token.</p>
753
831
  */
754
832
  NextToken?: string;
755
833
  /**
834
+ * @public
756
835
  * <p>An optional boolean parameter that allows you to hide disabled identities. If
757
836
  * omitted, the ListIdentities API will include disabled identities in the response.</p>
758
837
  */
@@ -764,14 +843,17 @@ export interface ListIdentitiesInput {
764
843
  */
765
844
  export interface ListIdentitiesResponse {
766
845
  /**
846
+ * @public
767
847
  * <p>An identity pool ID in the format REGION:GUID.</p>
768
848
  */
769
849
  IdentityPoolId?: string;
770
850
  /**
851
+ * @public
771
852
  * <p>An object containing a set of identities and associated mappings.</p>
772
853
  */
773
854
  Identities?: IdentityDescription[];
774
855
  /**
856
+ * @public
775
857
  * <p>A pagination token.</p>
776
858
  */
777
859
  NextToken?: string;
@@ -782,10 +864,12 @@ export interface ListIdentitiesResponse {
782
864
  */
783
865
  export interface ListIdentityPoolsInput {
784
866
  /**
867
+ * @public
785
868
  * <p>The maximum number of identities to return.</p>
786
869
  */
787
870
  MaxResults: number | undefined;
788
871
  /**
872
+ * @public
789
873
  * <p>A pagination token.</p>
790
874
  */
791
875
  NextToken?: string;
@@ -796,10 +880,12 @@ export interface ListIdentityPoolsInput {
796
880
  */
797
881
  export interface IdentityPoolShortDescription {
798
882
  /**
883
+ * @public
799
884
  * <p>An identity pool ID in the format REGION:GUID.</p>
800
885
  */
801
886
  IdentityPoolId?: string;
802
887
  /**
888
+ * @public
803
889
  * <p>A string that you provide.</p>
804
890
  */
805
891
  IdentityPoolName?: string;
@@ -810,10 +896,12 @@ export interface IdentityPoolShortDescription {
810
896
  */
811
897
  export interface ListIdentityPoolsResponse {
812
898
  /**
899
+ * @public
813
900
  * <p>The identity pools returned by the ListIdentityPools action.</p>
814
901
  */
815
902
  IdentityPools?: IdentityPoolShortDescription[];
816
903
  /**
904
+ * @public
817
905
  * <p>A pagination token.</p>
818
906
  */
819
907
  NextToken?: string;
@@ -823,6 +911,7 @@ export interface ListIdentityPoolsResponse {
823
911
  */
824
912
  export interface ListTagsForResourceInput {
825
913
  /**
914
+ * @public
826
915
  * <p>The Amazon Resource Name (ARN) of the identity pool that the tags are assigned
827
916
  * to.</p>
828
917
  */
@@ -833,6 +922,7 @@ export interface ListTagsForResourceInput {
833
922
  */
834
923
  export interface ListTagsForResourceResponse {
835
924
  /**
925
+ * @public
836
926
  * <p>The tags that are assigned to the identity pool.</p>
837
927
  */
838
928
  Tags?: Record<string, string>;
@@ -843,24 +933,29 @@ export interface ListTagsForResourceResponse {
843
933
  */
844
934
  export interface LookupDeveloperIdentityInput {
845
935
  /**
936
+ * @public
846
937
  * <p>An identity pool ID in the format REGION:GUID.</p>
847
938
  */
848
939
  IdentityPoolId: string | undefined;
849
940
  /**
941
+ * @public
850
942
  * <p>A unique identifier in the format REGION:GUID.</p>
851
943
  */
852
944
  IdentityId?: string;
853
945
  /**
946
+ * @public
854
947
  * <p>A unique ID used by your backend authentication process to identify a user.
855
948
  * Typically, a developer identity provider would issue many developer user identifiers, in
856
949
  * keeping with the number of users.</p>
857
950
  */
858
951
  DeveloperUserIdentifier?: string;
859
952
  /**
953
+ * @public
860
954
  * <p>The maximum number of identities to return.</p>
861
955
  */
862
956
  MaxResults?: number;
863
957
  /**
958
+ * @public
864
959
  * <p>A pagination token. The first call you make will have <code>NextToken</code> set to
865
960
  * null. After that the service will return <code>NextToken</code> values as needed. For
866
961
  * example, let's say you make a request with <code>MaxResults</code> set to 10, and there are
@@ -877,16 +972,19 @@ export interface LookupDeveloperIdentityInput {
877
972
  */
878
973
  export interface LookupDeveloperIdentityResponse {
879
974
  /**
975
+ * @public
880
976
  * <p>A unique identifier in the format REGION:GUID.</p>
881
977
  */
882
978
  IdentityId?: string;
883
979
  /**
980
+ * @public
884
981
  * <p>This is the list of developer user identifiers associated with an identity ID.
885
982
  * Cognito supports the association of multiple developer user identifiers with an identity
886
983
  * ID.</p>
887
984
  */
888
985
  DeveloperUserIdentifierList?: string[];
889
986
  /**
987
+ * @public
890
988
  * <p>A pagination token. The first call you make will have <code>NextToken</code> set to
891
989
  * null. After that the service will return <code>NextToken</code> values as needed. For
892
990
  * example, let's say you make a request with <code>MaxResults</code> set to 10, and there are
@@ -902,16 +1000,19 @@ export interface LookupDeveloperIdentityResponse {
902
1000
  */
903
1001
  export interface MergeDeveloperIdentitiesInput {
904
1002
  /**
1003
+ * @public
905
1004
  * <p>User identifier for the source user. The value should be a
906
1005
  * <code>DeveloperUserIdentifier</code>.</p>
907
1006
  */
908
1007
  SourceUserIdentifier: string | undefined;
909
1008
  /**
1009
+ * @public
910
1010
  * <p>User identifier for the destination user. The value should be a
911
1011
  * <code>DeveloperUserIdentifier</code>.</p>
912
1012
  */
913
1013
  DestinationUserIdentifier: string | undefined;
914
1014
  /**
1015
+ * @public
915
1016
  * <p>The "domain" by which Cognito will refer to your users. This is a (pseudo) domain
916
1017
  * name that you provide while creating an identity pool. This name acts as a placeholder that
917
1018
  * allows your backend and the Cognito service to communicate about the developer provider.
@@ -920,6 +1021,7 @@ export interface MergeDeveloperIdentitiesInput {
920
1021
  */
921
1022
  DeveloperProviderName: string | undefined;
922
1023
  /**
1024
+ * @public
923
1025
  * <p>An identity pool ID in the format REGION:GUID.</p>
924
1026
  */
925
1027
  IdentityPoolId: string | undefined;
@@ -931,6 +1033,7 @@ export interface MergeDeveloperIdentitiesInput {
931
1033
  */
932
1034
  export interface MergeDeveloperIdentitiesResponse {
933
1035
  /**
1036
+ * @public
934
1037
  * <p>A unique identifier in the format REGION:GUID.</p>
935
1038
  */
936
1039
  IdentityId?: string;
@@ -953,15 +1056,18 @@ export declare class ConcurrentModificationException extends __BaseException {
953
1056
  */
954
1057
  export interface SetIdentityPoolRolesInput {
955
1058
  /**
1059
+ * @public
956
1060
  * <p>An identity pool ID in the format REGION:GUID.</p>
957
1061
  */
958
1062
  IdentityPoolId: string | undefined;
959
1063
  /**
1064
+ * @public
960
1065
  * <p>The map of roles associated with this pool. For a given role, the key will be either
961
1066
  * "authenticated" or "unauthenticated" and the value will be the Role ARN.</p>
962
1067
  */
963
1068
  Roles: Record<string, string> | undefined;
964
1069
  /**
1070
+ * @public
965
1071
  * <p>How users for a specific identity provider are to mapped to roles. This is a string
966
1072
  * to <a>RoleMapping</a> object map. The string identifies the identity provider,
967
1073
  * for example, "graph.facebook.com" or
@@ -975,18 +1081,22 @@ export interface SetIdentityPoolRolesInput {
975
1081
  */
976
1082
  export interface SetPrincipalTagAttributeMapInput {
977
1083
  /**
1084
+ * @public
978
1085
  * <p>The ID of the Identity Pool you want to set attribute mappings for.</p>
979
1086
  */
980
1087
  IdentityPoolId: string | undefined;
981
1088
  /**
1089
+ * @public
982
1090
  * <p>The provider name you want to use for attribute mappings.</p>
983
1091
  */
984
1092
  IdentityProviderName: string | undefined;
985
1093
  /**
1094
+ * @public
986
1095
  * <p>You can use this operation to use default (username and clientID) attribute mappings.</p>
987
1096
  */
988
1097
  UseDefaults?: boolean;
989
1098
  /**
1099
+ * @public
990
1100
  * <p>You can use this operation to add principal tags.</p>
991
1101
  */
992
1102
  PrincipalTags?: Record<string, string>;
@@ -996,18 +1106,22 @@ export interface SetPrincipalTagAttributeMapInput {
996
1106
  */
997
1107
  export interface SetPrincipalTagAttributeMapResponse {
998
1108
  /**
1109
+ * @public
999
1110
  * <p>The ID of the Identity Pool you want to set attribute mappings for.</p>
1000
1111
  */
1001
1112
  IdentityPoolId?: string;
1002
1113
  /**
1114
+ * @public
1003
1115
  * <p>The provider name you want to use for attribute mappings.</p>
1004
1116
  */
1005
1117
  IdentityProviderName?: string;
1006
1118
  /**
1119
+ * @public
1007
1120
  * <p>You can use this operation to select default (username and clientID) attribute mappings.</p>
1008
1121
  */
1009
1122
  UseDefaults?: boolean;
1010
1123
  /**
1124
+ * @public
1011
1125
  * <p>You can use this operation to add principal tags. The <code>PrincipalTags</code>operation enables you to reference user attributes in your IAM permissions policy.</p>
1012
1126
  */
1013
1127
  PrincipalTags?: Record<string, string>;
@@ -1017,10 +1131,12 @@ export interface SetPrincipalTagAttributeMapResponse {
1017
1131
  */
1018
1132
  export interface TagResourceInput {
1019
1133
  /**
1134
+ * @public
1020
1135
  * <p>The Amazon Resource Name (ARN) of the identity pool.</p>
1021
1136
  */
1022
1137
  ResourceArn: string | undefined;
1023
1138
  /**
1139
+ * @public
1024
1140
  * <p>The tags to assign to the identity pool.</p>
1025
1141
  */
1026
1142
  Tags: Record<string, string> | undefined;
@@ -1036,18 +1152,22 @@ export interface TagResourceResponse {
1036
1152
  */
1037
1153
  export interface UnlinkDeveloperIdentityInput {
1038
1154
  /**
1155
+ * @public
1039
1156
  * <p>A unique identifier in the format REGION:GUID.</p>
1040
1157
  */
1041
1158
  IdentityId: string | undefined;
1042
1159
  /**
1160
+ * @public
1043
1161
  * <p>An identity pool ID in the format REGION:GUID.</p>
1044
1162
  */
1045
1163
  IdentityPoolId: string | undefined;
1046
1164
  /**
1165
+ * @public
1047
1166
  * <p>The "domain" by which Cognito will refer to your users.</p>
1048
1167
  */
1049
1168
  DeveloperProviderName: string | undefined;
1050
1169
  /**
1170
+ * @public
1051
1171
  * <p>A unique ID used by your backend authentication process to identify a user.</p>
1052
1172
  */
1053
1173
  DeveloperUserIdentifier: string | undefined;
@@ -1058,15 +1178,18 @@ export interface UnlinkDeveloperIdentityInput {
1058
1178
  */
1059
1179
  export interface UnlinkIdentityInput {
1060
1180
  /**
1181
+ * @public
1061
1182
  * <p>A unique identifier in the format REGION:GUID.</p>
1062
1183
  */
1063
1184
  IdentityId: string | undefined;
1064
1185
  /**
1186
+ * @public
1065
1187
  * <p>A set of optional name-value pairs that map provider names to provider
1066
1188
  * tokens.</p>
1067
1189
  */
1068
1190
  Logins: Record<string, string> | undefined;
1069
1191
  /**
1192
+ * @public
1070
1193
  * <p>Provider names to unlink from this identity.</p>
1071
1194
  */
1072
1195
  LoginsToRemove: string[] | undefined;
@@ -1076,10 +1199,12 @@ export interface UnlinkIdentityInput {
1076
1199
  */
1077
1200
  export interface UntagResourceInput {
1078
1201
  /**
1202
+ * @public
1079
1203
  * <p>The Amazon Resource Name (ARN) of the identity pool.</p>
1080
1204
  */
1081
1205
  ResourceArn: string | undefined;
1082
1206
  /**
1207
+ * @public
1083
1208
  * <p>The keys of the tags to remove from the user pool.</p>
1084
1209
  */
1085
1210
  TagKeys: string[] | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cognito-identity",
3
3
  "description": "AWS SDK for JavaScript Cognito Identity Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.385.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",
@@ -22,15 +22,15 @@
22
22
  "dependencies": {
23
23
  "@aws-crypto/sha256-browser": "3.0.0",
24
24
  "@aws-crypto/sha256-js": "3.0.0",
25
- "@aws-sdk/client-sts": "3.379.1",
26
- "@aws-sdk/credential-provider-node": "3.379.1",
25
+ "@aws-sdk/client-sts": "3.385.0",
26
+ "@aws-sdk/credential-provider-node": "3.385.0",
27
27
  "@aws-sdk/middleware-host-header": "3.379.1",
28
28
  "@aws-sdk/middleware-logger": "3.378.0",
29
29
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
30
30
  "@aws-sdk/middleware-signing": "3.379.1",
31
- "@aws-sdk/middleware-user-agent": "3.379.1",
31
+ "@aws-sdk/middleware-user-agent": "3.382.0",
32
32
  "@aws-sdk/types": "3.378.0",
33
- "@aws-sdk/util-endpoints": "3.378.0",
33
+ "@aws-sdk/util-endpoints": "3.382.0",
34
34
  "@aws-sdk/util-user-agent-browser": "3.378.0",
35
35
  "@aws-sdk/util-user-agent-node": "3.378.0",
36
36
  "@smithy/config-resolver": "^2.0.1",
@@ -58,7 +58,7 @@
58
58
  "tslib": "^2.5.0"
59
59
  },
60
60
  "devDependencies": {
61
- "@aws-sdk/client-iam": "3.379.1",
61
+ "@aws-sdk/client-iam": "3.385.0",
62
62
  "@smithy/service-client-documentation-generator": "^2.0.0",
63
63
  "@tsconfig/node14": "1.0.3",
64
64
  "@types/chai": "^4.2.11",