aws-sdk-identitystore 1.18.0 → 1.19.0

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