forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcognito-identity-2014-06-30.normal.json
1334 lines (1334 loc) · 55.4 KB
/
cognito-identity-2014-06-30.normal.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version":"2.0",
"metadata":{
"apiVersion":"2014-06-30",
"endpointPrefix":"cognito-identity",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon Cognito Identity",
"signatureVersion":"v4",
"targetPrefix":"AWSCognitoIdentityService",
"uid":"cognito-identity-2014-06-30"
},
"operations":{
"CreateIdentityPool":{
"name":"CreateIdentityPool",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateIdentityPoolInput"},
"output":{"shape":"IdentityPool"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"NotAuthorizedException"},
{"shape":"ResourceConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for <code>SupportedLoginProviders</code> are as follows:</p> <ul> <li> <p>Facebook: <code>graph.facebook.com</code> </p> </li> <li> <p>Google: <code>accounts.google.com</code> </p> </li> <li> <p>Amazon: <code>www.amazon.com</code> </p> </li> <li> <p>Twitter: <code>api.twitter.com</code> </p> </li> <li> <p>Digits: <code>www.digits.com</code> </p> </li> </ul> <p>You must use AWS Developer credentials to call this API.</p>"
},
"DeleteIdentities":{
"name":"DeleteIdentities",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteIdentitiesInput"},
"output":{"shape":"DeleteIdentitiesResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"<p>Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.</p> <p>You must use AWS Developer credentials to call this API.</p>"
},
"DeleteIdentityPool":{
"name":"DeleteIdentityPool",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteIdentityPoolInput"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"<p>Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.</p> <p>You must use AWS Developer credentials to call this API.</p>"
},
"DescribeIdentity":{
"name":"DescribeIdentity",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeIdentityInput"},
"output":{"shape":"IdentityDescription"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"<p>Returns metadata related to the given identity, including when the identity was created and any associated linked logins.</p> <p>You must use AWS Developer credentials to call this API.</p>"
},
"DescribeIdentityPool":{
"name":"DescribeIdentityPool",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeIdentityPoolInput"},
"output":{"shape":"IdentityPool"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"<p>Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.</p> <p>You must use AWS Developer credentials to call this API.</p>"
},
"GetCredentialsForIdentity":{
"name":"GetCredentialsForIdentity",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCredentialsForIdentityInput"},
"output":{"shape":"GetCredentialsForIdentityResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"ResourceConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"InvalidIdentityPoolConfigurationException"},
{"shape":"InternalErrorException"},
{"shape":"ExternalServiceException"}
],
"documentation":"<p>Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.</p> <p>This is a public API. You do not need any credentials to call this API.</p>"
},
"GetId":{
"name":"GetId",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetIdInput"},
"output":{"shape":"GetIdResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"ResourceConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"},
{"shape":"LimitExceededException"},
{"shape":"ExternalServiceException"}
],
"documentation":"<p>Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.</p> <p>This is a public API. You do not need any credentials to call this API.</p>"
},
"GetIdentityPoolRoles":{
"name":"GetIdentityPoolRoles",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetIdentityPoolRolesInput"},
"output":{"shape":"GetIdentityPoolRolesResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"ResourceConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"<p>Gets the roles for an identity pool.</p> <p>You must use AWS Developer credentials to call this API.</p>"
},
"GetOpenIdToken":{
"name":"GetOpenIdToken",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetOpenIdTokenInput"},
"output":{"shape":"GetOpenIdTokenResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"ResourceConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"},
{"shape":"ExternalServiceException"}
],
"documentation":"<p>Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by <a>GetId</a>. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.</p> <p>The OpenId token is valid for 15 minutes.</p> <p>This is a public API. You do not need any credentials to call this API.</p>"
},
"GetOpenIdTokenForDeveloperIdentity":{
"name":"GetOpenIdTokenForDeveloperIdentity",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetOpenIdTokenForDeveloperIdentityInput"},
"output":{"shape":"GetOpenIdTokenForDeveloperIdentityResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"ResourceConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"},
{"shape":"DeveloperUserAlreadyRegisteredException"}
],
"documentation":"<p>Registers (or retrieves) a Cognito <code>IdentityId</code> and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the <code>Logins</code> map, which is linked to the identity pool. The developer provider is the \"domain\" by which Cognito will refer to your users.</p> <p>You can use <code>GetOpenIdTokenForDeveloperIdentity</code> to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the <code>IdentityId</code> should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing <code>IdentityId</code>. This API will create the identity in the specified <code>IdentityPoolId</code>.</p> <p>You must use AWS Developer credentials to call this API.</p>"
},
"ListIdentities":{
"name":"ListIdentities",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListIdentitiesInput"},
"output":{"shape":"ListIdentitiesResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"<p>Lists the identities in a pool.</p> <p>You must use AWS Developer credentials to call this API.</p>"
},
"ListIdentityPools":{
"name":"ListIdentityPools",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListIdentityPoolsInput"},
"output":{"shape":"ListIdentityPoolsResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"<p>Lists all of the Cognito identity pools registered for your account.</p> <p>You must use AWS Developer credentials to call this API.</p>"
},
"LookupDeveloperIdentity":{
"name":"LookupDeveloperIdentity",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"LookupDeveloperIdentityInput"},
"output":{"shape":"LookupDeveloperIdentityResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"ResourceConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"<p>Retrieves the <code>IdentityID</code> associated with a <code>DeveloperUserIdentifier</code> or the list of <code>DeveloperUserIdentifier</code>s associated with an <code>IdentityId</code> for an existing identity. Either <code>IdentityID</code> or <code>DeveloperUserIdentifier</code> must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, <code>DeveloperUserIdentifier</code> will be matched against <code>IdentityID</code>. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a <code>ResourceConflictException</code> is thrown.</p> <p>You must use AWS Developer credentials to call this API.</p>"
},
"MergeDeveloperIdentities":{
"name":"MergeDeveloperIdentities",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"MergeDeveloperIdentitiesInput"},
"output":{"shape":"MergeDeveloperIdentitiesResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"ResourceConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"<p>Merges two users having different <code>IdentityId</code>s, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (<code>SourceUserIdentifier</code>) with the <code>IdentityId</code> of the <code>DestinationUserIdentifier</code>. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.</p> <p>You must use AWS Developer credentials to call this API.</p>"
},
"SetIdentityPoolRoles":{
"name":"SetIdentityPoolRoles",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SetIdentityPoolRolesInput"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"ResourceConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Sets the roles for an identity pool. These roles are used when making calls to <a>GetCredentialsForIdentity</a> action.</p> <p>You must use AWS Developer credentials to call this API.</p>"
},
"UnlinkDeveloperIdentity":{
"name":"UnlinkDeveloperIdentity",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UnlinkDeveloperIdentityInput"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"ResourceConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"<p>Unlinks a <code>DeveloperUserIdentifier</code> from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.</p> <p>You must use AWS Developer credentials to call this API.</p>"
},
"UnlinkIdentity":{
"name":"UnlinkIdentity",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UnlinkIdentityInput"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"ResourceConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"},
{"shape":"ExternalServiceException"}
],
"documentation":"<p>Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.</p> <p>This is a public API. You do not need any credentials to call this API.</p>"
},
"UpdateIdentityPool":{
"name":"UpdateIdentityPool",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"IdentityPool"},
"output":{"shape":"IdentityPool"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"ResourceConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"},
{"shape":"ConcurrentModificationException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Updates a user pool.</p> <p>You must use AWS Developer credentials to call this API.</p>"
}
},
"shapes":{
"ARNString":{
"type":"string",
"max":2048,
"min":20
},
"AccessKeyString":{"type":"string"},
"AccountId":{
"type":"string",
"max":15,
"min":1,
"pattern":"\\d+"
},
"AmbiguousRoleResolutionType":{
"type":"string",
"enum":[
"AuthenticatedRole",
"Deny"
]
},
"ClaimName":{
"type":"string",
"max":64,
"min":1,
"pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+"
},
"ClaimValue":{
"type":"string",
"max":128,
"min":1
},
"CognitoIdentityProvider":{
"type":"structure",
"members":{
"ProviderName":{
"shape":"CognitoIdentityProviderName",
"documentation":"<p>The provider name for an Amazon Cognito Identity User Pool. For example, <code>cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789</code>.</p>"
},
"ClientId":{
"shape":"CognitoIdentityProviderClientId",
"documentation":"<p>The client ID for the Amazon Cognito Identity User Pool.</p>"
}
},
"documentation":"<p>A provider representing an Amazon Cognito Identity User Pool and its client ID.</p>"
},
"CognitoIdentityProviderClientId":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\w_]+"
},
"CognitoIdentityProviderList":{
"type":"list",
"member":{"shape":"CognitoIdentityProvider"}
},
"CognitoIdentityProviderName":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\w._:/-]+"
},
"ConcurrentModificationException":{
"type":"structure",
"members":{
"message":{
"shape":"String",
"documentation":"<p>The message returned by a ConcurrentModificationException.</p>"
}
},
"documentation":"<p>Thrown if there are parallel requests to modify a resource.</p>",
"exception":true
},
"CreateIdentityPoolInput":{
"type":"structure",
"required":[
"IdentityPoolName",
"AllowUnauthenticatedIdentities"
],
"members":{
"IdentityPoolName":{
"shape":"IdentityPoolName",
"documentation":"<p>A string that you provide.</p>"
},
"AllowUnauthenticatedIdentities":{
"shape":"IdentityPoolUnauthenticated",
"documentation":"<p>TRUE if the identity pool supports unauthenticated logins.</p>"
},
"SupportedLoginProviders":{
"shape":"IdentityProviders",
"documentation":"<p>Optional key:value pairs mapping provider names to provider app IDs.</p>"
},
"DeveloperProviderName":{
"shape":"DeveloperProviderName",
"documentation":"<p>The \"domain\" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the <code>DeveloperProviderName</code>, you can use letters as well as period (<code>.</code>), underscore (<code>_</code>), and dash (<code>-</code>).</p> <p>Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.</p>"
},
"OpenIdConnectProviderARNs":{
"shape":"OIDCProviderList",
"documentation":"<p>A list of OpendID Connect provider ARNs.</p>"
},
"CognitoIdentityProviders":{
"shape":"CognitoIdentityProviderList",
"documentation":"<p>An array of Amazon Cognito Identity user pools and their client IDs.</p>"
},
"SamlProviderARNs":{
"shape":"SAMLProviderList",
"documentation":"<p>An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.</p>"
}
},
"documentation":"<p>Input to the CreateIdentityPool action.</p>"
},
"Credentials":{
"type":"structure",
"members":{
"AccessKeyId":{
"shape":"AccessKeyString",
"documentation":"<p>The Access Key portion of the credentials.</p>"
},
"SecretKey":{
"shape":"SecretKeyString",
"documentation":"<p>The Secret Access Key portion of the credentials</p>"
},
"SessionToken":{
"shape":"SessionTokenString",
"documentation":"<p>The Session Token portion of the credentials</p>"
},
"Expiration":{
"shape":"DateType",
"documentation":"<p>The date at which these credentials will expire.</p>"
}
},
"documentation":"<p>Credentials for the provided identity ID.</p>"
},
"DateType":{"type":"timestamp"},
"DeleteIdentitiesInput":{
"type":"structure",
"required":["IdentityIdsToDelete"],
"members":{
"IdentityIdsToDelete":{
"shape":"IdentityIdList",
"documentation":"<p>A list of 1-60 identities that you want to delete.</p>"
}
},
"documentation":"<p>Input to the <code>DeleteIdentities</code> action.</p>"
},
"DeleteIdentitiesResponse":{
"type":"structure",
"members":{
"UnprocessedIdentityIds":{
"shape":"UnprocessedIdentityIdList",
"documentation":"<p>An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.</p>"
}
},
"documentation":"<p>Returned in response to a successful <code>DeleteIdentities</code> operation.</p>"
},
"DeleteIdentityPoolInput":{
"type":"structure",
"required":["IdentityPoolId"],
"members":{
"IdentityPoolId":{
"shape":"IdentityPoolId",
"documentation":"<p>An identity pool ID in the format REGION:GUID.</p>"
}
},
"documentation":"<p>Input to the DeleteIdentityPool action.</p>"
},
"DescribeIdentityInput":{
"type":"structure",
"required":["IdentityId"],
"members":{
"IdentityId":{
"shape":"IdentityId",
"documentation":"<p>A unique identifier in the format REGION:GUID.</p>"
}
},
"documentation":"<p>Input to the <code>DescribeIdentity</code> action.</p>"
},
"DescribeIdentityPoolInput":{
"type":"structure",
"required":["IdentityPoolId"],
"members":{
"IdentityPoolId":{
"shape":"IdentityPoolId",
"documentation":"<p>An identity pool ID in the format REGION:GUID.</p>"
}
},
"documentation":"<p>Input to the DescribeIdentityPool action.</p>"
},
"DeveloperProviderName":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\w._-]+"
},
"DeveloperUserAlreadyRegisteredException":{
"type":"structure",
"members":{
"message":{
"shape":"String",
"documentation":"<p>This developer user identifier is already registered with Cognito.</p>"
}
},
"documentation":"<p>The provided developer user identifier is already registered with Cognito under a different identity ID.</p>",
"exception":true
},
"DeveloperUserIdentifier":{
"type":"string",
"max":1024,
"min":1
},
"DeveloperUserIdentifierList":{
"type":"list",
"member":{"shape":"DeveloperUserIdentifier"}
},
"ErrorCode":{
"type":"string",
"enum":[
"AccessDenied",
"InternalServerError"
]
},
"ExternalServiceException":{
"type":"structure",
"members":{
"message":{
"shape":"String",
"documentation":"<p>The message returned by an ExternalServiceException</p>"
}
},
"documentation":"<p>An exception thrown when a dependent service such as Facebook or Twitter is not responding</p>",
"exception":true
},
"GetCredentialsForIdentityInput":{
"type":"structure",
"required":["IdentityId"],
"members":{
"IdentityId":{
"shape":"IdentityId",
"documentation":"<p>A unique identifier in the format REGION:GUID.</p>"
},
"Logins":{
"shape":"LoginsMap",
"documentation":"<p>A set of optional name-value pairs that map provider names to provider tokens.</p>"
},
"CustomRoleArn":{
"shape":"ARNString",
"documentation":"<p>The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.</p>"
}
},
"documentation":"<p>Input to the <code>GetCredentialsForIdentity</code> action.</p>"
},
"GetCredentialsForIdentityResponse":{
"type":"structure",
"members":{
"IdentityId":{
"shape":"IdentityId",
"documentation":"<p>A unique identifier in the format REGION:GUID.</p>"
},
"Credentials":{
"shape":"Credentials",
"documentation":"<p>Credentials for the provided identity ID.</p>"
}
},
"documentation":"<p>Returned in response to a successful <code>GetCredentialsForIdentity</code> operation.</p>"
},
"GetIdInput":{
"type":"structure",
"required":["IdentityPoolId"],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>A standard AWS account ID (9+ digits).</p>"
},
"IdentityPoolId":{
"shape":"IdentityPoolId",
"documentation":"<p>An identity pool ID in the format REGION:GUID.</p>"
},
"Logins":{
"shape":"LoginsMap",
"documentation":"<p>A set of optional name-value pairs that map provider names to provider tokens. The available provider names for <code>Logins</code> are as follows:</p> <ul> <li> <p>Facebook: <code>graph.facebook.com</code> </p> </li> <li> <p>Amazon Cognito Identity Provider: <code>cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789</code> </p> </li> <li> <p>Google: <code>accounts.google.com</code> </p> </li> <li> <p>Amazon: <code>www.amazon.com</code> </p> </li> <li> <p>Twitter: <code>api.twitter.com</code> </p> </li> <li> <p>Digits: <code>www.digits.com</code> </p> </li> </ul>"
}
},
"documentation":"<p>Input to the GetId action.</p>"
},
"GetIdResponse":{
"type":"structure",
"members":{
"IdentityId":{
"shape":"IdentityId",
"documentation":"<p>A unique identifier in the format REGION:GUID.</p>"
}
},
"documentation":"<p>Returned in response to a GetId request.</p>"
},
"GetIdentityPoolRolesInput":{
"type":"structure",
"required":["IdentityPoolId"],
"members":{
"IdentityPoolId":{
"shape":"IdentityPoolId",
"documentation":"<p>An identity pool ID in the format REGION:GUID.</p>"
}
},
"documentation":"<p>Input to the <code>GetIdentityPoolRoles</code> action.</p>"
},
"GetIdentityPoolRolesResponse":{
"type":"structure",
"members":{
"IdentityPoolId":{
"shape":"IdentityPoolId",
"documentation":"<p>An identity pool ID in the format REGION:GUID.</p>"
},
"Roles":{
"shape":"RolesMap",
"documentation":"<p>The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.</p>"
},
"RoleMappings":{
"shape":"RoleMappingMap",
"documentation":"<p>How users for a specific identity provider are to mapped to roles. This is a String-to-<a>RoleMapping</a> object map. The string identifies the identity provider, for example, \"graph.facebook.com\" or \"cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id\".</p>"
}
},
"documentation":"<p>Returned in response to a successful <code>GetIdentityPoolRoles</code> operation.</p>"
},
"GetOpenIdTokenForDeveloperIdentityInput":{
"type":"structure",
"required":[
"IdentityPoolId",
"Logins"
],
"members":{
"IdentityPoolId":{
"shape":"IdentityPoolId",
"documentation":"<p>An identity pool ID in the format REGION:GUID.</p>"
},
"IdentityId":{
"shape":"IdentityId",
"documentation":"<p>A unique identifier in the format REGION:GUID.</p>"
},
"Logins":{
"shape":"LoginsMap",
"documentation":"<p>A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax <code>\"developer_provider_name\": \"developer_user_identifier\"</code>. The developer provider is the \"domain\" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.</p>"
},
"TokenDuration":{
"shape":"TokenDuration",
"documentation":"<p>The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.</p>"
}
},
"documentation":"<p>Input to the <code>GetOpenIdTokenForDeveloperIdentity</code> action.</p>"
},
"GetOpenIdTokenForDeveloperIdentityResponse":{
"type":"structure",
"members":{
"IdentityId":{
"shape":"IdentityId",
"documentation":"<p>A unique identifier in the format REGION:GUID.</p>"
},
"Token":{
"shape":"OIDCToken",
"documentation":"<p>An OpenID token.</p>"
}
},
"documentation":"<p>Returned in response to a successful <code>GetOpenIdTokenForDeveloperIdentity</code> request.</p>"
},
"GetOpenIdTokenInput":{
"type":"structure",
"required":["IdentityId"],
"members":{
"IdentityId":{
"shape":"IdentityId",
"documentation":"<p>A unique identifier in the format REGION:GUID.</p>"
},
"Logins":{
"shape":"LoginsMap",
"documentation":"<p>A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito Identity Provider, or any other OpenId Connect provider, always include the <code>id_token</code>.</p>"
}
},
"documentation":"<p>Input to the GetOpenIdToken action.</p>"
},
"GetOpenIdTokenResponse":{
"type":"structure",
"members":{
"IdentityId":{
"shape":"IdentityId",
"documentation":"<p>A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.</p>"
},
"Token":{
"shape":"OIDCToken",
"documentation":"<p>An OpenID token, valid for 15 minutes.</p>"
}
},
"documentation":"<p>Returned in response to a successful GetOpenIdToken request.</p>"
},
"HideDisabled":{"type":"boolean"},
"IdentitiesList":{
"type":"list",
"member":{"shape":"IdentityDescription"}
},
"IdentityDescription":{
"type":"structure",
"members":{
"IdentityId":{
"shape":"IdentityId",
"documentation":"<p>A unique identifier in the format REGION:GUID.</p>"
},
"Logins":{
"shape":"LoginsList",
"documentation":"<p>A set of optional name-value pairs that map provider names to provider tokens.</p>"
},
"CreationDate":{
"shape":"DateType",
"documentation":"<p>Date on which the identity was created.</p>"
},
"LastModifiedDate":{
"shape":"DateType",
"documentation":"<p>Date on which the identity was last modified.</p>"
}
},
"documentation":"<p>A description of the identity.</p>"
},
"IdentityId":{
"type":"string",
"max":55,
"min":1,
"pattern":"[\\w-]+:[0-9a-f-]+"
},
"IdentityIdList":{
"type":"list",
"member":{"shape":"IdentityId"},
"max":60,
"min":1
},
"IdentityPool":{
"type":"structure",
"required":[
"IdentityPoolId",
"IdentityPoolName",
"AllowUnauthenticatedIdentities"
],
"members":{
"IdentityPoolId":{
"shape":"IdentityPoolId",
"documentation":"<p>An identity pool ID in the format REGION:GUID.</p>"
},
"IdentityPoolName":{
"shape":"IdentityPoolName",
"documentation":"<p>A string that you provide.</p>"
},
"AllowUnauthenticatedIdentities":{
"shape":"IdentityPoolUnauthenticated",
"documentation":"<p>TRUE if the identity pool supports unauthenticated logins.</p>"
},
"SupportedLoginProviders":{
"shape":"IdentityProviders",
"documentation":"<p>Optional key:value pairs mapping provider names to provider app IDs.</p>"
},
"DeveloperProviderName":{
"shape":"DeveloperProviderName",
"documentation":"<p>The \"domain\" by which Cognito will refer to your users.</p>"
},
"OpenIdConnectProviderARNs":{
"shape":"OIDCProviderList",
"documentation":"<p>A list of OpendID Connect provider ARNs.</p>"
},
"CognitoIdentityProviders":{
"shape":"CognitoIdentityProviderList",
"documentation":"<p>A list representing an Amazon Cognito Identity User Pool and its client ID.</p>"
},
"SamlProviderARNs":{
"shape":"SAMLProviderList",
"documentation":"<p>An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.</p>"
}
},
"documentation":"<p>An object representing an Amazon Cognito identity pool.</p>"
},
"IdentityPoolId":{
"type":"string",
"max":55,
"min":1,
"pattern":"[\\w-]+:[0-9a-f-]+"
},
"IdentityPoolName":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\w ]+"
},
"IdentityPoolShortDescription":{
"type":"structure",
"members":{
"IdentityPoolId":{
"shape":"IdentityPoolId",
"documentation":"<p>An identity pool ID in the format REGION:GUID.</p>"
},
"IdentityPoolName":{
"shape":"IdentityPoolName",
"documentation":"<p>A string that you provide.</p>"
}
},
"documentation":"<p>A description of the identity pool.</p>"
},
"IdentityPoolUnauthenticated":{"type":"boolean"},
"IdentityPoolsList":{
"type":"list",
"member":{"shape":"IdentityPoolShortDescription"}
},
"IdentityProviderId":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\w.;_/-]+"
},
"IdentityProviderName":{
"type":"string",
"max":128,
"min":1
},
"IdentityProviderToken":{
"type":"string",
"max":50000,
"min":1
},
"IdentityProviders":{
"type":"map",
"key":{"shape":"IdentityProviderName"},
"value":{"shape":"IdentityProviderId"},
"max":10
},
"InternalErrorException":{
"type":"structure",
"members":{
"message":{
"shape":"String",
"documentation":"<p>The message returned by an InternalErrorException.</p>"
}
},
"documentation":"<p>Thrown when the service encounters an error during processing the request.</p>",
"exception":true,
"fault":true
},
"InvalidIdentityPoolConfigurationException":{
"type":"structure",
"members":{
"message":{
"shape":"String",
"documentation":"<p>The message returned for an <code>InvalidIdentityPoolConfigurationException</code> </p>"
}
},
"documentation":"<p>Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.</p>",
"exception":true
},
"InvalidParameterException":{
"type":"structure",
"members":{
"message":{
"shape":"String",
"documentation":"<p>The message returned by an InvalidParameterException.</p>"
}
},
"documentation":"<p>Thrown for missing or bad input parameter(s).</p>",
"exception":true
},
"LimitExceededException":{
"type":"structure",
"members":{
"message":{
"shape":"String",
"documentation":"<p>The message returned by a LimitExceededException.</p>"
}
},
"documentation":"<p>Thrown when the total number of user pools has exceeded a preset limit.</p>",
"exception":true
},
"ListIdentitiesInput":{
"type":"structure",
"required":[
"IdentityPoolId",
"MaxResults"
],
"members":{
"IdentityPoolId":{
"shape":"IdentityPoolId",
"documentation":"<p>An identity pool ID in the format REGION:GUID.</p>"
},
"MaxResults":{
"shape":"QueryLimit",
"documentation":"<p>The maximum number of identities to return.</p>"
},
"NextToken":{
"shape":"PaginationKey",
"documentation":"<p>A pagination token.</p>"
},
"HideDisabled":{
"shape":"HideDisabled",
"documentation":"<p>An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.</p>"
}
},
"documentation":"<p>Input to the ListIdentities action.</p>"
},
"ListIdentitiesResponse":{
"type":"structure",
"members":{
"IdentityPoolId":{
"shape":"IdentityPoolId",
"documentation":"<p>An identity pool ID in the format REGION:GUID.</p>"
},
"Identities":{
"shape":"IdentitiesList",
"documentation":"<p>An object containing a set of identities and associated mappings.</p>"
},
"NextToken":{
"shape":"PaginationKey",
"documentation":"<p>A pagination token.</p>"
}
},
"documentation":"<p>The response to a ListIdentities request.</p>"
},
"ListIdentityPoolsInput":{
"type":"structure",
"required":["MaxResults"],
"members":{
"MaxResults":{
"shape":"QueryLimit",
"documentation":"<p>The maximum number of identities to return.</p>"
},
"NextToken":{
"shape":"PaginationKey",
"documentation":"<p>A pagination token.</p>"
}
},
"documentation":"<p>Input to the ListIdentityPools action.</p>"
},
"ListIdentityPoolsResponse":{
"type":"structure",
"members":{
"IdentityPools":{
"shape":"IdentityPoolsList",
"documentation":"<p>The identity pools returned by the ListIdentityPools action.</p>"
},
"NextToken":{
"shape":"PaginationKey",
"documentation":"<p>A pagination token.</p>"
}
},
"documentation":"<p>The result of a successful ListIdentityPools action.</p>"
},
"LoginsList":{
"type":"list",
"member":{"shape":"IdentityProviderName"}
},
"LoginsMap":{
"type":"map",
"key":{"shape":"IdentityProviderName"},
"value":{"shape":"IdentityProviderToken"},
"max":10
},
"LookupDeveloperIdentityInput":{
"type":"structure",
"required":["IdentityPoolId"],
"members":{
"IdentityPoolId":{
"shape":"IdentityPoolId",
"documentation":"<p>An identity pool ID in the format REGION:GUID.</p>"
},
"IdentityId":{
"shape":"IdentityId",
"documentation":"<p>A unique identifier in the format REGION:GUID.</p>"