aws-sdk-cognitoidentity 1.0.0.rc1 → 1.0.0.rc2
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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-cognitoidentity.rb +1 -1
- data/lib/aws-sdk-cognitoidentity/client.rb +1062 -881
- data/lib/aws-sdk-cognitoidentity/client_api.rb +572 -543
- data/lib/aws-sdk-cognitoidentity/errors.rb +4 -13
- data/lib/aws-sdk-cognitoidentity/resource.rb +12 -14
- data/lib/aws-sdk-cognitoidentity/types.rb +1087 -843
- metadata +2 -2
@@ -1,23 +1,14 @@
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
2
2
|
#
|
3
|
-
# This file is generated. See the contributing for
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
5
|
#
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
|
-
module Aws
|
9
|
-
module
|
10
|
-
module Errors
|
8
|
+
module Aws::CognitoIdentity
|
9
|
+
module Errors
|
11
10
|
|
12
|
-
|
11
|
+
extend Aws::Errors::DynamicErrors
|
13
12
|
|
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
13
|
end
|
23
14
|
end
|
@@ -1,25 +1,23 @@
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
2
2
|
#
|
3
|
-
# This file is generated. See the contributing for
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
5
|
#
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
|
-
module Aws
|
9
|
-
|
10
|
-
class Resource
|
8
|
+
module Aws::CognitoIdentity
|
9
|
+
class Resource
|
11
10
|
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
# @return [Client]
|
19
|
-
def client
|
20
|
-
@client
|
21
|
-
end
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
22
16
|
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
23
20
|
end
|
21
|
+
|
24
22
|
end
|
25
23
|
end
|
@@ -1,853 +1,1097 @@
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
2
2
|
#
|
3
|
-
# This file is generated. See the contributing for
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
5
|
#
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
|
-
module Aws
|
9
|
-
module
|
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
|
8
|
+
module Aws::CognitoIdentity
|
9
|
+
module Types
|
850
10
|
|
11
|
+
# A provider representing an Amazon Cognito Identity User Pool and its
|
12
|
+
# client ID.
|
13
|
+
#
|
14
|
+
# @note When making an API call, you may pass CognitoIdentityProvider
|
15
|
+
# data as a hash:
|
16
|
+
#
|
17
|
+
# {
|
18
|
+
# provider_name: "CognitoIdentityProviderName",
|
19
|
+
# client_id: "CognitoIdentityProviderClientId",
|
20
|
+
# }
|
21
|
+
#
|
22
|
+
# @!attribute [rw] provider_name
|
23
|
+
# The provider name for an Amazon Cognito Identity User Pool. For
|
24
|
+
# example, `cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789`.
|
25
|
+
# @return [String]
|
26
|
+
#
|
27
|
+
# @!attribute [rw] client_id
|
28
|
+
# The client ID for the Amazon Cognito Identity User Pool.
|
29
|
+
# @return [String]
|
30
|
+
#
|
31
|
+
class CognitoIdentityProvider < Struct.new(
|
32
|
+
:provider_name,
|
33
|
+
:client_id)
|
34
|
+
include Aws::Structure
|
851
35
|
end
|
36
|
+
|
37
|
+
# Input to the CreateIdentityPool action.
|
38
|
+
#
|
39
|
+
# @note When making an API call, you may pass CreateIdentityPoolInput
|
40
|
+
# data as a hash:
|
41
|
+
#
|
42
|
+
# {
|
43
|
+
# identity_pool_name: "IdentityPoolName", # required
|
44
|
+
# allow_unauthenticated_identities: false, # required
|
45
|
+
# supported_login_providers: {
|
46
|
+
# "IdentityProviderName" => "IdentityProviderId",
|
47
|
+
# },
|
48
|
+
# developer_provider_name: "DeveloperProviderName",
|
49
|
+
# open_id_connect_provider_arns: ["ARNString"],
|
50
|
+
# cognito_identity_providers: [
|
51
|
+
# {
|
52
|
+
# provider_name: "CognitoIdentityProviderName",
|
53
|
+
# client_id: "CognitoIdentityProviderClientId",
|
54
|
+
# },
|
55
|
+
# ],
|
56
|
+
# saml_provider_arns: ["ARNString"],
|
57
|
+
# }
|
58
|
+
#
|
59
|
+
# @!attribute [rw] identity_pool_name
|
60
|
+
# A string that you provide.
|
61
|
+
# @return [String]
|
62
|
+
#
|
63
|
+
# @!attribute [rw] allow_unauthenticated_identities
|
64
|
+
# TRUE if the identity pool supports unauthenticated logins.
|
65
|
+
# @return [Boolean]
|
66
|
+
#
|
67
|
+
# @!attribute [rw] supported_login_providers
|
68
|
+
# Optional key:value pairs mapping provider names to provider app IDs.
|
69
|
+
# @return [Hash<String,String>]
|
70
|
+
#
|
71
|
+
# @!attribute [rw] developer_provider_name
|
72
|
+
# The "domain" by which Cognito will refer to your users. This name
|
73
|
+
# acts as a placeholder that allows your backend and the Cognito
|
74
|
+
# service to communicate about the developer provider. For the
|
75
|
+
# `DeveloperProviderName`, you can use letters as well as period
|
76
|
+
# (`.`), underscore (`_`), and dash (`-`).
|
77
|
+
#
|
78
|
+
# Once you have set a developer provider name, you cannot change it.
|
79
|
+
# Please take care in setting this parameter.
|
80
|
+
# @return [String]
|
81
|
+
#
|
82
|
+
# @!attribute [rw] open_id_connect_provider_arns
|
83
|
+
# A list of OpendID Connect provider ARNs.
|
84
|
+
# @return [Array<String>]
|
85
|
+
#
|
86
|
+
# @!attribute [rw] cognito_identity_providers
|
87
|
+
# An array of Amazon Cognito Identity user pools and their client IDs.
|
88
|
+
# @return [Array<Types::CognitoIdentityProvider>]
|
89
|
+
#
|
90
|
+
# @!attribute [rw] saml_provider_arns
|
91
|
+
# An array of Amazon Resource Names (ARNs) of the SAML provider for
|
92
|
+
# your identity pool.
|
93
|
+
# @return [Array<String>]
|
94
|
+
#
|
95
|
+
class CreateIdentityPoolInput < Struct.new(
|
96
|
+
:identity_pool_name,
|
97
|
+
:allow_unauthenticated_identities,
|
98
|
+
:supported_login_providers,
|
99
|
+
:developer_provider_name,
|
100
|
+
:open_id_connect_provider_arns,
|
101
|
+
:cognito_identity_providers,
|
102
|
+
:saml_provider_arns)
|
103
|
+
include Aws::Structure
|
104
|
+
end
|
105
|
+
|
106
|
+
# Credentials for the provided identity ID.
|
107
|
+
#
|
108
|
+
# @!attribute [rw] access_key_id
|
109
|
+
# The Access Key portion of the credentials.
|
110
|
+
# @return [String]
|
111
|
+
#
|
112
|
+
# @!attribute [rw] secret_key
|
113
|
+
# The Secret Access Key portion of the credentials
|
114
|
+
# @return [String]
|
115
|
+
#
|
116
|
+
# @!attribute [rw] session_token
|
117
|
+
# The Session Token portion of the credentials
|
118
|
+
# @return [String]
|
119
|
+
#
|
120
|
+
# @!attribute [rw] expiration
|
121
|
+
# The date at which these credentials will expire.
|
122
|
+
# @return [Time]
|
123
|
+
#
|
124
|
+
class Credentials < Struct.new(
|
125
|
+
:access_key_id,
|
126
|
+
:secret_key,
|
127
|
+
:session_token,
|
128
|
+
:expiration)
|
129
|
+
include Aws::Structure
|
130
|
+
end
|
131
|
+
|
132
|
+
# Input to the `DeleteIdentities` action.
|
133
|
+
#
|
134
|
+
# @note When making an API call, you may pass DeleteIdentitiesInput
|
135
|
+
# data as a hash:
|
136
|
+
#
|
137
|
+
# {
|
138
|
+
# identity_ids_to_delete: ["IdentityId"], # required
|
139
|
+
# }
|
140
|
+
#
|
141
|
+
# @!attribute [rw] identity_ids_to_delete
|
142
|
+
# A list of 1-60 identities that you want to delete.
|
143
|
+
# @return [Array<String>]
|
144
|
+
#
|
145
|
+
class DeleteIdentitiesInput < Struct.new(
|
146
|
+
:identity_ids_to_delete)
|
147
|
+
include Aws::Structure
|
148
|
+
end
|
149
|
+
|
150
|
+
# Returned in response to a successful `DeleteIdentities` operation.
|
151
|
+
#
|
152
|
+
# @!attribute [rw] unprocessed_identity_ids
|
153
|
+
# An array of UnprocessedIdentityId objects, each of which contains an
|
154
|
+
# ErrorCode and IdentityId.
|
155
|
+
# @return [Array<Types::UnprocessedIdentityId>]
|
156
|
+
#
|
157
|
+
class DeleteIdentitiesResponse < Struct.new(
|
158
|
+
:unprocessed_identity_ids)
|
159
|
+
include Aws::Structure
|
160
|
+
end
|
161
|
+
|
162
|
+
# Input to the DeleteIdentityPool action.
|
163
|
+
#
|
164
|
+
# @note When making an API call, you may pass DeleteIdentityPoolInput
|
165
|
+
# data as a hash:
|
166
|
+
#
|
167
|
+
# {
|
168
|
+
# identity_pool_id: "IdentityPoolId", # required
|
169
|
+
# }
|
170
|
+
#
|
171
|
+
# @!attribute [rw] identity_pool_id
|
172
|
+
# An identity pool ID in the format REGION:GUID.
|
173
|
+
# @return [String]
|
174
|
+
#
|
175
|
+
class DeleteIdentityPoolInput < Struct.new(
|
176
|
+
:identity_pool_id)
|
177
|
+
include Aws::Structure
|
178
|
+
end
|
179
|
+
|
180
|
+
# Input to the `DescribeIdentity` action.
|
181
|
+
#
|
182
|
+
# @note When making an API call, you may pass DescribeIdentityInput
|
183
|
+
# data as a hash:
|
184
|
+
#
|
185
|
+
# {
|
186
|
+
# identity_id: "IdentityId", # required
|
187
|
+
# }
|
188
|
+
#
|
189
|
+
# @!attribute [rw] identity_id
|
190
|
+
# A unique identifier in the format REGION:GUID.
|
191
|
+
# @return [String]
|
192
|
+
#
|
193
|
+
class DescribeIdentityInput < Struct.new(
|
194
|
+
:identity_id)
|
195
|
+
include Aws::Structure
|
196
|
+
end
|
197
|
+
|
198
|
+
# Input to the DescribeIdentityPool action.
|
199
|
+
#
|
200
|
+
# @note When making an API call, you may pass DescribeIdentityPoolInput
|
201
|
+
# data as a hash:
|
202
|
+
#
|
203
|
+
# {
|
204
|
+
# identity_pool_id: "IdentityPoolId", # required
|
205
|
+
# }
|
206
|
+
#
|
207
|
+
# @!attribute [rw] identity_pool_id
|
208
|
+
# An identity pool ID in the format REGION:GUID.
|
209
|
+
# @return [String]
|
210
|
+
#
|
211
|
+
class DescribeIdentityPoolInput < Struct.new(
|
212
|
+
:identity_pool_id)
|
213
|
+
include Aws::Structure
|
214
|
+
end
|
215
|
+
|
216
|
+
# Input to the `GetCredentialsForIdentity` action.
|
217
|
+
#
|
218
|
+
# @note When making an API call, you may pass GetCredentialsForIdentityInput
|
219
|
+
# data as a hash:
|
220
|
+
#
|
221
|
+
# {
|
222
|
+
# identity_id: "IdentityId", # required
|
223
|
+
# logins: {
|
224
|
+
# "IdentityProviderName" => "IdentityProviderToken",
|
225
|
+
# },
|
226
|
+
# custom_role_arn: "ARNString",
|
227
|
+
# }
|
228
|
+
#
|
229
|
+
# @!attribute [rw] identity_id
|
230
|
+
# A unique identifier in the format REGION:GUID.
|
231
|
+
# @return [String]
|
232
|
+
#
|
233
|
+
# @!attribute [rw] logins
|
234
|
+
# A set of optional name-value pairs that map provider names to
|
235
|
+
# provider tokens.
|
236
|
+
# @return [Hash<String,String>]
|
237
|
+
#
|
238
|
+
# @!attribute [rw] custom_role_arn
|
239
|
+
# The Amazon Resource Name (ARN) of the role to be assumed when
|
240
|
+
# multiple roles were received in the token from the identity
|
241
|
+
# provider. For example, a SAML-based identity provider. This
|
242
|
+
# parameter is optional for identity providers that do not support
|
243
|
+
# role customization.
|
244
|
+
# @return [String]
|
245
|
+
#
|
246
|
+
class GetCredentialsForIdentityInput < Struct.new(
|
247
|
+
:identity_id,
|
248
|
+
:logins,
|
249
|
+
:custom_role_arn)
|
250
|
+
include Aws::Structure
|
251
|
+
end
|
252
|
+
|
253
|
+
# Returned in response to a successful `GetCredentialsForIdentity`
|
254
|
+
# operation.
|
255
|
+
#
|
256
|
+
# @!attribute [rw] identity_id
|
257
|
+
# A unique identifier in the format REGION:GUID.
|
258
|
+
# @return [String]
|
259
|
+
#
|
260
|
+
# @!attribute [rw] credentials
|
261
|
+
# Credentials for the provided identity ID.
|
262
|
+
# @return [Types::Credentials]
|
263
|
+
#
|
264
|
+
class GetCredentialsForIdentityResponse < Struct.new(
|
265
|
+
:identity_id,
|
266
|
+
:credentials)
|
267
|
+
include Aws::Structure
|
268
|
+
end
|
269
|
+
|
270
|
+
# Input to the GetId action.
|
271
|
+
#
|
272
|
+
# @note When making an API call, you may pass GetIdInput
|
273
|
+
# data as a hash:
|
274
|
+
#
|
275
|
+
# {
|
276
|
+
# account_id: "AccountId",
|
277
|
+
# identity_pool_id: "IdentityPoolId", # required
|
278
|
+
# logins: {
|
279
|
+
# "IdentityProviderName" => "IdentityProviderToken",
|
280
|
+
# },
|
281
|
+
# }
|
282
|
+
#
|
283
|
+
# @!attribute [rw] account_id
|
284
|
+
# A standard AWS account ID (9+ digits).
|
285
|
+
# @return [String]
|
286
|
+
#
|
287
|
+
# @!attribute [rw] identity_pool_id
|
288
|
+
# An identity pool ID in the format REGION:GUID.
|
289
|
+
# @return [String]
|
290
|
+
#
|
291
|
+
# @!attribute [rw] logins
|
292
|
+
# A set of optional name-value pairs that map provider names to
|
293
|
+
# provider tokens. The available provider names for `Logins` are as
|
294
|
+
# follows:
|
295
|
+
#
|
296
|
+
# * Facebook: `graph.facebook.com`
|
297
|
+
#
|
298
|
+
# * Amazon Cognito Identity Provider:
|
299
|
+
# `cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789`
|
300
|
+
#
|
301
|
+
# * Google: `accounts.google.com`
|
302
|
+
#
|
303
|
+
# * Amazon: `www.amazon.com`
|
304
|
+
#
|
305
|
+
# * Twitter: `api.twitter.com`
|
306
|
+
#
|
307
|
+
# * Digits: `www.digits.com`
|
308
|
+
# @return [Hash<String,String>]
|
309
|
+
#
|
310
|
+
class GetIdInput < Struct.new(
|
311
|
+
:account_id,
|
312
|
+
:identity_pool_id,
|
313
|
+
:logins)
|
314
|
+
include Aws::Structure
|
315
|
+
end
|
316
|
+
|
317
|
+
# Returned in response to a GetId request.
|
318
|
+
#
|
319
|
+
# @!attribute [rw] identity_id
|
320
|
+
# A unique identifier in the format REGION:GUID.
|
321
|
+
# @return [String]
|
322
|
+
#
|
323
|
+
class GetIdResponse < Struct.new(
|
324
|
+
:identity_id)
|
325
|
+
include Aws::Structure
|
326
|
+
end
|
327
|
+
|
328
|
+
# Input to the `GetIdentityPoolRoles` action.
|
329
|
+
#
|
330
|
+
# @note When making an API call, you may pass GetIdentityPoolRolesInput
|
331
|
+
# data as a hash:
|
332
|
+
#
|
333
|
+
# {
|
334
|
+
# identity_pool_id: "IdentityPoolId", # required
|
335
|
+
# }
|
336
|
+
#
|
337
|
+
# @!attribute [rw] identity_pool_id
|
338
|
+
# An identity pool ID in the format REGION:GUID.
|
339
|
+
# @return [String]
|
340
|
+
#
|
341
|
+
class GetIdentityPoolRolesInput < Struct.new(
|
342
|
+
:identity_pool_id)
|
343
|
+
include Aws::Structure
|
344
|
+
end
|
345
|
+
|
346
|
+
# Returned in response to a successful `GetIdentityPoolRoles` operation.
|
347
|
+
#
|
348
|
+
# @!attribute [rw] identity_pool_id
|
349
|
+
# An identity pool ID in the format REGION:GUID.
|
350
|
+
# @return [String]
|
351
|
+
#
|
352
|
+
# @!attribute [rw] roles
|
353
|
+
# The map of roles associated with this pool. Currently only
|
354
|
+
# authenticated and unauthenticated roles are supported.
|
355
|
+
# @return [Hash<String,String>]
|
356
|
+
#
|
357
|
+
# @!attribute [rw] role_mappings
|
358
|
+
# How users for a specific identity provider are to mapped to roles.
|
359
|
+
# This is a String-to-RoleMapping object map. The string identifies
|
360
|
+
# the identity provider, for example, "graph.facebook.com" or
|
361
|
+
# "cognito-idp-east-1.amazonaws.com/us-east-1\_abcdefghi:app\_client\_id".
|
362
|
+
# @return [Hash<String,Types::RoleMapping>]
|
363
|
+
#
|
364
|
+
class GetIdentityPoolRolesResponse < Struct.new(
|
365
|
+
:identity_pool_id,
|
366
|
+
:roles,
|
367
|
+
:role_mappings)
|
368
|
+
include Aws::Structure
|
369
|
+
end
|
370
|
+
|
371
|
+
# Input to the `GetOpenIdTokenForDeveloperIdentity` action.
|
372
|
+
#
|
373
|
+
# @note When making an API call, you may pass GetOpenIdTokenForDeveloperIdentityInput
|
374
|
+
# data as a hash:
|
375
|
+
#
|
376
|
+
# {
|
377
|
+
# identity_pool_id: "IdentityPoolId", # required
|
378
|
+
# identity_id: "IdentityId",
|
379
|
+
# logins: { # required
|
380
|
+
# "IdentityProviderName" => "IdentityProviderToken",
|
381
|
+
# },
|
382
|
+
# token_duration: 1,
|
383
|
+
# }
|
384
|
+
#
|
385
|
+
# @!attribute [rw] identity_pool_id
|
386
|
+
# An identity pool ID in the format REGION:GUID.
|
387
|
+
# @return [String]
|
388
|
+
#
|
389
|
+
# @!attribute [rw] identity_id
|
390
|
+
# A unique identifier in the format REGION:GUID.
|
391
|
+
# @return [String]
|
392
|
+
#
|
393
|
+
# @!attribute [rw] logins
|
394
|
+
# A set of optional name-value pairs that map provider names to
|
395
|
+
# provider tokens. Each name-value pair represents a user from a
|
396
|
+
# public provider or developer provider. If the user is from a
|
397
|
+
# developer provider, the name-value pair will follow the syntax
|
398
|
+
# `"developer_provider_name": "developer_user_identifier"`. The
|
399
|
+
# developer provider is the "domain" by which Cognito will refer to
|
400
|
+
# your users; you provided this domain while creating/updating the
|
401
|
+
# identity pool. The developer user identifier is an identifier from
|
402
|
+
# your backend that uniquely identifies a user. When you create an
|
403
|
+
# identity pool, you can specify the supported logins.
|
404
|
+
# @return [Hash<String,String>]
|
405
|
+
#
|
406
|
+
# @!attribute [rw] token_duration
|
407
|
+
# The expiration time of the token, in seconds. You can specify a
|
408
|
+
# custom expiration time for the token so that you can cache it. If
|
409
|
+
# you don't provide an expiration time, the token is valid for 15
|
410
|
+
# minutes. You can exchange the token with Amazon STS for temporary
|
411
|
+
# AWS credentials, which are valid for a maximum of one hour. The
|
412
|
+
# maximum token duration you can set is 24 hours. You should take care
|
413
|
+
# in setting the expiration time for a token, as there are significant
|
414
|
+
# security implications: an attacker could use a leaked token to
|
415
|
+
# access your AWS resources for the token's duration.
|
416
|
+
# @return [Integer]
|
417
|
+
#
|
418
|
+
class GetOpenIdTokenForDeveloperIdentityInput < Struct.new(
|
419
|
+
:identity_pool_id,
|
420
|
+
:identity_id,
|
421
|
+
:logins,
|
422
|
+
:token_duration)
|
423
|
+
include Aws::Structure
|
424
|
+
end
|
425
|
+
|
426
|
+
# Returned in response to a successful
|
427
|
+
# `GetOpenIdTokenForDeveloperIdentity` request.
|
428
|
+
#
|
429
|
+
# @!attribute [rw] identity_id
|
430
|
+
# A unique identifier in the format REGION:GUID.
|
431
|
+
# @return [String]
|
432
|
+
#
|
433
|
+
# @!attribute [rw] token
|
434
|
+
# An OpenID token.
|
435
|
+
# @return [String]
|
436
|
+
#
|
437
|
+
class GetOpenIdTokenForDeveloperIdentityResponse < Struct.new(
|
438
|
+
:identity_id,
|
439
|
+
:token)
|
440
|
+
include Aws::Structure
|
441
|
+
end
|
442
|
+
|
443
|
+
# Input to the GetOpenIdToken action.
|
444
|
+
#
|
445
|
+
# @note When making an API call, you may pass GetOpenIdTokenInput
|
446
|
+
# data as a hash:
|
447
|
+
#
|
448
|
+
# {
|
449
|
+
# identity_id: "IdentityId", # required
|
450
|
+
# logins: {
|
451
|
+
# "IdentityProviderName" => "IdentityProviderToken",
|
452
|
+
# },
|
453
|
+
# }
|
454
|
+
#
|
455
|
+
# @!attribute [rw] identity_id
|
456
|
+
# A unique identifier in the format REGION:GUID.
|
457
|
+
# @return [String]
|
458
|
+
#
|
459
|
+
# @!attribute [rw] logins
|
460
|
+
# A set of optional name-value pairs that map provider names to
|
461
|
+
# provider tokens. When using graph.facebook.com and www.amazon.com,
|
462
|
+
# supply the access\_token returned from the provider's authflow. For
|
463
|
+
# accounts.google.com, an Amazon Cognito Identity Provider, or any
|
464
|
+
# other OpenId Connect provider, always include the `id_token`.
|
465
|
+
# @return [Hash<String,String>]
|
466
|
+
#
|
467
|
+
class GetOpenIdTokenInput < Struct.new(
|
468
|
+
:identity_id,
|
469
|
+
:logins)
|
470
|
+
include Aws::Structure
|
471
|
+
end
|
472
|
+
|
473
|
+
# Returned in response to a successful GetOpenIdToken request.
|
474
|
+
#
|
475
|
+
# @!attribute [rw] identity_id
|
476
|
+
# A unique identifier in the format REGION:GUID. Note that the
|
477
|
+
# IdentityId returned may not match the one passed on input.
|
478
|
+
# @return [String]
|
479
|
+
#
|
480
|
+
# @!attribute [rw] token
|
481
|
+
# An OpenID token, valid for 15 minutes.
|
482
|
+
# @return [String]
|
483
|
+
#
|
484
|
+
class GetOpenIdTokenResponse < Struct.new(
|
485
|
+
:identity_id,
|
486
|
+
:token)
|
487
|
+
include Aws::Structure
|
488
|
+
end
|
489
|
+
|
490
|
+
# A description of the identity.
|
491
|
+
#
|
492
|
+
# @!attribute [rw] identity_id
|
493
|
+
# A unique identifier in the format REGION:GUID.
|
494
|
+
# @return [String]
|
495
|
+
#
|
496
|
+
# @!attribute [rw] logins
|
497
|
+
# A set of optional name-value pairs that map provider names to
|
498
|
+
# provider tokens.
|
499
|
+
# @return [Array<String>]
|
500
|
+
#
|
501
|
+
# @!attribute [rw] creation_date
|
502
|
+
# Date on which the identity was created.
|
503
|
+
# @return [Time]
|
504
|
+
#
|
505
|
+
# @!attribute [rw] last_modified_date
|
506
|
+
# Date on which the identity was last modified.
|
507
|
+
# @return [Time]
|
508
|
+
#
|
509
|
+
class IdentityDescription < Struct.new(
|
510
|
+
:identity_id,
|
511
|
+
:logins,
|
512
|
+
:creation_date,
|
513
|
+
:last_modified_date)
|
514
|
+
include Aws::Structure
|
515
|
+
end
|
516
|
+
|
517
|
+
# An object representing an Amazon Cognito identity pool.
|
518
|
+
#
|
519
|
+
# @note When making an API call, you may pass IdentityPool
|
520
|
+
# data as a hash:
|
521
|
+
#
|
522
|
+
# {
|
523
|
+
# identity_pool_id: "IdentityPoolId", # required
|
524
|
+
# identity_pool_name: "IdentityPoolName", # required
|
525
|
+
# allow_unauthenticated_identities: false, # required
|
526
|
+
# supported_login_providers: {
|
527
|
+
# "IdentityProviderName" => "IdentityProviderId",
|
528
|
+
# },
|
529
|
+
# developer_provider_name: "DeveloperProviderName",
|
530
|
+
# open_id_connect_provider_arns: ["ARNString"],
|
531
|
+
# cognito_identity_providers: [
|
532
|
+
# {
|
533
|
+
# provider_name: "CognitoIdentityProviderName",
|
534
|
+
# client_id: "CognitoIdentityProviderClientId",
|
535
|
+
# },
|
536
|
+
# ],
|
537
|
+
# saml_provider_arns: ["ARNString"],
|
538
|
+
# }
|
539
|
+
#
|
540
|
+
# @!attribute [rw] identity_pool_id
|
541
|
+
# An identity pool ID in the format REGION:GUID.
|
542
|
+
# @return [String]
|
543
|
+
#
|
544
|
+
# @!attribute [rw] identity_pool_name
|
545
|
+
# A string that you provide.
|
546
|
+
# @return [String]
|
547
|
+
#
|
548
|
+
# @!attribute [rw] allow_unauthenticated_identities
|
549
|
+
# TRUE if the identity pool supports unauthenticated logins.
|
550
|
+
# @return [Boolean]
|
551
|
+
#
|
552
|
+
# @!attribute [rw] supported_login_providers
|
553
|
+
# Optional key:value pairs mapping provider names to provider app IDs.
|
554
|
+
# @return [Hash<String,String>]
|
555
|
+
#
|
556
|
+
# @!attribute [rw] developer_provider_name
|
557
|
+
# The "domain" by which Cognito will refer to your users.
|
558
|
+
# @return [String]
|
559
|
+
#
|
560
|
+
# @!attribute [rw] open_id_connect_provider_arns
|
561
|
+
# A list of OpendID Connect provider ARNs.
|
562
|
+
# @return [Array<String>]
|
563
|
+
#
|
564
|
+
# @!attribute [rw] cognito_identity_providers
|
565
|
+
# A list representing an Amazon Cognito Identity User Pool and its
|
566
|
+
# client ID.
|
567
|
+
# @return [Array<Types::CognitoIdentityProvider>]
|
568
|
+
#
|
569
|
+
# @!attribute [rw] saml_provider_arns
|
570
|
+
# An array of Amazon Resource Names (ARNs) of the SAML provider for
|
571
|
+
# your identity pool.
|
572
|
+
# @return [Array<String>]
|
573
|
+
#
|
574
|
+
class IdentityPool < Struct.new(
|
575
|
+
:identity_pool_id,
|
576
|
+
:identity_pool_name,
|
577
|
+
:allow_unauthenticated_identities,
|
578
|
+
:supported_login_providers,
|
579
|
+
:developer_provider_name,
|
580
|
+
:open_id_connect_provider_arns,
|
581
|
+
:cognito_identity_providers,
|
582
|
+
:saml_provider_arns)
|
583
|
+
include Aws::Structure
|
584
|
+
end
|
585
|
+
|
586
|
+
# A description of the identity pool.
|
587
|
+
#
|
588
|
+
# @!attribute [rw] identity_pool_id
|
589
|
+
# An identity pool ID in the format REGION:GUID.
|
590
|
+
# @return [String]
|
591
|
+
#
|
592
|
+
# @!attribute [rw] identity_pool_name
|
593
|
+
# A string that you provide.
|
594
|
+
# @return [String]
|
595
|
+
#
|
596
|
+
class IdentityPoolShortDescription < Struct.new(
|
597
|
+
:identity_pool_id,
|
598
|
+
:identity_pool_name)
|
599
|
+
include Aws::Structure
|
600
|
+
end
|
601
|
+
|
602
|
+
# Input to the ListIdentities action.
|
603
|
+
#
|
604
|
+
# @note When making an API call, you may pass ListIdentitiesInput
|
605
|
+
# data as a hash:
|
606
|
+
#
|
607
|
+
# {
|
608
|
+
# identity_pool_id: "IdentityPoolId", # required
|
609
|
+
# max_results: 1, # required
|
610
|
+
# next_token: "PaginationKey",
|
611
|
+
# hide_disabled: false,
|
612
|
+
# }
|
613
|
+
#
|
614
|
+
# @!attribute [rw] identity_pool_id
|
615
|
+
# An identity pool ID in the format REGION:GUID.
|
616
|
+
# @return [String]
|
617
|
+
#
|
618
|
+
# @!attribute [rw] max_results
|
619
|
+
# The maximum number of identities to return.
|
620
|
+
# @return [Integer]
|
621
|
+
#
|
622
|
+
# @!attribute [rw] next_token
|
623
|
+
# A pagination token.
|
624
|
+
# @return [String]
|
625
|
+
#
|
626
|
+
# @!attribute [rw] hide_disabled
|
627
|
+
# An optional boolean parameter that allows you to hide disabled
|
628
|
+
# identities. If omitted, the ListIdentities API will include disabled
|
629
|
+
# identities in the response.
|
630
|
+
# @return [Boolean]
|
631
|
+
#
|
632
|
+
class ListIdentitiesInput < Struct.new(
|
633
|
+
:identity_pool_id,
|
634
|
+
:max_results,
|
635
|
+
:next_token,
|
636
|
+
:hide_disabled)
|
637
|
+
include Aws::Structure
|
638
|
+
end
|
639
|
+
|
640
|
+
# The response to a ListIdentities request.
|
641
|
+
#
|
642
|
+
# @!attribute [rw] identity_pool_id
|
643
|
+
# An identity pool ID in the format REGION:GUID.
|
644
|
+
# @return [String]
|
645
|
+
#
|
646
|
+
# @!attribute [rw] identities
|
647
|
+
# An object containing a set of identities and associated mappings.
|
648
|
+
# @return [Array<Types::IdentityDescription>]
|
649
|
+
#
|
650
|
+
# @!attribute [rw] next_token
|
651
|
+
# A pagination token.
|
652
|
+
# @return [String]
|
653
|
+
#
|
654
|
+
class ListIdentitiesResponse < Struct.new(
|
655
|
+
:identity_pool_id,
|
656
|
+
:identities,
|
657
|
+
:next_token)
|
658
|
+
include Aws::Structure
|
659
|
+
end
|
660
|
+
|
661
|
+
# Input to the ListIdentityPools action.
|
662
|
+
#
|
663
|
+
# @note When making an API call, you may pass ListIdentityPoolsInput
|
664
|
+
# data as a hash:
|
665
|
+
#
|
666
|
+
# {
|
667
|
+
# max_results: 1, # required
|
668
|
+
# next_token: "PaginationKey",
|
669
|
+
# }
|
670
|
+
#
|
671
|
+
# @!attribute [rw] max_results
|
672
|
+
# The maximum number of identities to return.
|
673
|
+
# @return [Integer]
|
674
|
+
#
|
675
|
+
# @!attribute [rw] next_token
|
676
|
+
# A pagination token.
|
677
|
+
# @return [String]
|
678
|
+
#
|
679
|
+
class ListIdentityPoolsInput < Struct.new(
|
680
|
+
:max_results,
|
681
|
+
:next_token)
|
682
|
+
include Aws::Structure
|
683
|
+
end
|
684
|
+
|
685
|
+
# The result of a successful ListIdentityPools action.
|
686
|
+
#
|
687
|
+
# @!attribute [rw] identity_pools
|
688
|
+
# The identity pools returned by the ListIdentityPools action.
|
689
|
+
# @return [Array<Types::IdentityPoolShortDescription>]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] next_token
|
692
|
+
# A pagination token.
|
693
|
+
# @return [String]
|
694
|
+
#
|
695
|
+
class ListIdentityPoolsResponse < Struct.new(
|
696
|
+
:identity_pools,
|
697
|
+
:next_token)
|
698
|
+
include Aws::Structure
|
699
|
+
end
|
700
|
+
|
701
|
+
# Input to the `LookupDeveloperIdentityInput` action.
|
702
|
+
#
|
703
|
+
# @note When making an API call, you may pass LookupDeveloperIdentityInput
|
704
|
+
# data as a hash:
|
705
|
+
#
|
706
|
+
# {
|
707
|
+
# identity_pool_id: "IdentityPoolId", # required
|
708
|
+
# identity_id: "IdentityId",
|
709
|
+
# developer_user_identifier: "DeveloperUserIdentifier",
|
710
|
+
# max_results: 1,
|
711
|
+
# next_token: "PaginationKey",
|
712
|
+
# }
|
713
|
+
#
|
714
|
+
# @!attribute [rw] identity_pool_id
|
715
|
+
# An identity pool ID in the format REGION:GUID.
|
716
|
+
# @return [String]
|
717
|
+
#
|
718
|
+
# @!attribute [rw] identity_id
|
719
|
+
# A unique identifier in the format REGION:GUID.
|
720
|
+
# @return [String]
|
721
|
+
#
|
722
|
+
# @!attribute [rw] developer_user_identifier
|
723
|
+
# A unique ID used by your backend authentication process to identify
|
724
|
+
# a user. Typically, a developer identity provider would issue many
|
725
|
+
# developer user identifiers, in keeping with the number of users.
|
726
|
+
# @return [String]
|
727
|
+
#
|
728
|
+
# @!attribute [rw] max_results
|
729
|
+
# The maximum number of identities to return.
|
730
|
+
# @return [Integer]
|
731
|
+
#
|
732
|
+
# @!attribute [rw] next_token
|
733
|
+
# A pagination token. The first call you make will have `NextToken`
|
734
|
+
# set to null. After that the service will return `NextToken` values
|
735
|
+
# as needed. For example, let's say you make a request with
|
736
|
+
# `MaxResults` set to 10, and there are 20 matches in the database.
|
737
|
+
# The service will return a pagination token as a part of the
|
738
|
+
# response. This token can be used to call the API again and get
|
739
|
+
# results starting from the 11th match.
|
740
|
+
# @return [String]
|
741
|
+
#
|
742
|
+
class LookupDeveloperIdentityInput < Struct.new(
|
743
|
+
:identity_pool_id,
|
744
|
+
:identity_id,
|
745
|
+
:developer_user_identifier,
|
746
|
+
:max_results,
|
747
|
+
:next_token)
|
748
|
+
include Aws::Structure
|
749
|
+
end
|
750
|
+
|
751
|
+
# Returned in response to a successful `LookupDeveloperIdentity` action.
|
752
|
+
#
|
753
|
+
# @!attribute [rw] identity_id
|
754
|
+
# A unique identifier in the format REGION:GUID.
|
755
|
+
# @return [String]
|
756
|
+
#
|
757
|
+
# @!attribute [rw] developer_user_identifier_list
|
758
|
+
# This is the list of developer user identifiers associated with an
|
759
|
+
# identity ID. Cognito supports the association of multiple developer
|
760
|
+
# user identifiers with an identity ID.
|
761
|
+
# @return [Array<String>]
|
762
|
+
#
|
763
|
+
# @!attribute [rw] next_token
|
764
|
+
# A pagination token. The first call you make will have `NextToken`
|
765
|
+
# set to null. After that the service will return `NextToken` values
|
766
|
+
# as needed. For example, let's say you make a request with
|
767
|
+
# `MaxResults` set to 10, and there are 20 matches in the database.
|
768
|
+
# The service will return a pagination token as a part of the
|
769
|
+
# response. This token can be used to call the API again and get
|
770
|
+
# results starting from the 11th match.
|
771
|
+
# @return [String]
|
772
|
+
#
|
773
|
+
class LookupDeveloperIdentityResponse < Struct.new(
|
774
|
+
:identity_id,
|
775
|
+
:developer_user_identifier_list,
|
776
|
+
:next_token)
|
777
|
+
include Aws::Structure
|
778
|
+
end
|
779
|
+
|
780
|
+
# A rule that maps a claim name, a claim value, and a match type to a
|
781
|
+
# role ARN.
|
782
|
+
#
|
783
|
+
# @note When making an API call, you may pass MappingRule
|
784
|
+
# data as a hash:
|
785
|
+
#
|
786
|
+
# {
|
787
|
+
# claim: "ClaimName", # required
|
788
|
+
# match_type: "Equals", # required, accepts Equals, Contains, StartsWith, NotEqual
|
789
|
+
# value: "ClaimValue", # required
|
790
|
+
# role_arn: "ARNString", # required
|
791
|
+
# }
|
792
|
+
#
|
793
|
+
# @!attribute [rw] claim
|
794
|
+
# The claim name that must be present in the token, for example,
|
795
|
+
# "isAdmin" or "paid".
|
796
|
+
# @return [String]
|
797
|
+
#
|
798
|
+
# @!attribute [rw] match_type
|
799
|
+
# The match condition that specifies how closely the claim value in
|
800
|
+
# the IdP token must match `Value`.
|
801
|
+
# @return [String]
|
802
|
+
#
|
803
|
+
# @!attribute [rw] value
|
804
|
+
# A brief string that the claim must match, for example, "paid" or
|
805
|
+
# "yes".
|
806
|
+
# @return [String]
|
807
|
+
#
|
808
|
+
# @!attribute [rw] role_arn
|
809
|
+
# The role ARN.
|
810
|
+
# @return [String]
|
811
|
+
#
|
812
|
+
class MappingRule < Struct.new(
|
813
|
+
:claim,
|
814
|
+
:match_type,
|
815
|
+
:value,
|
816
|
+
:role_arn)
|
817
|
+
include Aws::Structure
|
818
|
+
end
|
819
|
+
|
820
|
+
# Input to the `MergeDeveloperIdentities` action.
|
821
|
+
#
|
822
|
+
# @note When making an API call, you may pass MergeDeveloperIdentitiesInput
|
823
|
+
# data as a hash:
|
824
|
+
#
|
825
|
+
# {
|
826
|
+
# source_user_identifier: "DeveloperUserIdentifier", # required
|
827
|
+
# destination_user_identifier: "DeveloperUserIdentifier", # required
|
828
|
+
# developer_provider_name: "DeveloperProviderName", # required
|
829
|
+
# identity_pool_id: "IdentityPoolId", # required
|
830
|
+
# }
|
831
|
+
#
|
832
|
+
# @!attribute [rw] source_user_identifier
|
833
|
+
# User identifier for the source user. The value should be a
|
834
|
+
# `DeveloperUserIdentifier`.
|
835
|
+
# @return [String]
|
836
|
+
#
|
837
|
+
# @!attribute [rw] destination_user_identifier
|
838
|
+
# User identifier for the destination user. The value should be a
|
839
|
+
# `DeveloperUserIdentifier`.
|
840
|
+
# @return [String]
|
841
|
+
#
|
842
|
+
# @!attribute [rw] developer_provider_name
|
843
|
+
# The "domain" by which Cognito will refer to your users. This is a
|
844
|
+
# (pseudo) domain name that you provide while creating an identity
|
845
|
+
# pool. This name acts as a placeholder that allows your backend and
|
846
|
+
# the Cognito service to communicate about the developer provider. For
|
847
|
+
# the `DeveloperProviderName`, you can use letters as well as period
|
848
|
+
# (.), underscore (\_), and dash (-).
|
849
|
+
# @return [String]
|
850
|
+
#
|
851
|
+
# @!attribute [rw] identity_pool_id
|
852
|
+
# An identity pool ID in the format REGION:GUID.
|
853
|
+
# @return [String]
|
854
|
+
#
|
855
|
+
class MergeDeveloperIdentitiesInput < Struct.new(
|
856
|
+
:source_user_identifier,
|
857
|
+
:destination_user_identifier,
|
858
|
+
:developer_provider_name,
|
859
|
+
:identity_pool_id)
|
860
|
+
include Aws::Structure
|
861
|
+
end
|
862
|
+
|
863
|
+
# Returned in response to a successful `MergeDeveloperIdentities`
|
864
|
+
# action.
|
865
|
+
#
|
866
|
+
# @!attribute [rw] identity_id
|
867
|
+
# A unique identifier in the format REGION:GUID.
|
868
|
+
# @return [String]
|
869
|
+
#
|
870
|
+
class MergeDeveloperIdentitiesResponse < Struct.new(
|
871
|
+
:identity_id)
|
872
|
+
include Aws::Structure
|
873
|
+
end
|
874
|
+
|
875
|
+
# A role mapping.
|
876
|
+
#
|
877
|
+
# @note When making an API call, you may pass RoleMapping
|
878
|
+
# data as a hash:
|
879
|
+
#
|
880
|
+
# {
|
881
|
+
# type: "Token", # required, accepts Token, Rules
|
882
|
+
# ambiguous_role_resolution: "AuthenticatedRole", # accepts AuthenticatedRole, Deny
|
883
|
+
# rules_configuration: {
|
884
|
+
# rules: [ # required
|
885
|
+
# {
|
886
|
+
# claim: "ClaimName", # required
|
887
|
+
# match_type: "Equals", # required, accepts Equals, Contains, StartsWith, NotEqual
|
888
|
+
# value: "ClaimValue", # required
|
889
|
+
# role_arn: "ARNString", # required
|
890
|
+
# },
|
891
|
+
# ],
|
892
|
+
# },
|
893
|
+
# }
|
894
|
+
#
|
895
|
+
# @!attribute [rw] type
|
896
|
+
# The role mapping type. Token will use `cognito:roles` and
|
897
|
+
# `cognito:preferred_role` claims from the Cognito identity provider
|
898
|
+
# token to map groups to roles. Rules will attempt to match claims
|
899
|
+
# from the token to map to a role.
|
900
|
+
# @return [String]
|
901
|
+
#
|
902
|
+
# @!attribute [rw] ambiguous_role_resolution
|
903
|
+
# If you specify Token or Rules as the `Type`,
|
904
|
+
# `AmbiguousRoleResolution` is required.
|
905
|
+
#
|
906
|
+
# Specifies the action to be taken if either no rules match the claim
|
907
|
+
# value for the `Rules` type, or there is no `cognito:preferred_role`
|
908
|
+
# claim and there are multiple `cognito:roles` matches for the `Token`
|
909
|
+
# type.
|
910
|
+
# @return [String]
|
911
|
+
#
|
912
|
+
# @!attribute [rw] rules_configuration
|
913
|
+
# The rules to be used for mapping users to roles.
|
914
|
+
#
|
915
|
+
# If you specify Rules as the role mapping type, `RulesConfiguration`
|
916
|
+
# is required.
|
917
|
+
# @return [Types::RulesConfigurationType]
|
918
|
+
#
|
919
|
+
class RoleMapping < Struct.new(
|
920
|
+
:type,
|
921
|
+
:ambiguous_role_resolution,
|
922
|
+
:rules_configuration)
|
923
|
+
include Aws::Structure
|
924
|
+
end
|
925
|
+
|
926
|
+
# A container for rules.
|
927
|
+
#
|
928
|
+
# @note When making an API call, you may pass RulesConfigurationType
|
929
|
+
# data as a hash:
|
930
|
+
#
|
931
|
+
# {
|
932
|
+
# rules: [ # required
|
933
|
+
# {
|
934
|
+
# claim: "ClaimName", # required
|
935
|
+
# match_type: "Equals", # required, accepts Equals, Contains, StartsWith, NotEqual
|
936
|
+
# value: "ClaimValue", # required
|
937
|
+
# role_arn: "ARNString", # required
|
938
|
+
# },
|
939
|
+
# ],
|
940
|
+
# }
|
941
|
+
#
|
942
|
+
# @!attribute [rw] rules
|
943
|
+
# An array of rules. You can specify up to 25 rules per identity
|
944
|
+
# provider.
|
945
|
+
#
|
946
|
+
# Rules are evaluated in order. The first one to match specifies the
|
947
|
+
# role.
|
948
|
+
# @return [Array<Types::MappingRule>]
|
949
|
+
#
|
950
|
+
class RulesConfigurationType < Struct.new(
|
951
|
+
:rules)
|
952
|
+
include Aws::Structure
|
953
|
+
end
|
954
|
+
|
955
|
+
# Input to the `SetIdentityPoolRoles` action.
|
956
|
+
#
|
957
|
+
# @note When making an API call, you may pass SetIdentityPoolRolesInput
|
958
|
+
# data as a hash:
|
959
|
+
#
|
960
|
+
# {
|
961
|
+
# identity_pool_id: "IdentityPoolId", # required
|
962
|
+
# roles: { # required
|
963
|
+
# "RoleType" => "ARNString",
|
964
|
+
# },
|
965
|
+
# role_mappings: {
|
966
|
+
# "IdentityProviderName" => {
|
967
|
+
# type: "Token", # required, accepts Token, Rules
|
968
|
+
# ambiguous_role_resolution: "AuthenticatedRole", # accepts AuthenticatedRole, Deny
|
969
|
+
# rules_configuration: {
|
970
|
+
# rules: [ # required
|
971
|
+
# {
|
972
|
+
# claim: "ClaimName", # required
|
973
|
+
# match_type: "Equals", # required, accepts Equals, Contains, StartsWith, NotEqual
|
974
|
+
# value: "ClaimValue", # required
|
975
|
+
# role_arn: "ARNString", # required
|
976
|
+
# },
|
977
|
+
# ],
|
978
|
+
# },
|
979
|
+
# },
|
980
|
+
# },
|
981
|
+
# }
|
982
|
+
#
|
983
|
+
# @!attribute [rw] identity_pool_id
|
984
|
+
# An identity pool ID in the format REGION:GUID.
|
985
|
+
# @return [String]
|
986
|
+
#
|
987
|
+
# @!attribute [rw] roles
|
988
|
+
# The map of roles associated with this pool. For a given role, the
|
989
|
+
# key will be either "authenticated" or "unauthenticated" and the
|
990
|
+
# value will be the Role ARN.
|
991
|
+
# @return [Hash<String,String>]
|
992
|
+
#
|
993
|
+
# @!attribute [rw] role_mappings
|
994
|
+
# How users for a specific identity provider are to mapped to roles.
|
995
|
+
# This is a string to RoleMapping object map. The string identifies
|
996
|
+
# the identity provider, for example, "graph.facebook.com" or
|
997
|
+
# "cognito-idp-east-1.amazonaws.com/us-east-1\_abcdefghi:app\_client\_id".
|
998
|
+
#
|
999
|
+
# Up to 25 rules can be specified per identity provider.
|
1000
|
+
# @return [Hash<String,Types::RoleMapping>]
|
1001
|
+
#
|
1002
|
+
class SetIdentityPoolRolesInput < Struct.new(
|
1003
|
+
:identity_pool_id,
|
1004
|
+
:roles,
|
1005
|
+
:role_mappings)
|
1006
|
+
include Aws::Structure
|
1007
|
+
end
|
1008
|
+
|
1009
|
+
# Input to the `UnlinkDeveloperIdentity` action.
|
1010
|
+
#
|
1011
|
+
# @note When making an API call, you may pass UnlinkDeveloperIdentityInput
|
1012
|
+
# data as a hash:
|
1013
|
+
#
|
1014
|
+
# {
|
1015
|
+
# identity_id: "IdentityId", # required
|
1016
|
+
# identity_pool_id: "IdentityPoolId", # required
|
1017
|
+
# developer_provider_name: "DeveloperProviderName", # required
|
1018
|
+
# developer_user_identifier: "DeveloperUserIdentifier", # required
|
1019
|
+
# }
|
1020
|
+
#
|
1021
|
+
# @!attribute [rw] identity_id
|
1022
|
+
# A unique identifier in the format REGION:GUID.
|
1023
|
+
# @return [String]
|
1024
|
+
#
|
1025
|
+
# @!attribute [rw] identity_pool_id
|
1026
|
+
# An identity pool ID in the format REGION:GUID.
|
1027
|
+
# @return [String]
|
1028
|
+
#
|
1029
|
+
# @!attribute [rw] developer_provider_name
|
1030
|
+
# The "domain" by which Cognito will refer to your users.
|
1031
|
+
# @return [String]
|
1032
|
+
#
|
1033
|
+
# @!attribute [rw] developer_user_identifier
|
1034
|
+
# A unique ID used by your backend authentication process to identify
|
1035
|
+
# a user.
|
1036
|
+
# @return [String]
|
1037
|
+
#
|
1038
|
+
class UnlinkDeveloperIdentityInput < Struct.new(
|
1039
|
+
:identity_id,
|
1040
|
+
:identity_pool_id,
|
1041
|
+
:developer_provider_name,
|
1042
|
+
:developer_user_identifier)
|
1043
|
+
include Aws::Structure
|
1044
|
+
end
|
1045
|
+
|
1046
|
+
# Input to the UnlinkIdentity action.
|
1047
|
+
#
|
1048
|
+
# @note When making an API call, you may pass UnlinkIdentityInput
|
1049
|
+
# data as a hash:
|
1050
|
+
#
|
1051
|
+
# {
|
1052
|
+
# identity_id: "IdentityId", # required
|
1053
|
+
# logins: { # required
|
1054
|
+
# "IdentityProviderName" => "IdentityProviderToken",
|
1055
|
+
# },
|
1056
|
+
# logins_to_remove: ["IdentityProviderName"], # required
|
1057
|
+
# }
|
1058
|
+
#
|
1059
|
+
# @!attribute [rw] identity_id
|
1060
|
+
# A unique identifier in the format REGION:GUID.
|
1061
|
+
# @return [String]
|
1062
|
+
#
|
1063
|
+
# @!attribute [rw] logins
|
1064
|
+
# A set of optional name-value pairs that map provider names to
|
1065
|
+
# provider tokens.
|
1066
|
+
# @return [Hash<String,String>]
|
1067
|
+
#
|
1068
|
+
# @!attribute [rw] logins_to_remove
|
1069
|
+
# Provider names to unlink from this identity.
|
1070
|
+
# @return [Array<String>]
|
1071
|
+
#
|
1072
|
+
class UnlinkIdentityInput < Struct.new(
|
1073
|
+
:identity_id,
|
1074
|
+
:logins,
|
1075
|
+
:logins_to_remove)
|
1076
|
+
include Aws::Structure
|
1077
|
+
end
|
1078
|
+
|
1079
|
+
# An array of UnprocessedIdentityId objects, each of which contains an
|
1080
|
+
# ErrorCode and IdentityId.
|
1081
|
+
#
|
1082
|
+
# @!attribute [rw] identity_id
|
1083
|
+
# A unique identifier in the format REGION:GUID.
|
1084
|
+
# @return [String]
|
1085
|
+
#
|
1086
|
+
# @!attribute [rw] error_code
|
1087
|
+
# The error code indicating the type of error that occurred.
|
1088
|
+
# @return [String]
|
1089
|
+
#
|
1090
|
+
class UnprocessedIdentityId < Struct.new(
|
1091
|
+
:identity_id,
|
1092
|
+
:error_code)
|
1093
|
+
include Aws::Structure
|
1094
|
+
end
|
1095
|
+
|
852
1096
|
end
|
853
1097
|
end
|