aws-sdk-identitystore 1.17.0 → 1.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -31,6 +31,569 @@ module Aws::IdentityStore
31
31
  include Aws::Structure
32
32
  end
33
33
 
34
+ # The address associated with the specified user.
35
+ #
36
+ # @note When making an API call, you may pass Address
37
+ # data as a hash:
38
+ #
39
+ # {
40
+ # street_address: "SensitiveStringType",
41
+ # locality: "SensitiveStringType",
42
+ # region: "SensitiveStringType",
43
+ # postal_code: "SensitiveStringType",
44
+ # country: "SensitiveStringType",
45
+ # formatted: "SensitiveStringType",
46
+ # type: "SensitiveStringType",
47
+ # primary: false,
48
+ # }
49
+ #
50
+ # @!attribute [rw] street_address
51
+ # The street of the address.
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] locality
55
+ # A string of the address locality.
56
+ # @return [String]
57
+ #
58
+ # @!attribute [rw] region
59
+ # The region of the address.
60
+ # @return [String]
61
+ #
62
+ # @!attribute [rw] postal_code
63
+ # The postal code of the address.
64
+ # @return [String]
65
+ #
66
+ # @!attribute [rw] country
67
+ # The country of the address.
68
+ # @return [String]
69
+ #
70
+ # @!attribute [rw] formatted
71
+ # A string containing a formatted version of the address for display.
72
+ # @return [String]
73
+ #
74
+ # @!attribute [rw] type
75
+ # A string representing the type of address. For example, "Home."
76
+ # @return [String]
77
+ #
78
+ # @!attribute [rw] primary
79
+ # A Boolean value representing whether this is the primary address for
80
+ # the associated resource.
81
+ # @return [Boolean]
82
+ #
83
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/Address AWS API Documentation
84
+ #
85
+ class Address < Struct.new(
86
+ :street_address,
87
+ :locality,
88
+ :region,
89
+ :postal_code,
90
+ :country,
91
+ :formatted,
92
+ :type,
93
+ :primary)
94
+ SENSITIVE = [:street_address, :locality, :region, :postal_code, :country, :formatted, :type, :primary]
95
+ include Aws::Structure
96
+ end
97
+
98
+ # A unique identifier for a user or group that is not the its primary
99
+ # identifier. This value can be an identifier from an external identity
100
+ # provider (IdP) that is associated with the group or a unique
101
+ # attribute. For example, a unique `GroupDisplayName`.
102
+ #
103
+ # @note AlternateIdentifier is a union - when making an API calls you must set exactly one of the members.
104
+ #
105
+ # @!attribute [rw] external_id
106
+ # The identifier issued to this resource by an external identity
107
+ # provider.
108
+ # @return [Types::ExternalId]
109
+ #
110
+ # @!attribute [rw] unique_attribute
111
+ # An entity attribute that's unique to a specific entity.
112
+ # @return [Types::UniqueAttribute]
113
+ #
114
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/AlternateIdentifier AWS API Documentation
115
+ #
116
+ class AlternateIdentifier < Struct.new(
117
+ :external_id,
118
+ :unique_attribute,
119
+ :unknown)
120
+ SENSITIVE = []
121
+ include Aws::Structure
122
+ include Aws::Structure::Union
123
+
124
+ class ExternalId < AlternateIdentifier; end
125
+ class UniqueAttribute < AlternateIdentifier; end
126
+ class Unknown < AlternateIdentifier; end
127
+ end
128
+
129
+ # An operation that applies to the requested group. This operation might
130
+ # add, replace, or remove an attribute.
131
+ #
132
+ # @note When making an API call, you may pass AttributeOperation
133
+ # data as a hash:
134
+ #
135
+ # {
136
+ # attribute_path: "AttributePath", # required
137
+ # attribute_value: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
138
+ # }
139
+ #
140
+ # @!attribute [rw] attribute_path
141
+ # A string representation of the path to a given attribute or
142
+ # sub-attribute. Supports JMESPath.
143
+ # @return [String]
144
+ #
145
+ # @!attribute [rw] attribute_value
146
+ # The value of the attribute. This is a `Document` type. This type is
147
+ # not supported by Java V1, Go V1, and older versions of the AWS CLI.
148
+ # @return [Hash,Array,String,Numeric,Boolean]
149
+ #
150
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/AttributeOperation AWS API Documentation
151
+ #
152
+ class AttributeOperation < Struct.new(
153
+ :attribute_path,
154
+ :attribute_value)
155
+ SENSITIVE = []
156
+ include Aws::Structure
157
+ end
158
+
159
+ # This request cannot be completed for one of the following reasons:
160
+ #
161
+ # * Performing the requested operation would violate an existing
162
+ # uniqueness claim in the identity store. Resolve the conflict before
163
+ # retrying this request.
164
+ #
165
+ # * The requested resource was being concurrently modified by another
166
+ # request.
167
+ #
168
+ # @!attribute [rw] message
169
+ # @return [String]
170
+ #
171
+ # @!attribute [rw] request_id
172
+ # The identifier for each request. This value is a globally unique ID
173
+ # that is generated by the identity store service for each sent
174
+ # request, and is then returned inside the exception if the request
175
+ # fails.
176
+ # @return [String]
177
+ #
178
+ # @!attribute [rw] reason
179
+ # This request cannot be completed for one of the following reasons:
180
+ #
181
+ # * Performing the requested operation would violate an existing
182
+ # uniqueness claim in the identity store. Resolve the conflict
183
+ # before retrying this request.
184
+ #
185
+ # * The requested resource was being concurrently modified by another
186
+ # request.
187
+ # @return [String]
188
+ #
189
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ConflictException AWS API Documentation
190
+ #
191
+ class ConflictException < Struct.new(
192
+ :message,
193
+ :request_id,
194
+ :reason)
195
+ SENSITIVE = []
196
+ include Aws::Structure
197
+ end
198
+
199
+ # @note When making an API call, you may pass CreateGroupMembershipRequest
200
+ # data as a hash:
201
+ #
202
+ # {
203
+ # identity_store_id: "IdentityStoreId", # required
204
+ # group_id: "ResourceId", # required
205
+ # member_id: { # required
206
+ # user_id: "ResourceId",
207
+ # },
208
+ # }
209
+ #
210
+ # @!attribute [rw] identity_store_id
211
+ # The globally unique identifier for the identity store.
212
+ # @return [String]
213
+ #
214
+ # @!attribute [rw] group_id
215
+ # The identifier for a group in the identity store.
216
+ # @return [String]
217
+ #
218
+ # @!attribute [rw] member_id
219
+ # An object that contains the identifier of a group member. Setting
220
+ # the `UserID` field to the specific identifier for a user indicates
221
+ # that the user is a member of the group.
222
+ # @return [Types::MemberId]
223
+ #
224
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateGroupMembershipRequest AWS API Documentation
225
+ #
226
+ class CreateGroupMembershipRequest < Struct.new(
227
+ :identity_store_id,
228
+ :group_id,
229
+ :member_id)
230
+ SENSITIVE = []
231
+ include Aws::Structure
232
+ end
233
+
234
+ # @!attribute [rw] membership_id
235
+ # The identifier for a newly created `GroupMembership` in an identity
236
+ # store.
237
+ # @return [String]
238
+ #
239
+ # @!attribute [rw] identity_store_id
240
+ # The globally unique identifier for the identity store.
241
+ # @return [String]
242
+ #
243
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateGroupMembershipResponse AWS API Documentation
244
+ #
245
+ class CreateGroupMembershipResponse < Struct.new(
246
+ :membership_id,
247
+ :identity_store_id)
248
+ SENSITIVE = []
249
+ include Aws::Structure
250
+ end
251
+
252
+ # @note When making an API call, you may pass CreateGroupRequest
253
+ # data as a hash:
254
+ #
255
+ # {
256
+ # identity_store_id: "IdentityStoreId", # required
257
+ # display_name: "GroupDisplayName",
258
+ # description: "SensitiveStringType",
259
+ # }
260
+ #
261
+ # @!attribute [rw] identity_store_id
262
+ # The globally unique identifier for the identity store.
263
+ # @return [String]
264
+ #
265
+ # @!attribute [rw] display_name
266
+ # A string containing the name of the group. This value is commonly
267
+ # displayed when the group is referenced.
268
+ # @return [String]
269
+ #
270
+ # @!attribute [rw] description
271
+ # A string containing the description of the group.
272
+ # @return [String]
273
+ #
274
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateGroupRequest AWS API Documentation
275
+ #
276
+ class CreateGroupRequest < Struct.new(
277
+ :identity_store_id,
278
+ :display_name,
279
+ :description)
280
+ SENSITIVE = [:display_name, :description]
281
+ include Aws::Structure
282
+ end
283
+
284
+ # @!attribute [rw] group_id
285
+ # The identifier of the newly created group in the identity store.
286
+ # @return [String]
287
+ #
288
+ # @!attribute [rw] identity_store_id
289
+ # The globally unique identifier for the identity store.
290
+ # @return [String]
291
+ #
292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateGroupResponse AWS API Documentation
293
+ #
294
+ class CreateGroupResponse < Struct.new(
295
+ :group_id,
296
+ :identity_store_id)
297
+ SENSITIVE = []
298
+ include Aws::Structure
299
+ end
300
+
301
+ # @note When making an API call, you may pass CreateUserRequest
302
+ # data as a hash:
303
+ #
304
+ # {
305
+ # identity_store_id: "IdentityStoreId", # required
306
+ # user_name: "UserName",
307
+ # name: {
308
+ # formatted: "SensitiveStringType",
309
+ # family_name: "SensitiveStringType",
310
+ # given_name: "SensitiveStringType",
311
+ # middle_name: "SensitiveStringType",
312
+ # honorific_prefix: "SensitiveStringType",
313
+ # honorific_suffix: "SensitiveStringType",
314
+ # },
315
+ # display_name: "SensitiveStringType",
316
+ # nick_name: "SensitiveStringType",
317
+ # profile_url: "SensitiveStringType",
318
+ # emails: [
319
+ # {
320
+ # value: "SensitiveStringType",
321
+ # type: "SensitiveStringType",
322
+ # primary: false,
323
+ # },
324
+ # ],
325
+ # addresses: [
326
+ # {
327
+ # street_address: "SensitiveStringType",
328
+ # locality: "SensitiveStringType",
329
+ # region: "SensitiveStringType",
330
+ # postal_code: "SensitiveStringType",
331
+ # country: "SensitiveStringType",
332
+ # formatted: "SensitiveStringType",
333
+ # type: "SensitiveStringType",
334
+ # primary: false,
335
+ # },
336
+ # ],
337
+ # phone_numbers: [
338
+ # {
339
+ # value: "SensitiveStringType",
340
+ # type: "SensitiveStringType",
341
+ # primary: false,
342
+ # },
343
+ # ],
344
+ # user_type: "SensitiveStringType",
345
+ # title: "SensitiveStringType",
346
+ # preferred_language: "SensitiveStringType",
347
+ # locale: "SensitiveStringType",
348
+ # timezone: "SensitiveStringType",
349
+ # }
350
+ #
351
+ # @!attribute [rw] identity_store_id
352
+ # The globally unique identifier for the identity store.
353
+ # @return [String]
354
+ #
355
+ # @!attribute [rw] user_name
356
+ # A unique string used to identify the user. The length limit is 128
357
+ # characters. This value can consist of letters, accented characters,
358
+ # symbols, numbers, and punctuation. This value is specified at the
359
+ # time the user is created and stored as an attribute of the user
360
+ # object in the identity store.
361
+ # @return [String]
362
+ #
363
+ # @!attribute [rw] name
364
+ # An object containing the user's name.
365
+ # @return [Types::Name]
366
+ #
367
+ # @!attribute [rw] display_name
368
+ # A string containing the user's name. This value is typically
369
+ # formatted for display when the user is referenced. For example,
370
+ # "John Doe."
371
+ # @return [String]
372
+ #
373
+ # @!attribute [rw] nick_name
374
+ # A string containing an alternate name for the user.
375
+ # @return [String]
376
+ #
377
+ # @!attribute [rw] profile_url
378
+ # A string containing a URL that may be associated with the user.
379
+ # @return [String]
380
+ #
381
+ # @!attribute [rw] emails
382
+ # A list of `Email` objects containing email addresses associated with
383
+ # the user.
384
+ # @return [Array<Types::Email>]
385
+ #
386
+ # @!attribute [rw] addresses
387
+ # A list of `Address` objects containing addresses associated with the
388
+ # user.
389
+ # @return [Array<Types::Address>]
390
+ #
391
+ # @!attribute [rw] phone_numbers
392
+ # A list of `PhoneNumber` objects containing phone numbers associated
393
+ # with the user.
394
+ # @return [Array<Types::PhoneNumber>]
395
+ #
396
+ # @!attribute [rw] user_type
397
+ # A string indicating the user's type. Possible values depend on each
398
+ # customer's specific needs, so they are left unspecified.
399
+ # @return [String]
400
+ #
401
+ # @!attribute [rw] title
402
+ # A string containing the user's title. Possible values are left
403
+ # unspecified given that they depend on each customer's specific
404
+ # needs.
405
+ # @return [String]
406
+ #
407
+ # @!attribute [rw] preferred_language
408
+ # A string containing the preferred language of the user. For example,
409
+ # "American English" or "en-us."
410
+ # @return [String]
411
+ #
412
+ # @!attribute [rw] locale
413
+ # A string containing the user's geographical region or location.
414
+ # @return [String]
415
+ #
416
+ # @!attribute [rw] timezone
417
+ # A string containing the user's time zone.
418
+ # @return [String]
419
+ #
420
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateUserRequest AWS API Documentation
421
+ #
422
+ class CreateUserRequest < Struct.new(
423
+ :identity_store_id,
424
+ :user_name,
425
+ :name,
426
+ :display_name,
427
+ :nick_name,
428
+ :profile_url,
429
+ :emails,
430
+ :addresses,
431
+ :phone_numbers,
432
+ :user_type,
433
+ :title,
434
+ :preferred_language,
435
+ :locale,
436
+ :timezone)
437
+ SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
438
+ include Aws::Structure
439
+ end
440
+
441
+ # @!attribute [rw] user_id
442
+ # The identifier of the newly created user in the identity store.
443
+ # @return [String]
444
+ #
445
+ # @!attribute [rw] identity_store_id
446
+ # The globally unique identifier for the identity store.
447
+ # @return [String]
448
+ #
449
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateUserResponse AWS API Documentation
450
+ #
451
+ class CreateUserResponse < Struct.new(
452
+ :user_id,
453
+ :identity_store_id)
454
+ SENSITIVE = []
455
+ include Aws::Structure
456
+ end
457
+
458
+ # @note When making an API call, you may pass DeleteGroupMembershipRequest
459
+ # data as a hash:
460
+ #
461
+ # {
462
+ # identity_store_id: "IdentityStoreId", # required
463
+ # membership_id: "ResourceId", # required
464
+ # }
465
+ #
466
+ # @!attribute [rw] identity_store_id
467
+ # The globally unique identifier for the identity store.
468
+ # @return [String]
469
+ #
470
+ # @!attribute [rw] membership_id
471
+ # The identifier for a `GroupMembership` in an identity store.
472
+ # @return [String]
473
+ #
474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteGroupMembershipRequest AWS API Documentation
475
+ #
476
+ class DeleteGroupMembershipRequest < Struct.new(
477
+ :identity_store_id,
478
+ :membership_id)
479
+ SENSITIVE = []
480
+ include Aws::Structure
481
+ end
482
+
483
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteGroupMembershipResponse AWS API Documentation
484
+ #
485
+ class DeleteGroupMembershipResponse < Aws::EmptyStructure; end
486
+
487
+ # @note When making an API call, you may pass DeleteGroupRequest
488
+ # data as a hash:
489
+ #
490
+ # {
491
+ # identity_store_id: "IdentityStoreId", # required
492
+ # group_id: "ResourceId", # required
493
+ # }
494
+ #
495
+ # @!attribute [rw] identity_store_id
496
+ # The globally unique identifier for the identity store.
497
+ # @return [String]
498
+ #
499
+ # @!attribute [rw] group_id
500
+ # The identifier for a group in the identity store.
501
+ # @return [String]
502
+ #
503
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteGroupRequest AWS API Documentation
504
+ #
505
+ class DeleteGroupRequest < Struct.new(
506
+ :identity_store_id,
507
+ :group_id)
508
+ SENSITIVE = []
509
+ include Aws::Structure
510
+ end
511
+
512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteGroupResponse AWS API Documentation
513
+ #
514
+ class DeleteGroupResponse < Aws::EmptyStructure; end
515
+
516
+ # @note When making an API call, you may pass DeleteUserRequest
517
+ # data as a hash:
518
+ #
519
+ # {
520
+ # identity_store_id: "IdentityStoreId", # required
521
+ # user_id: "ResourceId", # required
522
+ # }
523
+ #
524
+ # @!attribute [rw] identity_store_id
525
+ # The globally unique identifier for the identity store.
526
+ # @return [String]
527
+ #
528
+ # @!attribute [rw] user_id
529
+ # The identifier for a user in the identity store.
530
+ # @return [String]
531
+ #
532
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteUserRequest AWS API Documentation
533
+ #
534
+ class DeleteUserRequest < Struct.new(
535
+ :identity_store_id,
536
+ :user_id)
537
+ SENSITIVE = []
538
+ include Aws::Structure
539
+ end
540
+
541
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteUserResponse AWS API Documentation
542
+ #
543
+ class DeleteUserResponse < Aws::EmptyStructure; end
544
+
545
+ # @note When making an API call, you may pass DescribeGroupMembershipRequest
546
+ # data as a hash:
547
+ #
548
+ # {
549
+ # identity_store_id: "IdentityStoreId", # required
550
+ # membership_id: "ResourceId", # required
551
+ # }
552
+ #
553
+ # @!attribute [rw] identity_store_id
554
+ # The globally unique identifier for the identity store.
555
+ # @return [String]
556
+ #
557
+ # @!attribute [rw] membership_id
558
+ # The identifier for a `GroupMembership` in an identity store.
559
+ # @return [String]
560
+ #
561
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupMembershipRequest AWS API Documentation
562
+ #
563
+ class DescribeGroupMembershipRequest < Struct.new(
564
+ :identity_store_id,
565
+ :membership_id)
566
+ SENSITIVE = []
567
+ include Aws::Structure
568
+ end
569
+
570
+ # @!attribute [rw] identity_store_id
571
+ # The globally unique identifier for the identity store.
572
+ # @return [String]
573
+ #
574
+ # @!attribute [rw] membership_id
575
+ # The identifier for a `GroupMembership` in an identity store.
576
+ # @return [String]
577
+ #
578
+ # @!attribute [rw] group_id
579
+ # The identifier for a group in the identity store.
580
+ # @return [String]
581
+ #
582
+ # @!attribute [rw] member_id
583
+ # An object containing the identifier of a group member.
584
+ # @return [Types::MemberId]
585
+ #
586
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupMembershipResponse AWS API Documentation
587
+ #
588
+ class DescribeGroupMembershipResponse < Struct.new(
589
+ :identity_store_id,
590
+ :membership_id,
591
+ :group_id,
592
+ :member_id)
593
+ SENSITIVE = []
594
+ include Aws::Structure
595
+ end
596
+
34
597
  # @note When making an API call, you may pass DescribeGroupRequest
35
598
  # data as a hash:
36
599
  #
@@ -40,176 +603,749 @@ module Aws::IdentityStore
40
603
  # }
41
604
  #
42
605
  # @!attribute [rw] identity_store_id
43
- # The globally unique identifier for the identity store, such as
44
- # `d-1234567890`. In this example, `d-` is a fixed prefix, and
45
- # `1234567890` is a randomly generated string that contains number and
46
- # lower case letters. This value is generated at the time that a new
47
- # identity store is created.
606
+ # The globally unique identifier for the identity store, such as
607
+ # `d-1234567890`. In this example, `d-` is a fixed prefix, and
608
+ # `1234567890` is a randomly generated string that contains numbers
609
+ # and lower case letters. This value is generated at the time that a
610
+ # new identity store is created.
611
+ # @return [String]
612
+ #
613
+ # @!attribute [rw] group_id
614
+ # The identifier for a group in the identity store.
615
+ # @return [String]
616
+ #
617
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupRequest AWS API Documentation
618
+ #
619
+ class DescribeGroupRequest < Struct.new(
620
+ :identity_store_id,
621
+ :group_id)
622
+ SENSITIVE = []
623
+ include Aws::Structure
624
+ end
625
+
626
+ # @!attribute [rw] group_id
627
+ # The identifier for a group in the identity store.
628
+ # @return [String]
629
+ #
630
+ # @!attribute [rw] display_name
631
+ # The group’s display name value. The length limit is 1,024
632
+ # characters. This value can consist of letters, accented characters,
633
+ # symbols, numbers, punctuation, tab, new line, carriage return,
634
+ # space, and nonbreaking space in this attribute. The characters
635
+ # `<>;:%` are excluded. This value is specified at the time that the
636
+ # group is created and stored as an attribute of the group object in
637
+ # the identity store.
638
+ # @return [String]
639
+ #
640
+ # @!attribute [rw] external_ids
641
+ # A list of `ExternalId` objects that contains the identifiers issued
642
+ # to this resource by an external identity provider.
643
+ # @return [Array<Types::ExternalId>]
644
+ #
645
+ # @!attribute [rw] description
646
+ # A string containing a description of the group.
647
+ # @return [String]
648
+ #
649
+ # @!attribute [rw] identity_store_id
650
+ # The globally unique identifier for the identity store.
651
+ # @return [String]
652
+ #
653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupResponse AWS API Documentation
654
+ #
655
+ class DescribeGroupResponse < Struct.new(
656
+ :group_id,
657
+ :display_name,
658
+ :external_ids,
659
+ :description,
660
+ :identity_store_id)
661
+ SENSITIVE = [:display_name, :description]
662
+ include Aws::Structure
663
+ end
664
+
665
+ # @note When making an API call, you may pass DescribeUserRequest
666
+ # data as a hash:
667
+ #
668
+ # {
669
+ # identity_store_id: "IdentityStoreId", # required
670
+ # user_id: "ResourceId", # required
671
+ # }
672
+ #
673
+ # @!attribute [rw] identity_store_id
674
+ # The globally unique identifier for the identity store, such as
675
+ # `d-1234567890`. In this example, `d-` is a fixed prefix, and
676
+ # `1234567890` is a randomly generated string that contains numbers
677
+ # and lower case letters. This value is generated at the time that a
678
+ # new identity store is created.
679
+ # @return [String]
680
+ #
681
+ # @!attribute [rw] user_id
682
+ # The identifier for a user in the identity store.
683
+ # @return [String]
684
+ #
685
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeUserRequest AWS API Documentation
686
+ #
687
+ class DescribeUserRequest < Struct.new(
688
+ :identity_store_id,
689
+ :user_id)
690
+ SENSITIVE = []
691
+ include Aws::Structure
692
+ end
693
+
694
+ # @!attribute [rw] user_name
695
+ # A unique string used to identify the user. The length limit is 128
696
+ # characters. This value can consist of letters, accented characters,
697
+ # symbols, numbers, and punctuation. This value is specified at the
698
+ # time the user is created and stored as an attribute of the user
699
+ # object in the identity store.
700
+ # @return [String]
701
+ #
702
+ # @!attribute [rw] user_id
703
+ # The identifier for a user in the identity store.
704
+ # @return [String]
705
+ #
706
+ # @!attribute [rw] external_ids
707
+ # A list of `ExternalId` objects that contains the identifiers issued
708
+ # to this resource by an external identity provider.
709
+ # @return [Array<Types::ExternalId>]
710
+ #
711
+ # @!attribute [rw] name
712
+ # The name of the user.
713
+ # @return [Types::Name]
714
+ #
715
+ # @!attribute [rw] display_name
716
+ # The user's name value for display.
717
+ # @return [String]
718
+ #
719
+ # @!attribute [rw] nick_name
720
+ # An alternative descriptive name for the user.
721
+ # @return [String]
722
+ #
723
+ # @!attribute [rw] profile_url
724
+ # A URL link for the user's profile.
725
+ # @return [String]
726
+ #
727
+ # @!attribute [rw] emails
728
+ # The user's email value.
729
+ # @return [Array<Types::Email>]
730
+ #
731
+ # @!attribute [rw] addresses
732
+ # The user's physical address.
733
+ # @return [Array<Types::Address>]
734
+ #
735
+ # @!attribute [rw] phone_numbers
736
+ # A list of `PhoneNumber` objects associated with a user.
737
+ # @return [Array<Types::PhoneNumber>]
738
+ #
739
+ # @!attribute [rw] user_type
740
+ # A string indicating the user's type.
741
+ # @return [String]
742
+ #
743
+ # @!attribute [rw] title
744
+ # A string containing the user's title.
745
+ # @return [String]
746
+ #
747
+ # @!attribute [rw] preferred_language
748
+ # The preferred language of the user.
749
+ # @return [String]
750
+ #
751
+ # @!attribute [rw] locale
752
+ # A string containing the user's geographical region or location.
753
+ # @return [String]
754
+ #
755
+ # @!attribute [rw] timezone
756
+ # The time zone for a user.
757
+ # @return [String]
758
+ #
759
+ # @!attribute [rw] identity_store_id
760
+ # The globally unique identifier for the identity store.
761
+ # @return [String]
762
+ #
763
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeUserResponse AWS API Documentation
764
+ #
765
+ class DescribeUserResponse < Struct.new(
766
+ :user_name,
767
+ :user_id,
768
+ :external_ids,
769
+ :name,
770
+ :display_name,
771
+ :nick_name,
772
+ :profile_url,
773
+ :emails,
774
+ :addresses,
775
+ :phone_numbers,
776
+ :user_type,
777
+ :title,
778
+ :preferred_language,
779
+ :locale,
780
+ :timezone,
781
+ :identity_store_id)
782
+ SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
783
+ include Aws::Structure
784
+ end
785
+
786
+ # The email address associated with the user.
787
+ #
788
+ # @note When making an API call, you may pass Email
789
+ # data as a hash:
790
+ #
791
+ # {
792
+ # value: "SensitiveStringType",
793
+ # type: "SensitiveStringType",
794
+ # primary: false,
795
+ # }
796
+ #
797
+ # @!attribute [rw] value
798
+ # A string containing an email address. For example,
799
+ # "johndoe@amazon.com."
800
+ # @return [String]
801
+ #
802
+ # @!attribute [rw] type
803
+ # A string representing the type of address. For example, "Work."
804
+ # @return [String]
805
+ #
806
+ # @!attribute [rw] primary
807
+ # A Boolean value representing whether this is the primary email
808
+ # address for the associated resource.
809
+ # @return [Boolean]
810
+ #
811
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/Email AWS API Documentation
812
+ #
813
+ class Email < Struct.new(
814
+ :value,
815
+ :type,
816
+ :primary)
817
+ SENSITIVE = [:value, :type, :primary]
818
+ include Aws::Structure
819
+ end
820
+
821
+ # The identifier issued to this resource by an external identity
822
+ # provider.
823
+ #
824
+ # @note When making an API call, you may pass ExternalId
825
+ # data as a hash:
826
+ #
827
+ # {
828
+ # issuer: "ExternalIdIssuer", # required
829
+ # id: "ExternalIdIdentifier", # required
830
+ # }
831
+ #
832
+ # @!attribute [rw] issuer
833
+ # The issuer for an external identifier.
834
+ # @return [String]
835
+ #
836
+ # @!attribute [rw] id
837
+ # The identifier issued to this resource by an external identity
838
+ # provider.
839
+ # @return [String]
840
+ #
841
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ExternalId AWS API Documentation
842
+ #
843
+ class ExternalId < Struct.new(
844
+ :issuer,
845
+ :id)
846
+ SENSITIVE = [:issuer, :id]
847
+ include Aws::Structure
848
+ end
849
+
850
+ # A query filter used by `ListUsers` and `ListGroups`. This filter
851
+ # object provides the attribute name and attribute value to search users
852
+ # or groups.
853
+ #
854
+ # @note When making an API call, you may pass Filter
855
+ # data as a hash:
856
+ #
857
+ # {
858
+ # attribute_path: "AttributePath", # required
859
+ # attribute_value: "SensitiveStringType", # required
860
+ # }
861
+ #
862
+ # @!attribute [rw] attribute_path
863
+ # The attribute path that is used to specify which attribute name to
864
+ # search. Length limit is 255 characters. For example, `UserName` is a
865
+ # valid attribute path for the `ListUsers` API, and `DisplayName` is a
866
+ # valid attribute path for the `ListGroups` API.
867
+ # @return [String]
868
+ #
869
+ # @!attribute [rw] attribute_value
870
+ # Represents the data for an attribute. Each attribute value is
871
+ # described as a name-value pair.
872
+ # @return [String]
873
+ #
874
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/Filter AWS API Documentation
875
+ #
876
+ class Filter < Struct.new(
877
+ :attribute_path,
878
+ :attribute_value)
879
+ SENSITIVE = [:attribute_value]
880
+ include Aws::Structure
881
+ end
882
+
883
+ # @note When making an API call, you may pass GetGroupIdRequest
884
+ # data as a hash:
885
+ #
886
+ # {
887
+ # identity_store_id: "IdentityStoreId", # required
888
+ # alternate_identifier: { # required
889
+ # external_id: {
890
+ # issuer: "ExternalIdIssuer", # required
891
+ # id: "ExternalIdIdentifier", # required
892
+ # },
893
+ # unique_attribute: {
894
+ # attribute_path: "AttributePath", # required
895
+ # attribute_value: "value", # required, value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
896
+ # },
897
+ # },
898
+ # }
899
+ #
900
+ # @!attribute [rw] identity_store_id
901
+ # The globally unique identifier for the identity store.
902
+ # @return [String]
903
+ #
904
+ # @!attribute [rw] alternate_identifier
905
+ # A unique identifier for an identity resource that is not the primary
906
+ # identifier. This value can be an identifier from an external
907
+ # identity provider (IdP) that is associated with the group or a
908
+ # unique attribute. For example, a unique `GroupDisplayName`.
909
+ # @return [Types::AlternateIdentifier]
910
+ #
911
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupIdRequest AWS API Documentation
912
+ #
913
+ class GetGroupIdRequest < Struct.new(
914
+ :identity_store_id,
915
+ :alternate_identifier)
916
+ SENSITIVE = []
917
+ include Aws::Structure
918
+ end
919
+
920
+ # @!attribute [rw] group_id
921
+ # The identifier for a group in the identity store.
922
+ # @return [String]
923
+ #
924
+ # @!attribute [rw] identity_store_id
925
+ # The globally unique identifier for the identity store.
926
+ # @return [String]
927
+ #
928
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupIdResponse AWS API Documentation
929
+ #
930
+ class GetGroupIdResponse < Struct.new(
931
+ :group_id,
932
+ :identity_store_id)
933
+ SENSITIVE = []
934
+ include Aws::Structure
935
+ end
936
+
937
+ # @note When making an API call, you may pass GetGroupMembershipIdRequest
938
+ # data as a hash:
939
+ #
940
+ # {
941
+ # identity_store_id: "IdentityStoreId", # required
942
+ # group_id: "ResourceId", # required
943
+ # member_id: { # required
944
+ # user_id: "ResourceId",
945
+ # },
946
+ # }
947
+ #
948
+ # @!attribute [rw] identity_store_id
949
+ # The globally unique identifier for the identity store.
48
950
  # @return [String]
49
951
  #
50
952
  # @!attribute [rw] group_id
51
953
  # The identifier for a group in the identity store.
52
954
  # @return [String]
53
955
  #
54
- # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupRequest AWS API Documentation
956
+ # @!attribute [rw] member_id
957
+ # An object that contains the identifier of a group member. Setting
958
+ # the `UserID` field to the specific identifier for a user indicates
959
+ # that the user is a member of the group.
960
+ # @return [Types::MemberId]
55
961
  #
56
- class DescribeGroupRequest < Struct.new(
962
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupMembershipIdRequest AWS API Documentation
963
+ #
964
+ class GetGroupMembershipIdRequest < Struct.new(
57
965
  :identity_store_id,
58
- :group_id)
966
+ :group_id,
967
+ :member_id)
968
+ SENSITIVE = []
969
+ include Aws::Structure
970
+ end
971
+
972
+ # @!attribute [rw] membership_id
973
+ # The identifier for a `GroupMembership` in an identity store.
974
+ # @return [String]
975
+ #
976
+ # @!attribute [rw] identity_store_id
977
+ # The globally unique identifier for the identity store.
978
+ # @return [String]
979
+ #
980
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupMembershipIdResponse AWS API Documentation
981
+ #
982
+ class GetGroupMembershipIdResponse < Struct.new(
983
+ :membership_id,
984
+ :identity_store_id)
985
+ SENSITIVE = []
986
+ include Aws::Structure
987
+ end
988
+
989
+ # @note When making an API call, you may pass GetUserIdRequest
990
+ # data as a hash:
991
+ #
992
+ # {
993
+ # identity_store_id: "IdentityStoreId", # required
994
+ # alternate_identifier: { # required
995
+ # external_id: {
996
+ # issuer: "ExternalIdIssuer", # required
997
+ # id: "ExternalIdIdentifier", # required
998
+ # },
999
+ # unique_attribute: {
1000
+ # attribute_path: "AttributePath", # required
1001
+ # attribute_value: "value", # required, value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
1002
+ # },
1003
+ # },
1004
+ # }
1005
+ #
1006
+ # @!attribute [rw] identity_store_id
1007
+ # The globally unique identifier for the identity store.
1008
+ # @return [String]
1009
+ #
1010
+ # @!attribute [rw] alternate_identifier
1011
+ # A unique identifier for an identity resource that is not the primary
1012
+ # identifier.
1013
+ # @return [Types::AlternateIdentifier]
1014
+ #
1015
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetUserIdRequest AWS API Documentation
1016
+ #
1017
+ class GetUserIdRequest < Struct.new(
1018
+ :identity_store_id,
1019
+ :alternate_identifier)
1020
+ SENSITIVE = []
1021
+ include Aws::Structure
1022
+ end
1023
+
1024
+ # @!attribute [rw] user_id
1025
+ # The identifier for a user in the identity store.
1026
+ # @return [String]
1027
+ #
1028
+ # @!attribute [rw] identity_store_id
1029
+ # The globally unique identifier for the identity store.
1030
+ # @return [String]
1031
+ #
1032
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetUserIdResponse AWS API Documentation
1033
+ #
1034
+ class GetUserIdResponse < Struct.new(
1035
+ :user_id,
1036
+ :identity_store_id)
59
1037
  SENSITIVE = []
60
1038
  include Aws::Structure
61
1039
  end
62
1040
 
1041
+ # A group object that contains a specified group’s metadata and
1042
+ # attributes.
1043
+ #
63
1044
  # @!attribute [rw] group_id
64
1045
  # The identifier for a group in the identity store.
65
1046
  # @return [String]
66
1047
  #
67
1048
  # @!attribute [rw] display_name
68
- # Contains the group’s display name value. The length limit is 1,024
1049
+ # The group’s display name value. The length limit is 1,024
69
1050
  # characters. This value can consist of letters, accented characters,
70
1051
  # symbols, numbers, punctuation, tab, new line, carriage return,
71
1052
  # space, and nonbreaking space in this attribute. The characters
72
- # `<>;:%` are excluded. This value is specified at the time that the
73
- # group is created and stored as an attribute of the group object in
74
- # the identity store.
1053
+ # `<>;:%` are excluded. This value is specified at the time the group
1054
+ # is created and stored as an attribute of the group object in the
1055
+ # identity store.
75
1056
  # @return [String]
76
1057
  #
77
- # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupResponse AWS API Documentation
1058
+ # @!attribute [rw] external_ids
1059
+ # A list of `ExternalId` objects that contains the identifiers issued
1060
+ # to this resource by an external identity provider.
1061
+ # @return [Array<Types::ExternalId>]
78
1062
  #
79
- class DescribeGroupResponse < Struct.new(
1063
+ # @!attribute [rw] description
1064
+ # A string containing a description of the specified group.
1065
+ # @return [String]
1066
+ #
1067
+ # @!attribute [rw] identity_store_id
1068
+ # The globally unique identifier for the identity store.
1069
+ # @return [String]
1070
+ #
1071
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/Group AWS API Documentation
1072
+ #
1073
+ class Group < Struct.new(
1074
+ :group_id,
1075
+ :display_name,
1076
+ :external_ids,
1077
+ :description,
1078
+ :identity_store_id)
1079
+ SENSITIVE = [:display_name, :description]
1080
+ include Aws::Structure
1081
+ end
1082
+
1083
+ # Contains the identifiers for a group, a group member, and a
1084
+ # `GroupMembership` object in the identity store.
1085
+ #
1086
+ # @!attribute [rw] identity_store_id
1087
+ # The globally unique identifier for the identity store.
1088
+ # @return [String]
1089
+ #
1090
+ # @!attribute [rw] membership_id
1091
+ # The identifier for a `GroupMembership` object in an identity store.
1092
+ # @return [String]
1093
+ #
1094
+ # @!attribute [rw] group_id
1095
+ # The identifier for a group in the identity store.
1096
+ # @return [String]
1097
+ #
1098
+ # @!attribute [rw] member_id
1099
+ # An object that contains the identifier of a group member. Setting
1100
+ # the `UserID` field to the specific identifier for a user indicates
1101
+ # that the user is a member of the group.
1102
+ # @return [Types::MemberId]
1103
+ #
1104
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GroupMembership AWS API Documentation
1105
+ #
1106
+ class GroupMembership < Struct.new(
1107
+ :identity_store_id,
1108
+ :membership_id,
80
1109
  :group_id,
81
- :display_name)
1110
+ :member_id)
82
1111
  SENSITIVE = []
83
1112
  include Aws::Structure
84
1113
  end
85
1114
 
86
- # @note When making an API call, you may pass DescribeUserRequest
1115
+ # Indicates whether a resource is a member of a group in the identity
1116
+ # store.
1117
+ #
1118
+ # @!attribute [rw] group_id
1119
+ # The identifier for a group in the identity store.
1120
+ # @return [String]
1121
+ #
1122
+ # @!attribute [rw] member_id
1123
+ # An object that contains the identifier of a group member. Setting
1124
+ # the `UserID` field to the specific identifier for a user indicates
1125
+ # that the user is a member of the group.
1126
+ # @return [Types::MemberId]
1127
+ #
1128
+ # @!attribute [rw] membership_exists
1129
+ # Indicates whether a membership relation exists or not.
1130
+ # @return [Boolean]
1131
+ #
1132
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GroupMembershipExistenceResult AWS API Documentation
1133
+ #
1134
+ class GroupMembershipExistenceResult < Struct.new(
1135
+ :group_id,
1136
+ :member_id,
1137
+ :membership_exists)
1138
+ SENSITIVE = [:membership_exists]
1139
+ include Aws::Structure
1140
+ end
1141
+
1142
+ # The request processing has failed because of an unknown error,
1143
+ # exception or failure with an internal server.
1144
+ #
1145
+ # @!attribute [rw] message
1146
+ # @return [String]
1147
+ #
1148
+ # @!attribute [rw] request_id
1149
+ # The identifier for each request. This value is a globally unique ID
1150
+ # that is generated by the identity store service for each sent
1151
+ # request, and is then returned inside the exception if the request
1152
+ # fails.
1153
+ # @return [String]
1154
+ #
1155
+ # @!attribute [rw] retry_after_seconds
1156
+ # The number of seconds that you would like to wait before retrying
1157
+ # the next request.
1158
+ # @return [Integer]
1159
+ #
1160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/InternalServerException AWS API Documentation
1161
+ #
1162
+ class InternalServerException < Struct.new(
1163
+ :message,
1164
+ :request_id,
1165
+ :retry_after_seconds)
1166
+ SENSITIVE = []
1167
+ include Aws::Structure
1168
+ end
1169
+
1170
+ # @note When making an API call, you may pass IsMemberInGroupsRequest
87
1171
  # data as a hash:
88
1172
  #
89
1173
  # {
90
1174
  # identity_store_id: "IdentityStoreId", # required
91
- # user_id: "ResourceId", # required
1175
+ # member_id: { # required
1176
+ # user_id: "ResourceId",
1177
+ # },
1178
+ # group_ids: ["ResourceId"], # required
92
1179
  # }
93
1180
  #
94
1181
  # @!attribute [rw] identity_store_id
95
- # The globally unique identifier for the identity store, such as
96
- # `d-1234567890`. In this example, `d-` is a fixed prefix, and
97
- # `1234567890` is a randomly generated string that contains number and
98
- # lower case letters. This value is generated at the time that a new
99
- # identity store is created.
1182
+ # The globally unique identifier for the identity store.
100
1183
  # @return [String]
101
1184
  #
102
- # @!attribute [rw] user_id
103
- # The identifier for a user in the identity store.
1185
+ # @!attribute [rw] member_id
1186
+ # An object containing the identifier of a group member.
1187
+ # @return [Types::MemberId]
1188
+ #
1189
+ # @!attribute [rw] group_ids
1190
+ # A list of identifiers for groups in the identity store.
1191
+ # @return [Array<String>]
1192
+ #
1193
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/IsMemberInGroupsRequest AWS API Documentation
1194
+ #
1195
+ class IsMemberInGroupsRequest < Struct.new(
1196
+ :identity_store_id,
1197
+ :member_id,
1198
+ :group_ids)
1199
+ SENSITIVE = []
1200
+ include Aws::Structure
1201
+ end
1202
+
1203
+ # @!attribute [rw] results
1204
+ # A list containing the results of membership existence checks.
1205
+ # @return [Array<Types::GroupMembershipExistenceResult>]
1206
+ #
1207
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/IsMemberInGroupsResponse AWS API Documentation
1208
+ #
1209
+ class IsMemberInGroupsResponse < Struct.new(
1210
+ :results)
1211
+ SENSITIVE = []
1212
+ include Aws::Structure
1213
+ end
1214
+
1215
+ # @note When making an API call, you may pass ListGroupMembershipsForMemberRequest
1216
+ # data as a hash:
1217
+ #
1218
+ # {
1219
+ # identity_store_id: "IdentityStoreId", # required
1220
+ # member_id: { # required
1221
+ # user_id: "ResourceId",
1222
+ # },
1223
+ # max_results: 1,
1224
+ # next_token: "NextToken",
1225
+ # }
1226
+ #
1227
+ # @!attribute [rw] identity_store_id
1228
+ # The globally unique identifier for the identity store.
1229
+ # @return [String]
1230
+ #
1231
+ # @!attribute [rw] member_id
1232
+ # An object that contains the identifier of a group member. Setting
1233
+ # the `UserID` field to the specific identifier for a user indicates
1234
+ # that the user is a member of the group.
1235
+ # @return [Types::MemberId]
1236
+ #
1237
+ # @!attribute [rw] max_results
1238
+ # The maximum number of results to be returned per request. This
1239
+ # parameter is used in the `ListUsers` and `ListGroups` requests to
1240
+ # specify how many results to return in one page. The length limit is
1241
+ # 50 characters.
1242
+ # @return [Integer]
1243
+ #
1244
+ # @!attribute [rw] next_token
1245
+ # The pagination token used for the `ListUsers`, `ListGroups`, and
1246
+ # `ListGroupMemberships` API operations. This value is generated by
1247
+ # the identity store service. It is returned in the API response if
1248
+ # the total results are more than the size of one page. This token is
1249
+ # also returned when it is used in the API request to search for the
1250
+ # next page.
104
1251
  # @return [String]
105
1252
  #
106
- # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeUserRequest AWS API Documentation
1253
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsForMemberRequest AWS API Documentation
107
1254
  #
108
- class DescribeUserRequest < Struct.new(
1255
+ class ListGroupMembershipsForMemberRequest < Struct.new(
109
1256
  :identity_store_id,
110
- :user_id)
1257
+ :member_id,
1258
+ :max_results,
1259
+ :next_token)
111
1260
  SENSITIVE = []
112
1261
  include Aws::Structure
113
1262
  end
114
1263
 
115
- # @!attribute [rw] user_name
116
- # Contains the user’s user name value. The length limit is 128
117
- # characters. This value can consist of letters, accented characters,
118
- # symbols, numbers, and punctuation. The characters `<>;:%` are
119
- # excluded. This value is specified at the time the user is created
120
- # and stored as an attribute of the user object in the identity store.
121
- # @return [String]
1264
+ # @!attribute [rw] group_memberships
1265
+ # A list of `GroupMembership` objects in the group for a specified
1266
+ # member.
1267
+ # @return [Array<Types::GroupMembership>]
122
1268
  #
123
- # @!attribute [rw] user_id
124
- # The identifier for a user in the identity store.
1269
+ # @!attribute [rw] next_token
1270
+ # The pagination token used for the `ListUsers`, `ListGroups`, and
1271
+ # `ListGroupMemberships` API operations. This value is generated by
1272
+ # the identity store service. It is returned in the API response if
1273
+ # the total results are more than the size of one page. This token is
1274
+ # also returned when it is used in the API request to search for the
1275
+ # next page.
125
1276
  # @return [String]
126
1277
  #
127
- # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeUserResponse AWS API Documentation
1278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsForMemberResponse AWS API Documentation
128
1279
  #
129
- class DescribeUserResponse < Struct.new(
130
- :user_name,
131
- :user_id)
132
- SENSITIVE = [:user_name]
1280
+ class ListGroupMembershipsForMemberResponse < Struct.new(
1281
+ :group_memberships,
1282
+ :next_token)
1283
+ SENSITIVE = []
133
1284
  include Aws::Structure
134
1285
  end
135
1286
 
136
- # A query filter used by `ListUsers` and `ListGroups`. This filter
137
- # object provides the attribute name and attribute value to search users
138
- # or groups.
139
- #
140
- # @note When making an API call, you may pass Filter
1287
+ # @note When making an API call, you may pass ListGroupMembershipsRequest
141
1288
  # data as a hash:
142
1289
  #
143
1290
  # {
144
- # attribute_path: "AttributePath", # required
145
- # attribute_value: "SensitiveStringType", # required
1291
+ # identity_store_id: "IdentityStoreId", # required
1292
+ # group_id: "ResourceId", # required
1293
+ # max_results: 1,
1294
+ # next_token: "NextToken",
146
1295
  # }
147
1296
  #
148
- # @!attribute [rw] attribute_path
149
- # The attribute path that is used to specify which attribute name to
150
- # search. Length limit is 255 characters. For example, `UserName` is a
151
- # valid attribute path for the `ListUsers` API, and `DisplayName` is a
152
- # valid attribute path for the `ListGroups` API.
153
- # @return [String]
154
- #
155
- # @!attribute [rw] attribute_value
156
- # Represents the data for an attribute. Each attribute value is
157
- # described as a name-value pair.
1297
+ # @!attribute [rw] identity_store_id
1298
+ # The globally unique identifier for the identity store.
158
1299
  # @return [String]
159
1300
  #
160
- # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/Filter AWS API Documentation
161
- #
162
- class Filter < Struct.new(
163
- :attribute_path,
164
- :attribute_value)
165
- SENSITIVE = [:attribute_value]
166
- include Aws::Structure
167
- end
168
-
169
- # A group object, which contains a specified group’s metadata and
170
- # attributes.
171
- #
172
1301
  # @!attribute [rw] group_id
173
1302
  # The identifier for a group in the identity store.
174
1303
  # @return [String]
175
1304
  #
176
- # @!attribute [rw] display_name
177
- # Contains the group’s display name value. The length limit is 1,024
178
- # characters. This value can consist of letters, accented characters,
179
- # symbols, numbers, punctuation, tab, new line, carriage return,
180
- # space, and nonbreaking space in this attribute. The characters
181
- # `<>;:%` are excluded. This value is specified at the time the group
182
- # is created and stored as an attribute of the group object in the
183
- # identity store.
1305
+ # @!attribute [rw] max_results
1306
+ # The maximum number of results to be returned per request. This
1307
+ # parameter is used in all `List` requests to specify how many results
1308
+ # to return in one page.
1309
+ # @return [Integer]
1310
+ #
1311
+ # @!attribute [rw] next_token
1312
+ # The pagination token used for the `ListUsers`, `ListGroups` and
1313
+ # `ListGroupMemberships` API operations. This value is generated by
1314
+ # the identity store service. It is returned in the API response if
1315
+ # the total results are more than the size of one page. This token is
1316
+ # also returned when it is used in the API request to search for the
1317
+ # next page.
184
1318
  # @return [String]
185
1319
  #
186
- # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/Group AWS API Documentation
1320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsRequest AWS API Documentation
187
1321
  #
188
- class Group < Struct.new(
1322
+ class ListGroupMembershipsRequest < Struct.new(
1323
+ :identity_store_id,
189
1324
  :group_id,
190
- :display_name)
1325
+ :max_results,
1326
+ :next_token)
191
1327
  SENSITIVE = []
192
1328
  include Aws::Structure
193
1329
  end
194
1330
 
195
- # The request processing has failed because of an unknown error,
196
- # exception or failure with an internal server.
1331
+ # @!attribute [rw] group_memberships
1332
+ # A list of `GroupMembership` objects in the group.
1333
+ # @return [Array<Types::GroupMembership>]
197
1334
  #
198
- # @!attribute [rw] message
199
- # @return [String]
200
- #
201
- # @!attribute [rw] request_id
202
- # The identifier for each request. This value is a globally unique ID
203
- # that is generated by the identity store service for each sent
204
- # request, and is then returned inside the exception if the request
205
- # fails.
1335
+ # @!attribute [rw] next_token
1336
+ # The pagination token used for the `ListUsers`, `ListGroups`, and
1337
+ # `ListGroupMemberships` API operations. This value is generated by
1338
+ # the identity store service. It is returned in the API response if
1339
+ # the total results are more than the size of one page. This token is
1340
+ # also returned when it is used in the API request to search for the
1341
+ # next page.
206
1342
  # @return [String]
207
1343
  #
208
- # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/InternalServerException AWS API Documentation
1344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsResponse AWS API Documentation
209
1345
  #
210
- class InternalServerException < Struct.new(
211
- :message,
212
- :request_id)
1346
+ class ListGroupMembershipsResponse < Struct.new(
1347
+ :group_memberships,
1348
+ :next_token)
213
1349
  SENSITIVE = []
214
1350
  include Aws::Structure
215
1351
  end
@@ -232,14 +1368,14 @@ module Aws::IdentityStore
232
1368
  # @!attribute [rw] identity_store_id
233
1369
  # The globally unique identifier for the identity store, such as
234
1370
  # `d-1234567890`. In this example, `d-` is a fixed prefix, and
235
- # `1234567890` is a randomly generated string that contains number and
236
- # lower case letters. This value is generated at the time that a new
237
- # identity store is created.
1371
+ # `1234567890` is a randomly generated string that contains numbers
1372
+ # and lower case letters. This value is generated at the time that a
1373
+ # new identity store is created.
238
1374
  # @return [String]
239
1375
  #
240
1376
  # @!attribute [rw] max_results
241
1377
  # The maximum number of results to be returned per request. This
242
- # parameter is used in the `ListUsers` and `ListGroups` request to
1378
+ # parameter is used in the `ListUsers` and `ListGroups` requests to
243
1379
  # specify how many results to return in one page. The length limit is
244
1380
  # 50 characters.
245
1381
  # @return [Integer]
@@ -254,7 +1390,7 @@ module Aws::IdentityStore
254
1390
  #
255
1391
  # @!attribute [rw] filters
256
1392
  # A list of `Filter` objects, which is used in the `ListUsers` and
257
- # `ListGroups` request.
1393
+ # `ListGroups` requests.
258
1394
  # @return [Array<Types::Filter>]
259
1395
  #
260
1396
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupsRequest AWS API Documentation
@@ -307,14 +1443,14 @@ module Aws::IdentityStore
307
1443
  # @!attribute [rw] identity_store_id
308
1444
  # The globally unique identifier for the identity store, such as
309
1445
  # `d-1234567890`. In this example, `d-` is a fixed prefix, and
310
- # `1234567890` is a randomly generated string that contains number and
311
- # lower case letters. This value is generated at the time that a new
312
- # identity store is created.
1446
+ # `1234567890` is a randomly generated string that contains numbers
1447
+ # and lower case letters. This value is generated at the time that a
1448
+ # new identity store is created.
313
1449
  # @return [String]
314
1450
  #
315
1451
  # @!attribute [rw] max_results
316
1452
  # The maximum number of results to be returned per request. This
317
- # parameter is used in the `ListUsers` and `ListGroups` request to
1453
+ # parameter is used in the `ListUsers` and `ListGroups` requests to
318
1454
  # specify how many results to return in one page. The length limit is
319
1455
  # 50 characters.
320
1456
  # @return [Integer]
@@ -329,7 +1465,7 @@ module Aws::IdentityStore
329
1465
  #
330
1466
  # @!attribute [rw] filters
331
1467
  # A list of `Filter` objects, which is used in the `ListUsers` and
332
- # `ListGroups` request.
1468
+ # `ListGroups` requests.
333
1469
  # @return [Array<Types::Filter>]
334
1470
  #
335
1471
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListUsersRequest AWS API Documentation
@@ -364,23 +1500,133 @@ module Aws::IdentityStore
364
1500
  include Aws::Structure
365
1501
  end
366
1502
 
1503
+ # An object containing the identifier of a group member.
1504
+ #
1505
+ # @note MemberId is a union - when making an API calls you must set exactly one of the members.
1506
+ #
1507
+ # @note MemberId is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MemberId corresponding to the set member.
1508
+ #
1509
+ # @!attribute [rw] user_id
1510
+ # An object containing the identifiers of resources that can be
1511
+ # members.
1512
+ # @return [String]
1513
+ #
1514
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/MemberId AWS API Documentation
1515
+ #
1516
+ class MemberId < Struct.new(
1517
+ :user_id,
1518
+ :unknown)
1519
+ SENSITIVE = []
1520
+ include Aws::Structure
1521
+ include Aws::Structure::Union
1522
+
1523
+ class UserId < MemberId; end
1524
+ class Unknown < MemberId; end
1525
+ end
1526
+
1527
+ # The full name of the user.
1528
+ #
1529
+ # @note When making an API call, you may pass Name
1530
+ # data as a hash:
1531
+ #
1532
+ # {
1533
+ # formatted: "SensitiveStringType",
1534
+ # family_name: "SensitiveStringType",
1535
+ # given_name: "SensitiveStringType",
1536
+ # middle_name: "SensitiveStringType",
1537
+ # honorific_prefix: "SensitiveStringType",
1538
+ # honorific_suffix: "SensitiveStringType",
1539
+ # }
1540
+ #
1541
+ # @!attribute [rw] formatted
1542
+ # A string containing a formatted version of the name for display.
1543
+ # @return [String]
1544
+ #
1545
+ # @!attribute [rw] family_name
1546
+ # The family name of the user.
1547
+ # @return [String]
1548
+ #
1549
+ # @!attribute [rw] given_name
1550
+ # The given name of the user.
1551
+ # @return [String]
1552
+ #
1553
+ # @!attribute [rw] middle_name
1554
+ # The middle name of the user.
1555
+ # @return [String]
1556
+ #
1557
+ # @!attribute [rw] honorific_prefix
1558
+ # The honorific prefix of the user. For example, "Dr."
1559
+ # @return [String]
1560
+ #
1561
+ # @!attribute [rw] honorific_suffix
1562
+ # The honorific suffix of the user. For example, "M.D."
1563
+ # @return [String]
1564
+ #
1565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/Name AWS API Documentation
1566
+ #
1567
+ class Name < Struct.new(
1568
+ :formatted,
1569
+ :family_name,
1570
+ :given_name,
1571
+ :middle_name,
1572
+ :honorific_prefix,
1573
+ :honorific_suffix)
1574
+ SENSITIVE = [:formatted, :family_name, :given_name, :middle_name, :honorific_prefix, :honorific_suffix]
1575
+ include Aws::Structure
1576
+ end
1577
+
1578
+ # The phone number associated with the user.
1579
+ #
1580
+ # @note When making an API call, you may pass PhoneNumber
1581
+ # data as a hash:
1582
+ #
1583
+ # {
1584
+ # value: "SensitiveStringType",
1585
+ # type: "SensitiveStringType",
1586
+ # primary: false,
1587
+ # }
1588
+ #
1589
+ # @!attribute [rw] value
1590
+ # A string containing a phone number. For example, "8675309" or "+1
1591
+ # (800) 123-4567".
1592
+ # @return [String]
1593
+ #
1594
+ # @!attribute [rw] type
1595
+ # A string representing the type of a phone number. For example,
1596
+ # "Mobile."
1597
+ # @return [String]
1598
+ #
1599
+ # @!attribute [rw] primary
1600
+ # A Boolean value representing whether this is the primary phone
1601
+ # number for the associated resource.
1602
+ # @return [Boolean]
1603
+ #
1604
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/PhoneNumber AWS API Documentation
1605
+ #
1606
+ class PhoneNumber < Struct.new(
1607
+ :value,
1608
+ :type,
1609
+ :primary)
1610
+ SENSITIVE = [:value, :type, :primary]
1611
+ include Aws::Structure
1612
+ end
1613
+
367
1614
  # Indicates that a requested resource is not found.
368
1615
  #
369
1616
  # @!attribute [rw] resource_type
370
- # The type of resource in the identity store service, which is an enum
371
- # object. Valid values include USER, GROUP, and IDENTITY\_STORE.
1617
+ # An enum object indicating the type of resource in the identity store
1618
+ # service. Valid values include USER, GROUP, and IDENTITY\_STORE.
372
1619
  # @return [String]
373
1620
  #
374
1621
  # @!attribute [rw] resource_id
375
- # The identifier for a resource in the identity store, which can be
376
- # used as `UserId` or `GroupId`. The format for `ResourceId` is either
1622
+ # The identifier for a resource in the identity store that can be used
1623
+ # as `UserId` or `GroupId`. The format for `ResourceId` is either
377
1624
  # `UUID` or `1234567890-UUID`, where `UUID` is a randomly generated
378
1625
  # value for each resource when it is created and `1234567890`
379
1626
  # represents the `IdentityStoreId` string value. In the case that the
380
- # identity store is migrated from a legacy single sign-on identity
381
- # store, the `ResourceId` for that identity store will be in the
382
- # format of `UUID`. Otherwise, it will be in the `1234567890-UUID`
383
- # format.
1627
+ # identity store is migrated from a legacy SSO identity store, the
1628
+ # `ResourceId` for that identity store will be in the format of
1629
+ # `UUID`. Otherwise, it will be in the `1234567890-UUID` format.
384
1630
  # @return [String]
385
1631
  #
386
1632
  # @!attribute [rw] message
@@ -404,6 +1650,28 @@ module Aws::IdentityStore
404
1650
  include Aws::Structure
405
1651
  end
406
1652
 
1653
+ # The request would cause the number of users or groups in the identity
1654
+ # store to exceed the maximum allowed.
1655
+ #
1656
+ # @!attribute [rw] message
1657
+ # @return [String]
1658
+ #
1659
+ # @!attribute [rw] request_id
1660
+ # The identifier for each request. This value is a globally unique ID
1661
+ # that is generated by the identity store service for each sent
1662
+ # request, and is then returned inside the exception if the request
1663
+ # fails.
1664
+ # @return [String]
1665
+ #
1666
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ServiceQuotaExceededException AWS API Documentation
1667
+ #
1668
+ class ServiceQuotaExceededException < Struct.new(
1669
+ :message,
1670
+ :request_id)
1671
+ SENSITIVE = []
1672
+ include Aws::Structure
1673
+ end
1674
+
407
1675
  # Indicates that the principal has crossed the throttling limits of the
408
1676
  # API operations.
409
1677
  #
@@ -417,36 +1685,231 @@ module Aws::IdentityStore
417
1685
  # fails.
418
1686
  # @return [String]
419
1687
  #
1688
+ # @!attribute [rw] retry_after_seconds
1689
+ # The number of seconds that you would like to wait before retrying
1690
+ # the next request.
1691
+ # @return [Integer]
1692
+ #
420
1693
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ThrottlingException AWS API Documentation
421
1694
  #
422
1695
  class ThrottlingException < Struct.new(
423
1696
  :message,
424
- :request_id)
1697
+ :request_id,
1698
+ :retry_after_seconds)
1699
+ SENSITIVE = []
1700
+ include Aws::Structure
1701
+ end
1702
+
1703
+ # An entity attribute that's unique to a specific entity.
1704
+ #
1705
+ # @note When making an API call, you may pass UniqueAttribute
1706
+ # data as a hash:
1707
+ #
1708
+ # {
1709
+ # attribute_path: "AttributePath", # required
1710
+ # attribute_value: "value", # required, value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
1711
+ # }
1712
+ #
1713
+ # @!attribute [rw] attribute_path
1714
+ # A string representation of the path to a given attribute or
1715
+ # sub-attribute. Supports JMESPath.
1716
+ # @return [String]
1717
+ #
1718
+ # @!attribute [rw] attribute_value
1719
+ # The value of the attribute. This is a `Document` type. This type is
1720
+ # not supported by Java V1, Go V1, and older versions of the AWS CLI.
1721
+ # @return [Hash,Array,String,Numeric,Boolean]
1722
+ #
1723
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UniqueAttribute AWS API Documentation
1724
+ #
1725
+ class UniqueAttribute < Struct.new(
1726
+ :attribute_path,
1727
+ :attribute_value)
1728
+ SENSITIVE = []
1729
+ include Aws::Structure
1730
+ end
1731
+
1732
+ # @note When making an API call, you may pass UpdateGroupRequest
1733
+ # data as a hash:
1734
+ #
1735
+ # {
1736
+ # identity_store_id: "IdentityStoreId", # required
1737
+ # group_id: "ResourceId", # required
1738
+ # operations: [ # required
1739
+ # {
1740
+ # attribute_path: "AttributePath", # required
1741
+ # attribute_value: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
1742
+ # },
1743
+ # ],
1744
+ # }
1745
+ #
1746
+ # @!attribute [rw] identity_store_id
1747
+ # The globally unique identifier for the identity store.
1748
+ # @return [String]
1749
+ #
1750
+ # @!attribute [rw] group_id
1751
+ # The identifier for a group in the identity store.
1752
+ # @return [String]
1753
+ #
1754
+ # @!attribute [rw] operations
1755
+ # A list of `AttributeOperation` objects to apply to the requested
1756
+ # group. These operations might add, replace, or remove an attribute.
1757
+ # @return [Array<Types::AttributeOperation>]
1758
+ #
1759
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateGroupRequest AWS API Documentation
1760
+ #
1761
+ class UpdateGroupRequest < Struct.new(
1762
+ :identity_store_id,
1763
+ :group_id,
1764
+ :operations)
1765
+ SENSITIVE = []
1766
+ include Aws::Structure
1767
+ end
1768
+
1769
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateGroupResponse AWS API Documentation
1770
+ #
1771
+ class UpdateGroupResponse < Aws::EmptyStructure; end
1772
+
1773
+ # @note When making an API call, you may pass UpdateUserRequest
1774
+ # data as a hash:
1775
+ #
1776
+ # {
1777
+ # identity_store_id: "IdentityStoreId", # required
1778
+ # user_id: "ResourceId", # required
1779
+ # operations: [ # required
1780
+ # {
1781
+ # attribute_path: "AttributePath", # required
1782
+ # attribute_value: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
1783
+ # },
1784
+ # ],
1785
+ # }
1786
+ #
1787
+ # @!attribute [rw] identity_store_id
1788
+ # The globally unique identifier for the identity store.
1789
+ # @return [String]
1790
+ #
1791
+ # @!attribute [rw] user_id
1792
+ # The identifier for a user in the identity store.
1793
+ # @return [String]
1794
+ #
1795
+ # @!attribute [rw] operations
1796
+ # A list of `AttributeOperation` objects to apply to the requested
1797
+ # user. These operations might add, replace, or remove an attribute.
1798
+ # @return [Array<Types::AttributeOperation>]
1799
+ #
1800
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateUserRequest AWS API Documentation
1801
+ #
1802
+ class UpdateUserRequest < Struct.new(
1803
+ :identity_store_id,
1804
+ :user_id,
1805
+ :operations)
425
1806
  SENSITIVE = []
426
1807
  include Aws::Structure
427
1808
  end
428
1809
 
429
- # A user object, which contains a specified user’s metadata and
1810
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateUserResponse AWS API Documentation
1811
+ #
1812
+ class UpdateUserResponse < Aws::EmptyStructure; end
1813
+
1814
+ # A user object that contains a specified user’s metadata and
430
1815
  # attributes.
431
1816
  #
432
1817
  # @!attribute [rw] user_name
433
- # Contains the user’s user name value. The length limit is 128
1818
+ # A unique string used to identify the user. The length limit is 128
434
1819
  # characters. This value can consist of letters, accented characters,
435
- # symbols, numbers, and punctuation. The characters `<>;:%` are
436
- # excluded. This value is specified at the time the user is created
437
- # and stored as an attribute of the user object in the identity store.
1820
+ # symbols, numbers, and punctuation. This value is specified at the
1821
+ # time the user is created and stored as an attribute of the user
1822
+ # object in the identity store.
438
1823
  # @return [String]
439
1824
  #
440
1825
  # @!attribute [rw] user_id
441
1826
  # The identifier for a user in the identity store.
442
1827
  # @return [String]
443
1828
  #
1829
+ # @!attribute [rw] external_ids
1830
+ # A list of `ExternalId` objects that contains the identifiers issued
1831
+ # to this resource by an external identity provider.
1832
+ # @return [Array<Types::ExternalId>]
1833
+ #
1834
+ # @!attribute [rw] name
1835
+ # An object containing the user's name.
1836
+ # @return [Types::Name]
1837
+ #
1838
+ # @!attribute [rw] display_name
1839
+ # A string containing the user's name that's formatted for display
1840
+ # when the user is referenced. For example, "John Doe."
1841
+ # @return [String]
1842
+ #
1843
+ # @!attribute [rw] nick_name
1844
+ # A string containing an alternate name for the user.
1845
+ # @return [String]
1846
+ #
1847
+ # @!attribute [rw] profile_url
1848
+ # A string containing a URL that may be associated with the user.
1849
+ # @return [String]
1850
+ #
1851
+ # @!attribute [rw] emails
1852
+ # A list of `Email` objects containing email addresses associated with
1853
+ # the user.
1854
+ # @return [Array<Types::Email>]
1855
+ #
1856
+ # @!attribute [rw] addresses
1857
+ # A list of `Address` objects containing addresses associated with the
1858
+ # user.
1859
+ # @return [Array<Types::Address>]
1860
+ #
1861
+ # @!attribute [rw] phone_numbers
1862
+ # A list of `PhoneNumber` objects containing phone numbers associated
1863
+ # with the user.
1864
+ # @return [Array<Types::PhoneNumber>]
1865
+ #
1866
+ # @!attribute [rw] user_type
1867
+ # A string indicating the user's type. Possible values depend on each
1868
+ # customer's specific needs, so they are left unspecified.
1869
+ # @return [String]
1870
+ #
1871
+ # @!attribute [rw] title
1872
+ # A string containing the user's title. Possible values depend on
1873
+ # each customer's specific needs, so they are left unspecified.
1874
+ # @return [String]
1875
+ #
1876
+ # @!attribute [rw] preferred_language
1877
+ # A string containing the preferred language of the user. For example,
1878
+ # "American English" or "en-us."
1879
+ # @return [String]
1880
+ #
1881
+ # @!attribute [rw] locale
1882
+ # A string containing the user's geographical region or location.
1883
+ # @return [String]
1884
+ #
1885
+ # @!attribute [rw] timezone
1886
+ # A string containing the user's time zone.
1887
+ # @return [String]
1888
+ #
1889
+ # @!attribute [rw] identity_store_id
1890
+ # The globally unique identifier for the identity store.
1891
+ # @return [String]
1892
+ #
444
1893
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/User AWS API Documentation
445
1894
  #
446
1895
  class User < Struct.new(
447
1896
  :user_name,
448
- :user_id)
449
- SENSITIVE = [:user_name]
1897
+ :user_id,
1898
+ :external_ids,
1899
+ :name,
1900
+ :display_name,
1901
+ :nick_name,
1902
+ :profile_url,
1903
+ :emails,
1904
+ :addresses,
1905
+ :phone_numbers,
1906
+ :user_type,
1907
+ :title,
1908
+ :preferred_language,
1909
+ :locale,
1910
+ :timezone,
1911
+ :identity_store_id)
1912
+ SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
450
1913
  include Aws::Structure
451
1914
  end
452
1915