aws-sdk-cognitoidentity 1.0.0.rc1

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.
@@ -0,0 +1,7 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module CognitoIdentity
10
+ module Errors
11
+
12
+ extend Aws::Errors::DynamicErrors
13
+
14
+ # Raised when calling #load or #data on a resource class that can not be
15
+ # loaded. This can happen when:
16
+ #
17
+ # * A resource class has identifiers, but no data attributes.
18
+ # * Resource data is only available when making an API call that
19
+ # enumerates all resources of that type.
20
+ class ResourceNotLoadable < RuntimeError; end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,25 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module CognitoIdentity
10
+ class Resource
11
+
12
+ # @param options ({})
13
+ # @option options [Client] :client
14
+ def initialize(options = {})
15
+ @client = options[:client] || Client.new(options)
16
+ end
17
+
18
+ # @return [Client]
19
+ def client
20
+ @client
21
+ end
22
+
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,853 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module CognitoIdentity
10
+ module Types
11
+
12
+ # A provider representing an Amazon Cognito Identity User Pool and its
13
+ # client ID.
14
+ # @note When making an API call, pass CognitoIdentityProvider
15
+ # data as a hash:
16
+ #
17
+ # {
18
+ # provider_name: "CognitoIdentityProviderName",
19
+ # client_id: "CognitoIdentityProviderClientId",
20
+ # }
21
+ # @!attribute [rw] provider_name
22
+ # The provider name for an Amazon Cognito Identity User Pool. For
23
+ # example, `cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789`.
24
+ # @return [String]
25
+ #
26
+ # @!attribute [rw] client_id
27
+ # The client ID for the Amazon Cognito Identity User Pool.
28
+ # @return [String]
29
+ class CognitoIdentityProvider < Struct.new(
30
+ :provider_name,
31
+ :client_id)
32
+ include Aws::Structure
33
+ end
34
+
35
+ # Input to the CreateIdentityPool action.
36
+ # @note When making an API call, pass CreateIdentityPoolInput
37
+ # data as a hash:
38
+ #
39
+ # {
40
+ # identity_pool_name: "IdentityPoolName", # required
41
+ # allow_unauthenticated_identities: false, # required
42
+ # supported_login_providers: {
43
+ # "IdentityProviderName" => "IdentityProviderId",
44
+ # },
45
+ # developer_provider_name: "DeveloperProviderName",
46
+ # open_id_connect_provider_arns: ["ARNString"],
47
+ # cognito_identity_providers: [
48
+ # {
49
+ # provider_name: "CognitoIdentityProviderName",
50
+ # client_id: "CognitoIdentityProviderClientId",
51
+ # },
52
+ # ],
53
+ # saml_provider_arns: ["ARNString"],
54
+ # }
55
+ # @!attribute [rw] identity_pool_name
56
+ # A string that you provide.
57
+ # @return [String]
58
+ #
59
+ # @!attribute [rw] allow_unauthenticated_identities
60
+ # TRUE if the identity pool supports unauthenticated logins.
61
+ # @return [Boolean]
62
+ #
63
+ # @!attribute [rw] supported_login_providers
64
+ # Optional key:value pairs mapping provider names to provider app IDs.
65
+ # @return [Hash<String,String>]
66
+ #
67
+ # @!attribute [rw] developer_provider_name
68
+ # The "domain" by which Cognito will refer to your users. This name
69
+ # acts as a placeholder that allows your backend and the Cognito
70
+ # service to communicate about the developer provider. For the
71
+ # `DeveloperProviderName`, you can use letters as well as period
72
+ # (`.`), underscore (`_`), and dash (`-`).
73
+ #
74
+ # Once you have set a developer provider name, you cannot change it.
75
+ # Please take care in setting this parameter.
76
+ # @return [String]
77
+ #
78
+ # @!attribute [rw] open_id_connect_provider_arns
79
+ # A list of OpendID Connect provider ARNs.
80
+ # @return [Array<String>]
81
+ #
82
+ # @!attribute [rw] cognito_identity_providers
83
+ # An array of Amazon Cognito Identity user pools.
84
+ # @return [Array<Types::CognitoIdentityProvider>]
85
+ #
86
+ # @!attribute [rw] saml_provider_arns
87
+ # An array of Amazon Resource Names (ARNs) of the SAML provider for
88
+ # your identity pool.
89
+ # @return [Array<String>]
90
+ class CreateIdentityPoolInput < Struct.new(
91
+ :identity_pool_name,
92
+ :allow_unauthenticated_identities,
93
+ :supported_login_providers,
94
+ :developer_provider_name,
95
+ :open_id_connect_provider_arns,
96
+ :cognito_identity_providers,
97
+ :saml_provider_arns)
98
+ include Aws::Structure
99
+ end
100
+
101
+ # Credentials for the provided identity ID.
102
+ # @!attribute [rw] access_key_id
103
+ # The Access Key portion of the credentials.
104
+ # @return [String]
105
+ #
106
+ # @!attribute [rw] secret_key
107
+ # The Secret Access Key portion of the credentials
108
+ # @return [String]
109
+ #
110
+ # @!attribute [rw] session_token
111
+ # The Session Token portion of the credentials
112
+ # @return [String]
113
+ #
114
+ # @!attribute [rw] expiration
115
+ # The date at which these credentials will expire.
116
+ # @return [Time]
117
+ class Credentials < Struct.new(
118
+ :access_key_id,
119
+ :secret_key,
120
+ :session_token,
121
+ :expiration)
122
+ include Aws::Structure
123
+ end
124
+
125
+ # Input to the `DeleteIdentities` action.
126
+ # @note When making an API call, pass DeleteIdentitiesInput
127
+ # data as a hash:
128
+ #
129
+ # {
130
+ # identity_ids_to_delete: ["IdentityId"], # required
131
+ # }
132
+ # @!attribute [rw] identity_ids_to_delete
133
+ # A list of 1-60 identities that you want to delete.
134
+ # @return [Array<String>]
135
+ class DeleteIdentitiesInput < Struct.new(
136
+ :identity_ids_to_delete)
137
+ include Aws::Structure
138
+ end
139
+
140
+ # Returned in response to a successful `DeleteIdentities` operation.
141
+ # @!attribute [rw] unprocessed_identity_ids
142
+ # An array of UnprocessedIdentityId objects, each of which contains an
143
+ # ErrorCode and IdentityId.
144
+ # @return [Array<Types::UnprocessedIdentityId>]
145
+ class DeleteIdentitiesResponse < Struct.new(
146
+ :unprocessed_identity_ids)
147
+ include Aws::Structure
148
+ end
149
+
150
+ # Input to the DeleteIdentityPool action.
151
+ # @note When making an API call, pass DeleteIdentityPoolInput
152
+ # data as a hash:
153
+ #
154
+ # {
155
+ # identity_pool_id: "IdentityPoolId", # required
156
+ # }
157
+ # @!attribute [rw] identity_pool_id
158
+ # An identity pool ID in the format REGION:GUID.
159
+ # @return [String]
160
+ class DeleteIdentityPoolInput < Struct.new(
161
+ :identity_pool_id)
162
+ include Aws::Structure
163
+ end
164
+
165
+ # Input to the `DescribeIdentity` action.
166
+ # @note When making an API call, pass DescribeIdentityInput
167
+ # data as a hash:
168
+ #
169
+ # {
170
+ # identity_id: "IdentityId", # required
171
+ # }
172
+ # @!attribute [rw] identity_id
173
+ # A unique identifier in the format REGION:GUID.
174
+ # @return [String]
175
+ class DescribeIdentityInput < Struct.new(
176
+ :identity_id)
177
+ include Aws::Structure
178
+ end
179
+
180
+ # Input to the DescribeIdentityPool action.
181
+ # @note When making an API call, pass DescribeIdentityPoolInput
182
+ # data as a hash:
183
+ #
184
+ # {
185
+ # identity_pool_id: "IdentityPoolId", # required
186
+ # }
187
+ # @!attribute [rw] identity_pool_id
188
+ # An identity pool ID in the format REGION:GUID.
189
+ # @return [String]
190
+ class DescribeIdentityPoolInput < Struct.new(
191
+ :identity_pool_id)
192
+ include Aws::Structure
193
+ end
194
+
195
+ # Input to the `GetCredentialsForIdentity` action.
196
+ # @note When making an API call, pass GetCredentialsForIdentityInput
197
+ # data as a hash:
198
+ #
199
+ # {
200
+ # identity_id: "IdentityId", # required
201
+ # logins: {
202
+ # "IdentityProviderName" => "IdentityProviderToken",
203
+ # },
204
+ # custom_role_arn: "ARNString",
205
+ # }
206
+ # @!attribute [rw] identity_id
207
+ # A unique identifier in the format REGION:GUID.
208
+ # @return [String]
209
+ #
210
+ # @!attribute [rw] logins
211
+ # A set of optional name-value pairs that map provider names to
212
+ # provider tokens.
213
+ # @return [Hash<String,String>]
214
+ #
215
+ # @!attribute [rw] custom_role_arn
216
+ # The Amazon Resource Name (ARN) of the role to be assumed when
217
+ # multiple roles were received in the token from the identity
218
+ # provider. For example, a SAML-based identity provider. This
219
+ # parameter is optional for identity providers that do not support
220
+ # role customization.
221
+ # @return [String]
222
+ class GetCredentialsForIdentityInput < Struct.new(
223
+ :identity_id,
224
+ :logins,
225
+ :custom_role_arn)
226
+ include Aws::Structure
227
+ end
228
+
229
+ # Returned in response to a successful `GetCredentialsForIdentity`
230
+ # operation.
231
+ # @!attribute [rw] identity_id
232
+ # A unique identifier in the format REGION:GUID.
233
+ # @return [String]
234
+ #
235
+ # @!attribute [rw] credentials
236
+ # Credentials for the provided identity ID.
237
+ # @return [Types::Credentials]
238
+ class GetCredentialsForIdentityResponse < Struct.new(
239
+ :identity_id,
240
+ :credentials)
241
+ include Aws::Structure
242
+ end
243
+
244
+ # Input to the GetId action.
245
+ # @note When making an API call, pass GetIdInput
246
+ # data as a hash:
247
+ #
248
+ # {
249
+ # account_id: "AccountId",
250
+ # identity_pool_id: "IdentityPoolId", # required
251
+ # logins: {
252
+ # "IdentityProviderName" => "IdentityProviderToken",
253
+ # },
254
+ # }
255
+ # @!attribute [rw] account_id
256
+ # A standard AWS account ID (9+ digits).
257
+ # @return [String]
258
+ #
259
+ # @!attribute [rw] identity_pool_id
260
+ # An identity pool ID in the format REGION:GUID.
261
+ # @return [String]
262
+ #
263
+ # @!attribute [rw] logins
264
+ # A set of optional name-value pairs that map provider names to
265
+ # provider tokens.
266
+ #
267
+ # The available provider names for `Logins` are as follows: *
268
+ # Facebook: `graph.facebook.com`
269
+ # * Google: `accounts.google.com`
270
+ # * Amazon: `www.amazon.com`
271
+ # * Twitter: `api.twitter.com`
272
+ # * Digits: `www.digits.com`
273
+ # @return [Hash<String,String>]
274
+ class GetIdInput < Struct.new(
275
+ :account_id,
276
+ :identity_pool_id,
277
+ :logins)
278
+ include Aws::Structure
279
+ end
280
+
281
+ # Returned in response to a GetId request.
282
+ # @!attribute [rw] identity_id
283
+ # A unique identifier in the format REGION:GUID.
284
+ # @return [String]
285
+ class GetIdResponse < Struct.new(
286
+ :identity_id)
287
+ include Aws::Structure
288
+ end
289
+
290
+ # Input to the `GetIdentityPoolRoles` action.
291
+ # @note When making an API call, pass GetIdentityPoolRolesInput
292
+ # data as a hash:
293
+ #
294
+ # {
295
+ # identity_pool_id: "IdentityPoolId", # required
296
+ # }
297
+ # @!attribute [rw] identity_pool_id
298
+ # An identity pool ID in the format REGION:GUID.
299
+ # @return [String]
300
+ class GetIdentityPoolRolesInput < Struct.new(
301
+ :identity_pool_id)
302
+ include Aws::Structure
303
+ end
304
+
305
+ # Returned in response to a successful `GetIdentityPoolRoles` operation.
306
+ # @!attribute [rw] identity_pool_id
307
+ # An identity pool ID in the format REGION:GUID.
308
+ # @return [String]
309
+ #
310
+ # @!attribute [rw] roles
311
+ # The map of roles associated with this pool. Currently only
312
+ # authenticated and unauthenticated roles are supported.
313
+ # @return [Hash<String,String>]
314
+ class GetIdentityPoolRolesResponse < Struct.new(
315
+ :identity_pool_id,
316
+ :roles)
317
+ include Aws::Structure
318
+ end
319
+
320
+ # Input to the `GetOpenIdTokenForDeveloperIdentity` action.
321
+ # @note When making an API call, pass GetOpenIdTokenForDeveloperIdentityInput
322
+ # data as a hash:
323
+ #
324
+ # {
325
+ # identity_pool_id: "IdentityPoolId", # required
326
+ # identity_id: "IdentityId",
327
+ # logins: { # required
328
+ # "IdentityProviderName" => "IdentityProviderToken",
329
+ # },
330
+ # token_duration: 1,
331
+ # }
332
+ # @!attribute [rw] identity_pool_id
333
+ # An identity pool ID in the format REGION:GUID.
334
+ # @return [String]
335
+ #
336
+ # @!attribute [rw] identity_id
337
+ # A unique identifier in the format REGION:GUID.
338
+ # @return [String]
339
+ #
340
+ # @!attribute [rw] logins
341
+ # A set of optional name-value pairs that map provider names to
342
+ # provider tokens. Each name-value pair represents a user from a
343
+ # public provider or developer provider. If the user is from a
344
+ # developer provider, the name-value pair will follow the syntax
345
+ # `"developer_provider_name": "developer_user_identifier"`. The
346
+ # developer provider is the "domain" by which Cognito will refer to
347
+ # your users; you provided this domain while creating/updating the
348
+ # identity pool. The developer user identifier is an identifier from
349
+ # your backend that uniquely identifies a user. When you create an
350
+ # identity pool, you can specify the supported logins.
351
+ # @return [Hash<String,String>]
352
+ #
353
+ # @!attribute [rw] token_duration
354
+ # The expiration time of the token, in seconds. You can specify a
355
+ # custom expiration time for the token so that you can cache it. If
356
+ # you don't provide an expiration time, the token is valid for 15
357
+ # minutes. You can exchange the token with Amazon STS for temporary
358
+ # AWS credentials, which are valid for a maximum of one hour. The
359
+ # maximum token duration you can set is 24 hours. You should take care
360
+ # in setting the expiration time for a token, as there are significant
361
+ # security implications: an attacker could use a leaked token to
362
+ # access your AWS resources for the token's duration.
363
+ # @return [Integer]
364
+ class GetOpenIdTokenForDeveloperIdentityInput < Struct.new(
365
+ :identity_pool_id,
366
+ :identity_id,
367
+ :logins,
368
+ :token_duration)
369
+ include Aws::Structure
370
+ end
371
+
372
+ # Returned in response to a successful
373
+ # `GetOpenIdTokenForDeveloperIdentity` request.
374
+ # @!attribute [rw] identity_id
375
+ # A unique identifier in the format REGION:GUID.
376
+ # @return [String]
377
+ #
378
+ # @!attribute [rw] token
379
+ # An OpenID token.
380
+ # @return [String]
381
+ class GetOpenIdTokenForDeveloperIdentityResponse < Struct.new(
382
+ :identity_id,
383
+ :token)
384
+ include Aws::Structure
385
+ end
386
+
387
+ # Input to the GetOpenIdToken action.
388
+ # @note When making an API call, pass GetOpenIdTokenInput
389
+ # data as a hash:
390
+ #
391
+ # {
392
+ # identity_id: "IdentityId", # required
393
+ # logins: {
394
+ # "IdentityProviderName" => "IdentityProviderToken",
395
+ # },
396
+ # }
397
+ # @!attribute [rw] identity_id
398
+ # A unique identifier in the format REGION:GUID.
399
+ # @return [String]
400
+ #
401
+ # @!attribute [rw] logins
402
+ # A set of optional name-value pairs that map provider names to
403
+ # provider tokens. When using graph.facebook.com and www.amazon.com,
404
+ # supply the access\_token returned from the provider's authflow. For
405
+ # accounts.google.com or any other OpenId Connect provider, always
406
+ # include the id\_token.
407
+ # @return [Hash<String,String>]
408
+ class GetOpenIdTokenInput < Struct.new(
409
+ :identity_id,
410
+ :logins)
411
+ include Aws::Structure
412
+ end
413
+
414
+ # Returned in response to a successful GetOpenIdToken request.
415
+ # @!attribute [rw] identity_id
416
+ # A unique identifier in the format REGION:GUID. Note that the
417
+ # IdentityId returned may not match the one passed on input.
418
+ # @return [String]
419
+ #
420
+ # @!attribute [rw] token
421
+ # An OpenID token, valid for 15 minutes.
422
+ # @return [String]
423
+ class GetOpenIdTokenResponse < Struct.new(
424
+ :identity_id,
425
+ :token)
426
+ include Aws::Structure
427
+ end
428
+
429
+ # A description of the identity.
430
+ # @!attribute [rw] identity_id
431
+ # A unique identifier in the format REGION:GUID.
432
+ # @return [String]
433
+ #
434
+ # @!attribute [rw] logins
435
+ # A set of optional name-value pairs that map provider names to
436
+ # provider tokens.
437
+ # @return [Array<String>]
438
+ #
439
+ # @!attribute [rw] creation_date
440
+ # Date on which the identity was created.
441
+ # @return [Time]
442
+ #
443
+ # @!attribute [rw] last_modified_date
444
+ # Date on which the identity was last modified.
445
+ # @return [Time]
446
+ class IdentityDescription < Struct.new(
447
+ :identity_id,
448
+ :logins,
449
+ :creation_date,
450
+ :last_modified_date)
451
+ include Aws::Structure
452
+ end
453
+
454
+ # An object representing a Cognito identity pool.
455
+ # @note When making an API call, pass IdentityPool
456
+ # data as a hash:
457
+ #
458
+ # {
459
+ # identity_pool_id: "IdentityPoolId", # required
460
+ # identity_pool_name: "IdentityPoolName", # required
461
+ # allow_unauthenticated_identities: false, # required
462
+ # supported_login_providers: {
463
+ # "IdentityProviderName" => "IdentityProviderId",
464
+ # },
465
+ # developer_provider_name: "DeveloperProviderName",
466
+ # open_id_connect_provider_arns: ["ARNString"],
467
+ # cognito_identity_providers: [
468
+ # {
469
+ # provider_name: "CognitoIdentityProviderName",
470
+ # client_id: "CognitoIdentityProviderClientId",
471
+ # },
472
+ # ],
473
+ # saml_provider_arns: ["ARNString"],
474
+ # }
475
+ # @!attribute [rw] identity_pool_id
476
+ # An identity pool ID in the format REGION:GUID.
477
+ # @return [String]
478
+ #
479
+ # @!attribute [rw] identity_pool_name
480
+ # A string that you provide.
481
+ # @return [String]
482
+ #
483
+ # @!attribute [rw] allow_unauthenticated_identities
484
+ # TRUE if the identity pool supports unauthenticated logins.
485
+ # @return [Boolean]
486
+ #
487
+ # @!attribute [rw] supported_login_providers
488
+ # Optional key:value pairs mapping provider names to provider app IDs.
489
+ # @return [Hash<String,String>]
490
+ #
491
+ # @!attribute [rw] developer_provider_name
492
+ # The "domain" by which Cognito will refer to your users.
493
+ # @return [String]
494
+ #
495
+ # @!attribute [rw] open_id_connect_provider_arns
496
+ # A list of OpendID Connect provider ARNs.
497
+ # @return [Array<String>]
498
+ #
499
+ # @!attribute [rw] cognito_identity_providers
500
+ # A list representing an Amazon Cognito Identity User Pool and its
501
+ # client ID.
502
+ # @return [Array<Types::CognitoIdentityProvider>]
503
+ #
504
+ # @!attribute [rw] saml_provider_arns
505
+ # An array of Amazon Resource Names (ARNs) of the SAML provider for
506
+ # your identity pool.
507
+ # @return [Array<String>]
508
+ class IdentityPool < Struct.new(
509
+ :identity_pool_id,
510
+ :identity_pool_name,
511
+ :allow_unauthenticated_identities,
512
+ :supported_login_providers,
513
+ :developer_provider_name,
514
+ :open_id_connect_provider_arns,
515
+ :cognito_identity_providers,
516
+ :saml_provider_arns)
517
+ include Aws::Structure
518
+ end
519
+
520
+ # A description of the identity pool.
521
+ # @!attribute [rw] identity_pool_id
522
+ # An identity pool ID in the format REGION:GUID.
523
+ # @return [String]
524
+ #
525
+ # @!attribute [rw] identity_pool_name
526
+ # A string that you provide.
527
+ # @return [String]
528
+ class IdentityPoolShortDescription < Struct.new(
529
+ :identity_pool_id,
530
+ :identity_pool_name)
531
+ include Aws::Structure
532
+ end
533
+
534
+ # Input to the ListIdentities action.
535
+ # @note When making an API call, pass ListIdentitiesInput
536
+ # data as a hash:
537
+ #
538
+ # {
539
+ # identity_pool_id: "IdentityPoolId", # required
540
+ # max_results: 1, # required
541
+ # next_token: "PaginationKey",
542
+ # hide_disabled: false,
543
+ # }
544
+ # @!attribute [rw] identity_pool_id
545
+ # An identity pool ID in the format REGION:GUID.
546
+ # @return [String]
547
+ #
548
+ # @!attribute [rw] max_results
549
+ # The maximum number of identities to return.
550
+ # @return [Integer]
551
+ #
552
+ # @!attribute [rw] next_token
553
+ # A pagination token.
554
+ # @return [String]
555
+ #
556
+ # @!attribute [rw] hide_disabled
557
+ # An optional boolean parameter that allows you to hide disabled
558
+ # identities. If omitted, the ListIdentities API will include disabled
559
+ # identities in the response.
560
+ # @return [Boolean]
561
+ class ListIdentitiesInput < Struct.new(
562
+ :identity_pool_id,
563
+ :max_results,
564
+ :next_token,
565
+ :hide_disabled)
566
+ include Aws::Structure
567
+ end
568
+
569
+ # The response to a ListIdentities request.
570
+ # @!attribute [rw] identity_pool_id
571
+ # An identity pool ID in the format REGION:GUID.
572
+ # @return [String]
573
+ #
574
+ # @!attribute [rw] identities
575
+ # An object containing a set of identities and associated mappings.
576
+ # @return [Array<Types::IdentityDescription>]
577
+ #
578
+ # @!attribute [rw] next_token
579
+ # A pagination token.
580
+ # @return [String]
581
+ class ListIdentitiesResponse < Struct.new(
582
+ :identity_pool_id,
583
+ :identities,
584
+ :next_token)
585
+ include Aws::Structure
586
+ end
587
+
588
+ # Input to the ListIdentityPools action.
589
+ # @note When making an API call, pass ListIdentityPoolsInput
590
+ # data as a hash:
591
+ #
592
+ # {
593
+ # max_results: 1, # required
594
+ # next_token: "PaginationKey",
595
+ # }
596
+ # @!attribute [rw] max_results
597
+ # The maximum number of identities to return.
598
+ # @return [Integer]
599
+ #
600
+ # @!attribute [rw] next_token
601
+ # A pagination token.
602
+ # @return [String]
603
+ class ListIdentityPoolsInput < Struct.new(
604
+ :max_results,
605
+ :next_token)
606
+ include Aws::Structure
607
+ end
608
+
609
+ # The result of a successful ListIdentityPools action.
610
+ # @!attribute [rw] identity_pools
611
+ # The identity pools returned by the ListIdentityPools action.
612
+ # @return [Array<Types::IdentityPoolShortDescription>]
613
+ #
614
+ # @!attribute [rw] next_token
615
+ # A pagination token.
616
+ # @return [String]
617
+ class ListIdentityPoolsResponse < Struct.new(
618
+ :identity_pools,
619
+ :next_token)
620
+ include Aws::Structure
621
+ end
622
+
623
+ # Input to the `LookupDeveloperIdentityInput` action.
624
+ # @note When making an API call, pass LookupDeveloperIdentityInput
625
+ # data as a hash:
626
+ #
627
+ # {
628
+ # identity_pool_id: "IdentityPoolId", # required
629
+ # identity_id: "IdentityId",
630
+ # developer_user_identifier: "DeveloperUserIdentifier",
631
+ # max_results: 1,
632
+ # next_token: "PaginationKey",
633
+ # }
634
+ # @!attribute [rw] identity_pool_id
635
+ # An identity pool ID in the format REGION:GUID.
636
+ # @return [String]
637
+ #
638
+ # @!attribute [rw] identity_id
639
+ # A unique identifier in the format REGION:GUID.
640
+ # @return [String]
641
+ #
642
+ # @!attribute [rw] developer_user_identifier
643
+ # A unique ID used by your backend authentication process to identify
644
+ # a user. Typically, a developer identity provider would issue many
645
+ # developer user identifiers, in keeping with the number of users.
646
+ # @return [String]
647
+ #
648
+ # @!attribute [rw] max_results
649
+ # The maximum number of identities to return.
650
+ # @return [Integer]
651
+ #
652
+ # @!attribute [rw] next_token
653
+ # A pagination token. The first call you make will have `NextToken`
654
+ # set to null. After that the service will return `NextToken` values
655
+ # as needed. For example, let's say you make a request with
656
+ # `MaxResults` set to 10, and there are 20 matches in the database.
657
+ # The service will return a pagination token as a part of the
658
+ # response. This token can be used to call the API again and get
659
+ # results starting from the 11th match.
660
+ # @return [String]
661
+ class LookupDeveloperIdentityInput < Struct.new(
662
+ :identity_pool_id,
663
+ :identity_id,
664
+ :developer_user_identifier,
665
+ :max_results,
666
+ :next_token)
667
+ include Aws::Structure
668
+ end
669
+
670
+ # Returned in response to a successful `LookupDeveloperIdentity` action.
671
+ # @!attribute [rw] identity_id
672
+ # A unique identifier in the format REGION:GUID.
673
+ # @return [String]
674
+ #
675
+ # @!attribute [rw] developer_user_identifier_list
676
+ # This is the list of developer user identifiers associated with an
677
+ # identity ID. Cognito supports the association of multiple developer
678
+ # user identifiers with an identity ID.
679
+ # @return [Array<String>]
680
+ #
681
+ # @!attribute [rw] next_token
682
+ # A pagination token. The first call you make will have `NextToken`
683
+ # set to null. After that the service will return `NextToken` values
684
+ # as needed. For example, let's say you make a request with
685
+ # `MaxResults` set to 10, and there are 20 matches in the database.
686
+ # The service will return a pagination token as a part of the
687
+ # response. This token can be used to call the API again and get
688
+ # results starting from the 11th match.
689
+ # @return [String]
690
+ class LookupDeveloperIdentityResponse < Struct.new(
691
+ :identity_id,
692
+ :developer_user_identifier_list,
693
+ :next_token)
694
+ include Aws::Structure
695
+ end
696
+
697
+ # Input to the `MergeDeveloperIdentities` action.
698
+ # @note When making an API call, pass MergeDeveloperIdentitiesInput
699
+ # data as a hash:
700
+ #
701
+ # {
702
+ # source_user_identifier: "DeveloperUserIdentifier", # required
703
+ # destination_user_identifier: "DeveloperUserIdentifier", # required
704
+ # developer_provider_name: "DeveloperProviderName", # required
705
+ # identity_pool_id: "IdentityPoolId", # required
706
+ # }
707
+ # @!attribute [rw] source_user_identifier
708
+ # User identifier for the source user. The value should be a
709
+ # `DeveloperUserIdentifier`.
710
+ # @return [String]
711
+ #
712
+ # @!attribute [rw] destination_user_identifier
713
+ # User identifier for the destination user. The value should be a
714
+ # `DeveloperUserIdentifier`.
715
+ # @return [String]
716
+ #
717
+ # @!attribute [rw] developer_provider_name
718
+ # The "domain" by which Cognito will refer to your users. This is a
719
+ # (pseudo) domain name that you provide while creating an identity
720
+ # pool. This name acts as a placeholder that allows your backend and
721
+ # the Cognito service to communicate about the developer provider. For
722
+ # the `DeveloperProviderName`, you can use letters as well as period
723
+ # (.), underscore (\_), and dash (-).
724
+ # @return [String]
725
+ #
726
+ # @!attribute [rw] identity_pool_id
727
+ # An identity pool ID in the format REGION:GUID.
728
+ # @return [String]
729
+ class MergeDeveloperIdentitiesInput < Struct.new(
730
+ :source_user_identifier,
731
+ :destination_user_identifier,
732
+ :developer_provider_name,
733
+ :identity_pool_id)
734
+ include Aws::Structure
735
+ end
736
+
737
+ # Returned in response to a successful `MergeDeveloperIdentities`
738
+ # action.
739
+ # @!attribute [rw] identity_id
740
+ # A unique identifier in the format REGION:GUID.
741
+ # @return [String]
742
+ class MergeDeveloperIdentitiesResponse < Struct.new(
743
+ :identity_id)
744
+ include Aws::Structure
745
+ end
746
+
747
+ # Input to the `SetIdentityPoolRoles` action.
748
+ # @note When making an API call, pass SetIdentityPoolRolesInput
749
+ # data as a hash:
750
+ #
751
+ # {
752
+ # identity_pool_id: "IdentityPoolId", # required
753
+ # roles: { # required
754
+ # "RoleType" => "ARNString",
755
+ # },
756
+ # }
757
+ # @!attribute [rw] identity_pool_id
758
+ # An identity pool ID in the format REGION:GUID.
759
+ # @return [String]
760
+ #
761
+ # @!attribute [rw] roles
762
+ # The map of roles associated with this pool. For a given role, the
763
+ # key will be either "authenticated" or "unauthenticated" and the
764
+ # value will be the Role ARN.
765
+ # @return [Hash<String,String>]
766
+ class SetIdentityPoolRolesInput < Struct.new(
767
+ :identity_pool_id,
768
+ :roles)
769
+ include Aws::Structure
770
+ end
771
+
772
+ # Input to the `UnlinkDeveloperIdentity` action.
773
+ # @note When making an API call, pass UnlinkDeveloperIdentityInput
774
+ # data as a hash:
775
+ #
776
+ # {
777
+ # identity_id: "IdentityId", # required
778
+ # identity_pool_id: "IdentityPoolId", # required
779
+ # developer_provider_name: "DeveloperProviderName", # required
780
+ # developer_user_identifier: "DeveloperUserIdentifier", # required
781
+ # }
782
+ # @!attribute [rw] identity_id
783
+ # A unique identifier in the format REGION:GUID.
784
+ # @return [String]
785
+ #
786
+ # @!attribute [rw] identity_pool_id
787
+ # An identity pool ID in the format REGION:GUID.
788
+ # @return [String]
789
+ #
790
+ # @!attribute [rw] developer_provider_name
791
+ # The "domain" by which Cognito will refer to your users.
792
+ # @return [String]
793
+ #
794
+ # @!attribute [rw] developer_user_identifier
795
+ # A unique ID used by your backend authentication process to identify
796
+ # a user.
797
+ # @return [String]
798
+ class UnlinkDeveloperIdentityInput < Struct.new(
799
+ :identity_id,
800
+ :identity_pool_id,
801
+ :developer_provider_name,
802
+ :developer_user_identifier)
803
+ include Aws::Structure
804
+ end
805
+
806
+ # Input to the UnlinkIdentity action.
807
+ # @note When making an API call, pass UnlinkIdentityInput
808
+ # data as a hash:
809
+ #
810
+ # {
811
+ # identity_id: "IdentityId", # required
812
+ # logins: { # required
813
+ # "IdentityProviderName" => "IdentityProviderToken",
814
+ # },
815
+ # logins_to_remove: ["IdentityProviderName"], # required
816
+ # }
817
+ # @!attribute [rw] identity_id
818
+ # A unique identifier in the format REGION:GUID.
819
+ # @return [String]
820
+ #
821
+ # @!attribute [rw] logins
822
+ # A set of optional name-value pairs that map provider names to
823
+ # provider tokens.
824
+ # @return [Hash<String,String>]
825
+ #
826
+ # @!attribute [rw] logins_to_remove
827
+ # Provider names to unlink from this identity.
828
+ # @return [Array<String>]
829
+ class UnlinkIdentityInput < Struct.new(
830
+ :identity_id,
831
+ :logins,
832
+ :logins_to_remove)
833
+ include Aws::Structure
834
+ end
835
+
836
+ # An array of UnprocessedIdentityId objects, each of which contains an
837
+ # ErrorCode and IdentityId.
838
+ # @!attribute [rw] identity_id
839
+ # A unique identifier in the format REGION:GUID.
840
+ # @return [String]
841
+ #
842
+ # @!attribute [rw] error_code
843
+ # The error code indicating the type of error that occurred.
844
+ # @return [String]
845
+ class UnprocessedIdentityId < Struct.new(
846
+ :identity_id,
847
+ :error_code)
848
+ include Aws::Structure
849
+ end
850
+
851
+ end
852
+ end
853
+ end