aws-sdk-identitystore 1.59.0 → 1.60.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.
@@ -22,11 +22,18 @@ module Aws::IdentityStore
22
22
  # fails.
23
23
  # @return [String]
24
24
  #
25
+ # @!attribute [rw] reason
26
+ # Indicates the reason for an access denial when returned by KMS while
27
+ # accessing a Customer Managed KMS key. For non-KMS access-denied
28
+ # errors, this field is not included.
29
+ # @return [String]
30
+ #
25
31
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/AccessDeniedException AWS API Documentation
26
32
  #
27
33
  class AccessDeniedException < Struct.new(
28
34
  :message,
29
- :request_id)
35
+ :request_id,
36
+ :reason)
30
37
  SENSITIVE = []
31
38
  include Aws::Structure
32
39
  end
@@ -273,13 +280,15 @@ module Aws::IdentityStore
273
280
  # @return [String]
274
281
  #
275
282
  # @!attribute [rw] name
276
- # An object containing the name of the user.
283
+ # An object containing the name of the user. When used in IAM Identity
284
+ # Center, this parameter is required.
277
285
  # @return [Types::Name]
278
286
  #
279
287
  # @!attribute [rw] display_name
280
288
  # A string containing the name of the user. This value is typically
281
289
  # formatted for display when the user is referenced. For example,
282
- # "John Doe."
290
+ # "John Doe." When used in IAM Identity Center, this parameter is
291
+ # required.
283
292
  # @return [String]
284
293
  #
285
294
  # @!attribute [rw] nick_name
@@ -328,6 +337,22 @@ module Aws::IdentityStore
328
337
  # A string containing the time zone of the user.
329
338
  # @return [String]
330
339
  #
340
+ # @!attribute [rw] photos
341
+ # A list of photos associated with the user. You can add up to 3
342
+ # photos per user. Each photo can include a value, type, display name,
343
+ # and primary designation.
344
+ # @return [Array<Types::Photo>]
345
+ #
346
+ # @!attribute [rw] website
347
+ # The user's personal website or blog URL. This field allows users to
348
+ # provide a link to their personal or professional website.
349
+ # @return [String]
350
+ #
351
+ # @!attribute [rw] birthdate
352
+ # The user's birthdate in YYYY-MM-DD format. This field supports
353
+ # standard date format for storing personal information.
354
+ # @return [String]
355
+ #
331
356
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateUserRequest AWS API Documentation
332
357
  #
333
358
  class CreateUserRequest < Struct.new(
@@ -344,24 +369,27 @@ module Aws::IdentityStore
344
369
  :title,
345
370
  :preferred_language,
346
371
  :locale,
347
- :timezone)
348
- SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
372
+ :timezone,
373
+ :photos,
374
+ :website,
375
+ :birthdate)
376
+ SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
349
377
  include Aws::Structure
350
378
  end
351
379
 
352
- # @!attribute [rw] user_id
353
- # The identifier of the newly created user in the identity store.
354
- # @return [String]
355
- #
356
380
  # @!attribute [rw] identity_store_id
357
381
  # The globally unique identifier for the identity store.
358
382
  # @return [String]
359
383
  #
384
+ # @!attribute [rw] user_id
385
+ # The identifier of the newly created user in the identity store.
386
+ # @return [String]
387
+ #
360
388
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateUserResponse AWS API Documentation
361
389
  #
362
390
  class CreateUserResponse < Struct.new(
363
- :user_id,
364
- :identity_store_id)
391
+ :identity_store_id,
392
+ :user_id)
365
393
  SENSITIVE = []
366
394
  include Aws::Structure
367
395
  end
@@ -462,13 +490,35 @@ module Aws::IdentityStore
462
490
  # An object containing the identifier of a group member.
463
491
  # @return [Types::MemberId]
464
492
  #
493
+ # @!attribute [rw] created_at
494
+ # The date and time the group membership was created.
495
+ # @return [Time]
496
+ #
497
+ # @!attribute [rw] updated_at
498
+ # The date and time the group membership was last updated.
499
+ # @return [Time]
500
+ #
501
+ # @!attribute [rw] created_by
502
+ # The identifier of the user or system that created the group
503
+ # membership.
504
+ # @return [String]
505
+ #
506
+ # @!attribute [rw] updated_by
507
+ # The identifier of the user or system that last updated the group
508
+ # membership.
509
+ # @return [String]
510
+ #
465
511
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupMembershipResponse AWS API Documentation
466
512
  #
467
513
  class DescribeGroupMembershipResponse < Struct.new(
468
514
  :identity_store_id,
469
515
  :membership_id,
470
516
  :group_id,
471
- :member_id)
517
+ :member_id,
518
+ :created_at,
519
+ :updated_at,
520
+ :created_by,
521
+ :updated_by)
472
522
  SENSITIVE = []
473
523
  include Aws::Structure
474
524
  end
@@ -516,6 +566,22 @@ module Aws::IdentityStore
516
566
  # A string containing a description of the group.
517
567
  # @return [String]
518
568
  #
569
+ # @!attribute [rw] created_at
570
+ # The date and time the group was created.
571
+ # @return [Time]
572
+ #
573
+ # @!attribute [rw] updated_at
574
+ # The date and time the group was last updated.
575
+ # @return [Time]
576
+ #
577
+ # @!attribute [rw] created_by
578
+ # The identifier of the user or system that created the group.
579
+ # @return [String]
580
+ #
581
+ # @!attribute [rw] updated_by
582
+ # The identifier of the user or system that last updated the group.
583
+ # @return [String]
584
+ #
519
585
  # @!attribute [rw] identity_store_id
520
586
  # The globally unique identifier for the identity store.
521
587
  # @return [String]
@@ -527,6 +593,10 @@ module Aws::IdentityStore
527
593
  :display_name,
528
594
  :external_ids,
529
595
  :description,
596
+ :created_at,
597
+ :updated_at,
598
+ :created_by,
599
+ :updated_by,
530
600
  :identity_store_id)
531
601
  SENSITIVE = [:display_name, :description]
532
602
  include Aws::Structure
@@ -553,6 +623,14 @@ module Aws::IdentityStore
553
623
  include Aws::Structure
554
624
  end
555
625
 
626
+ # @!attribute [rw] identity_store_id
627
+ # The globally unique identifier for the identity store.
628
+ # @return [String]
629
+ #
630
+ # @!attribute [rw] user_id
631
+ # The identifier for a user in the identity store.
632
+ # @return [String]
633
+ #
556
634
  # @!attribute [rw] user_name
557
635
  # A unique string used to identify the user. The length limit is 128
558
636
  # characters. This value can consist of letters, accented characters,
@@ -561,10 +639,6 @@ module Aws::IdentityStore
561
639
  # object in the identity store.
562
640
  # @return [String]
563
641
  #
564
- # @!attribute [rw] user_id
565
- # The identifier for a user in the identity store.
566
- # @return [String]
567
- #
568
642
  # @!attribute [rw] external_ids
569
643
  # A list of `ExternalId` objects that contains the identifiers issued
570
644
  # to this resource by an external identity provider.
@@ -618,15 +692,48 @@ module Aws::IdentityStore
618
692
  # The time zone for a user.
619
693
  # @return [String]
620
694
  #
621
- # @!attribute [rw] identity_store_id
622
- # The globally unique identifier for the identity store.
695
+ # @!attribute [rw] user_status
696
+ # The current status of the user account.
697
+ # @return [String]
698
+ #
699
+ # @!attribute [rw] photos
700
+ # A list of photos associated with the user. Returns up to 3 photos
701
+ # with their associated metadata including type, display name, and
702
+ # primary designation.
703
+ # @return [Array<Types::Photo>]
704
+ #
705
+ # @!attribute [rw] website
706
+ # The user's personal website or blog URL. Returns the stored website
707
+ # information for the user.
708
+ # @return [String]
709
+ #
710
+ # @!attribute [rw] birthdate
711
+ # The user's birthdate in YYYY-MM-DD format. This field returns the
712
+ # stored birthdate information for the user.
713
+ # @return [String]
714
+ #
715
+ # @!attribute [rw] created_at
716
+ # The date and time the user was created.
717
+ # @return [Time]
718
+ #
719
+ # @!attribute [rw] created_by
720
+ # The identifier of the user or system that created the user.
721
+ # @return [String]
722
+ #
723
+ # @!attribute [rw] updated_at
724
+ # The date and time the user was last updated.
725
+ # @return [Time]
726
+ #
727
+ # @!attribute [rw] updated_by
728
+ # The identifier of the user or system that last updated the user.
623
729
  # @return [String]
624
730
  #
625
731
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeUserResponse AWS API Documentation
626
732
  #
627
733
  class DescribeUserResponse < Struct.new(
628
- :user_name,
734
+ :identity_store_id,
629
735
  :user_id,
736
+ :user_name,
630
737
  :external_ids,
631
738
  :name,
632
739
  :display_name,
@@ -640,8 +747,15 @@ module Aws::IdentityStore
640
747
  :preferred_language,
641
748
  :locale,
642
749
  :timezone,
643
- :identity_store_id)
644
- SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
750
+ :user_status,
751
+ :photos,
752
+ :website,
753
+ :birthdate,
754
+ :created_at,
755
+ :created_by,
756
+ :updated_at,
757
+ :updated_by)
758
+ SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
645
759
  include Aws::Structure
646
760
  end
647
761
 
@@ -699,8 +813,8 @@ module Aws::IdentityStore
699
813
  # @!attribute [rw] attribute_path
700
814
  # The attribute path that is used to specify which attribute name to
701
815
  # search. Length limit is 255 characters. For example, `UserName` is a
702
- # valid attribute path for the `ListUsers` API, and `DisplayName` is a
703
- # valid attribute path for the `ListGroups` API.
816
+ # valid attribute path for the ` ListUsers` API, and `DisplayName` is
817
+ # a valid attribute path for the ` ListGroups` API.
704
818
  # @return [String]
705
819
  #
706
820
  # @!attribute [rw] attribute_value
@@ -726,7 +840,7 @@ module Aws::IdentityStore
726
840
  # identifier. This value can be an identifier from an external
727
841
  # identity provider (IdP) that is associated with the user, the group,
728
842
  # or a unique attribute. For the unique attribute, the only valid path
729
- # is `displayName`.
843
+ # is ` displayName`.
730
844
  # @return [Types::AlternateIdentifier]
731
845
  #
732
846
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupIdRequest AWS API Documentation
@@ -805,7 +919,7 @@ module Aws::IdentityStore
805
919
  # identifier. This value can be an identifier from an external
806
920
  # identity provider (IdP) that is associated with the user, the group,
807
921
  # or a unique attribute. For the unique attribute, the only valid
808
- # paths are `userName` and `emails.value`.
922
+ # paths are ` userName` and `emails.value`.
809
923
  # @return [Types::AlternateIdentifier]
810
924
  #
811
925
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetUserIdRequest AWS API Documentation
@@ -817,19 +931,19 @@ module Aws::IdentityStore
817
931
  include Aws::Structure
818
932
  end
819
933
 
820
- # @!attribute [rw] user_id
821
- # The identifier for a user in the identity store.
822
- # @return [String]
823
- #
824
934
  # @!attribute [rw] identity_store_id
825
935
  # The globally unique identifier for the identity store.
826
936
  # @return [String]
827
937
  #
938
+ # @!attribute [rw] user_id
939
+ # The identifier for a user in the identity store.
940
+ # @return [String]
941
+ #
828
942
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetUserIdResponse AWS API Documentation
829
943
  #
830
944
  class GetUserIdResponse < Struct.new(
831
- :user_id,
832
- :identity_store_id)
945
+ :identity_store_id,
946
+ :user_id)
833
947
  SENSITIVE = []
834
948
  include Aws::Structure
835
949
  end
@@ -848,6 +962,8 @@ module Aws::IdentityStore
848
962
  # space, and nonbreaking space in this attribute. This value is
849
963
  # specified at the time the group is created and stored as an
850
964
  # attribute of the group object in the identity store.
965
+ #
966
+ # Prefix search supports a maximum of 1,000 characters for the string.
851
967
  # @return [String]
852
968
  #
853
969
  # @!attribute [rw] external_ids
@@ -859,6 +975,22 @@ module Aws::IdentityStore
859
975
  # A string containing a description of the specified group.
860
976
  # @return [String]
861
977
  #
978
+ # @!attribute [rw] created_at
979
+ # The date and time the group was created.
980
+ # @return [Time]
981
+ #
982
+ # @!attribute [rw] updated_at
983
+ # The date and time the group was last updated.
984
+ # @return [Time]
985
+ #
986
+ # @!attribute [rw] created_by
987
+ # The identifier of the user or system that created the group.
988
+ # @return [String]
989
+ #
990
+ # @!attribute [rw] updated_by
991
+ # The identifier of the user or system that last updated the group.
992
+ # @return [String]
993
+ #
862
994
  # @!attribute [rw] identity_store_id
863
995
  # The globally unique identifier for the identity store.
864
996
  # @return [String]
@@ -870,6 +1002,10 @@ module Aws::IdentityStore
870
1002
  :display_name,
871
1003
  :external_ids,
872
1004
  :description,
1005
+ :created_at,
1006
+ :updated_at,
1007
+ :created_by,
1008
+ :updated_by,
873
1009
  :identity_store_id)
874
1010
  SENSITIVE = [:display_name, :description]
875
1011
  include Aws::Structure
@@ -896,13 +1032,35 @@ module Aws::IdentityStore
896
1032
  # that the user is a member of the group.
897
1033
  # @return [Types::MemberId]
898
1034
  #
1035
+ # @!attribute [rw] created_at
1036
+ # The date and time the group membership was created.
1037
+ # @return [Time]
1038
+ #
1039
+ # @!attribute [rw] updated_at
1040
+ # The date and time the group membership was last updated.
1041
+ # @return [Time]
1042
+ #
1043
+ # @!attribute [rw] created_by
1044
+ # The identifier of the user or system that created the group
1045
+ # membership.
1046
+ # @return [String]
1047
+ #
1048
+ # @!attribute [rw] updated_by
1049
+ # The identifier of the user or system that last updated the group
1050
+ # membership.
1051
+ # @return [String]
1052
+ #
899
1053
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GroupMembership AWS API Documentation
900
1054
  #
901
1055
  class GroupMembership < Struct.new(
902
1056
  :identity_store_id,
903
1057
  :membership_id,
904
1058
  :group_id,
905
- :member_id)
1059
+ :member_id,
1060
+ :created_at,
1061
+ :updated_at,
1062
+ :created_by,
1063
+ :updated_by)
906
1064
  SENSITIVE = []
907
1065
  include Aws::Structure
908
1066
  end
@@ -1007,18 +1165,18 @@ module Aws::IdentityStore
1007
1165
  #
1008
1166
  # @!attribute [rw] max_results
1009
1167
  # The maximum number of results to be returned per request. This
1010
- # parameter is used in the `ListUsers` and `ListGroups` requests to
1168
+ # parameter is used in the ` ListUsers` and `ListGroups` requests to
1011
1169
  # specify how many results to return in one page. The length limit is
1012
1170
  # 50 characters.
1013
1171
  # @return [Integer]
1014
1172
  #
1015
1173
  # @!attribute [rw] next_token
1016
- # The pagination token used for the `ListUsers`, `ListGroups`, and
1017
- # `ListGroupMemberships` API operations. This value is generated by
1018
- # the identity store service. It is returned in the API response if
1019
- # the total results are more than the size of one page. This token is
1020
- # also returned when it is used in the API request to search for the
1021
- # next page.
1174
+ # The pagination token used for the `ListUsers`, `ListGroups`, and `
1175
+ # ListGroupMemberships` API operations. This value is generated by the
1176
+ # identity store service. It is returned in the API response if the
1177
+ # total results are more than the size of one page. This token is also
1178
+ # returned when it is used in the API request to search for the next
1179
+ # page.
1022
1180
  # @return [String]
1023
1181
  #
1024
1182
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsForMemberRequest AWS API Documentation
@@ -1038,12 +1196,12 @@ module Aws::IdentityStore
1038
1196
  # @return [Array<Types::GroupMembership>]
1039
1197
  #
1040
1198
  # @!attribute [rw] next_token
1041
- # The pagination token used for the `ListUsers`, `ListGroups`, and
1042
- # `ListGroupMemberships` API operations. This value is generated by
1043
- # the identity store service. It is returned in the API response if
1044
- # the total results are more than the size of one page. This token is
1045
- # also returned when it is used in the API request to search for the
1046
- # next page.
1199
+ # The pagination token used for the `ListUsers`, `ListGroups`, and `
1200
+ # ListGroupMemberships` API operations. This value is generated by the
1201
+ # identity store service. It is returned in the API response if the
1202
+ # total results are more than the size of one page. This token is also
1203
+ # returned when it is used in the API request to search for the next
1204
+ # page.
1047
1205
  # @return [String]
1048
1206
  #
1049
1207
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsForMemberResponse AWS API Documentation
@@ -1065,17 +1223,17 @@ module Aws::IdentityStore
1065
1223
  #
1066
1224
  # @!attribute [rw] max_results
1067
1225
  # The maximum number of results to be returned per request. This
1068
- # parameter is used in all `List` requests to specify how many results
1069
- # to return in one page.
1226
+ # parameter is used in all ` List` requests to specify how many
1227
+ # results to return in one page.
1070
1228
  # @return [Integer]
1071
1229
  #
1072
1230
  # @!attribute [rw] next_token
1073
- # The pagination token used for the `ListUsers`, `ListGroups` and
1074
- # `ListGroupMemberships` API operations. This value is generated by
1075
- # the identity store service. It is returned in the API response if
1076
- # the total results are more than the size of one page. This token is
1077
- # also returned when it is used in the API request to search for the
1078
- # next page.
1231
+ # The pagination token used for the `ListUsers`, `ListGroups` and `
1232
+ # ListGroupMemberships` API operations. This value is generated by the
1233
+ # identity store service. It is returned in the API response if the
1234
+ # total results are more than the size of one page. This token is also
1235
+ # returned when it is used in the API request to search for the next
1236
+ # page.
1079
1237
  # @return [String]
1080
1238
  #
1081
1239
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsRequest AWS API Documentation
@@ -1094,12 +1252,12 @@ module Aws::IdentityStore
1094
1252
  # @return [Array<Types::GroupMembership>]
1095
1253
  #
1096
1254
  # @!attribute [rw] next_token
1097
- # The pagination token used for the `ListUsers`, `ListGroups`, and
1098
- # `ListGroupMemberships` API operations. This value is generated by
1099
- # the identity store service. It is returned in the API response if
1100
- # the total results are more than the size of one page. This token is
1101
- # also returned when it is used in the API request to search for the
1102
- # next page.
1255
+ # The pagination token used for the `ListUsers`, `ListGroups`, and `
1256
+ # ListGroupMemberships` API operations. This value is generated by the
1257
+ # identity store service. It is returned in the API response if the
1258
+ # total results are more than the size of one page. This token is also
1259
+ # returned when it is used in the API request to search for the next
1260
+ # page.
1103
1261
  # @return [String]
1104
1262
  #
1105
1263
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsResponse AWS API Documentation
@@ -1121,7 +1279,7 @@ module Aws::IdentityStore
1121
1279
  #
1122
1280
  # @!attribute [rw] max_results
1123
1281
  # The maximum number of results to be returned per request. This
1124
- # parameter is used in the `ListUsers` and `ListGroups` requests to
1282
+ # parameter is used in the ` ListUsers` and `ListGroups` requests to
1125
1283
  # specify how many results to return in one page. The length limit is
1126
1284
  # 50 characters.
1127
1285
  # @return [Integer]
@@ -1135,8 +1293,8 @@ module Aws::IdentityStore
1135
1293
  # @return [String]
1136
1294
  #
1137
1295
  # @!attribute [rw] filters
1138
- # A list of `Filter` objects, which is used in the `ListUsers` and
1139
- # `ListGroups` requests.
1296
+ # A list of `Filter` objects, which is used in the `ListUsers` and `
1297
+ # ListGroups` requests.
1140
1298
  # @return [Array<Types::Filter>]
1141
1299
  #
1142
1300
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupsRequest AWS API Documentation
@@ -1158,7 +1316,7 @@ module Aws::IdentityStore
1158
1316
  # The pagination token used for the `ListUsers` and `ListGroups` API
1159
1317
  # operations. This value is generated by the identity store service.
1160
1318
  # It is returned in the API response if the total results are more
1161
- # than the size of one page. This token is also returned when it1 is
1319
+ # than the size of one page. This token is also returned when it is
1162
1320
  # used in the API request to search for the next page.
1163
1321
  # @return [String]
1164
1322
  #
@@ -1181,7 +1339,7 @@ module Aws::IdentityStore
1181
1339
  #
1182
1340
  # @!attribute [rw] max_results
1183
1341
  # The maximum number of results to be returned per request. This
1184
- # parameter is used in the `ListUsers` and `ListGroups` requests to
1342
+ # parameter is used in the ` ListUsers` and `ListGroups` requests to
1185
1343
  # specify how many results to return in one page. The length limit is
1186
1344
  # 50 characters.
1187
1345
  # @return [Integer]
@@ -1195,8 +1353,8 @@ module Aws::IdentityStore
1195
1353
  # @return [String]
1196
1354
  #
1197
1355
  # @!attribute [rw] filters
1198
- # A list of `Filter` objects, which is used in the `ListUsers` and
1199
- # `ListGroups` requests.
1356
+ # A list of `Filter` objects, which is used in the `ListUsers` and `
1357
+ # ListGroups` requests.
1200
1358
  # @return [Array<Types::Filter>]
1201
1359
  #
1202
1360
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListUsersRequest AWS API Documentation
@@ -1321,6 +1479,41 @@ module Aws::IdentityStore
1321
1479
  include Aws::Structure
1322
1480
  end
1323
1481
 
1482
+ # Contains information about a user's photo. Users can have up to 3
1483
+ # photos, with one designated as primary. Supports common image formats,
1484
+ # including jpg, jpeg, png, and gif.
1485
+ #
1486
+ # @!attribute [rw] value
1487
+ # The photo data or URL. Supported formats include jpg, jpeg, png, and
1488
+ # gif. This field is required for all photo entries.
1489
+ # @return [String]
1490
+ #
1491
+ # @!attribute [rw] type
1492
+ # The type of photo. This field is optional and can be used to
1493
+ # categorize different types of photos.
1494
+ # @return [String]
1495
+ #
1496
+ # @!attribute [rw] display
1497
+ # A human-readable description of the photo for display purposes. This
1498
+ # optional field provides context about the photo.
1499
+ # @return [String]
1500
+ #
1501
+ # @!attribute [rw] primary
1502
+ # Specifies whether this is the user's primary photo. Default value
1503
+ # is `false`. Only one photo can be designated as primary per user.
1504
+ # @return [Boolean]
1505
+ #
1506
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/Photo AWS API Documentation
1507
+ #
1508
+ class Photo < Struct.new(
1509
+ :value,
1510
+ :type,
1511
+ :display,
1512
+ :primary)
1513
+ SENSITIVE = [:value, :type, :display, :primary]
1514
+ include Aws::Structure
1515
+ end
1516
+
1324
1517
  # Indicates that a requested resource is not found.
1325
1518
  #
1326
1519
  # @!attribute [rw] resource_type
@@ -1333,12 +1526,18 @@ module Aws::IdentityStore
1333
1526
  # as `UserId` or `GroupId`. The format for `ResourceId` is either
1334
1527
  # `UUID` or `1234567890-UUID`, where `UUID` is a randomly generated
1335
1528
  # value for each resource when it is created and `1234567890`
1336
- # represents the `IdentityStoreId` string value. In the case that the
1529
+ # represents the ` IdentityStoreId` string value. In the case that the
1337
1530
  # identity store is migrated from a legacy SSO identity store, the
1338
1531
  # `ResourceId` for that identity store will be in the format of
1339
1532
  # `UUID`. Otherwise, it will be in the `1234567890-UUID` format.
1340
1533
  # @return [String]
1341
1534
  #
1535
+ # @!attribute [rw] reason
1536
+ # Indicates the reason for a resource not found error when the service
1537
+ # is unable to access a Customer Managed KMS key. For non-KMS
1538
+ # permission errors, this field is not included.
1539
+ # @return [String]
1540
+ #
1342
1541
  # @!attribute [rw] message
1343
1542
  # @return [String]
1344
1543
  #
@@ -1354,6 +1553,7 @@ module Aws::IdentityStore
1354
1553
  class ResourceNotFoundException < Struct.new(
1355
1554
  :resource_type,
1356
1555
  :resource_id,
1556
+ :reason,
1357
1557
  :message,
1358
1558
  :request_id)
1359
1559
  SENSITIVE = []
@@ -1399,12 +1599,19 @@ module Aws::IdentityStore
1399
1599
  # The number of seconds to wait before retrying the next request.
1400
1600
  # @return [Integer]
1401
1601
  #
1602
+ # @!attribute [rw] reason
1603
+ # Indicates the reason for the throttling error when the service is
1604
+ # unable to access a Customer Managed KMS key. For non-KMS permission
1605
+ # errors, this field is not included.
1606
+ # @return [String]
1607
+ #
1402
1608
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ThrottlingException AWS API Documentation
1403
1609
  #
1404
1610
  class ThrottlingException < Struct.new(
1405
1611
  :message,
1406
1612
  :request_id,
1407
- :retry_after_seconds)
1613
+ :retry_after_seconds,
1614
+ :reason)
1408
1615
  SENSITIVE = []
1409
1616
  include Aws::Structure
1410
1617
  end
@@ -1441,6 +1648,12 @@ module Aws::IdentityStore
1441
1648
  # @!attribute [rw] operations
1442
1649
  # A list of `AttributeOperation` objects to apply to the requested
1443
1650
  # group. These operations might add, replace, or remove an attribute.
1651
+ # For more information on the attributes that can be added, replaced,
1652
+ # or removed, see [Group][1].
1653
+ #
1654
+ #
1655
+ #
1656
+ # [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html
1444
1657
  # @return [Array<Types::AttributeOperation>]
1445
1658
  #
1446
1659
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateGroupRequest AWS API Documentation
@@ -1468,6 +1681,12 @@ module Aws::IdentityStore
1468
1681
  # @!attribute [rw] operations
1469
1682
  # A list of `AttributeOperation` objects to apply to the requested
1470
1683
  # user. These operations might add, replace, or remove an attribute.
1684
+ # For more information on the attributes that can be added, replaced,
1685
+ # or removed, see [User][1].
1686
+ #
1687
+ #
1688
+ #
1689
+ # [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html
1471
1690
  # @return [Array<Types::AttributeOperation>]
1472
1691
  #
1473
1692
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateUserRequest AWS API Documentation
@@ -1487,6 +1706,14 @@ module Aws::IdentityStore
1487
1706
  # A user object that contains the metadata and attributes for a
1488
1707
  # specified user.
1489
1708
  #
1709
+ # @!attribute [rw] identity_store_id
1710
+ # The globally unique identifier for the identity store.
1711
+ # @return [String]
1712
+ #
1713
+ # @!attribute [rw] user_id
1714
+ # The identifier for a user in the identity store.
1715
+ # @return [String]
1716
+ #
1490
1717
  # @!attribute [rw] user_name
1491
1718
  # A unique string used to identify the user. The length limit is 128
1492
1719
  # characters. This value can consist of letters, accented characters,
@@ -1495,10 +1722,6 @@ module Aws::IdentityStore
1495
1722
  # object in the identity store.
1496
1723
  # @return [String]
1497
1724
  #
1498
- # @!attribute [rw] user_id
1499
- # The identifier for a user in the identity store.
1500
- # @return [String]
1501
- #
1502
1725
  # @!attribute [rw] external_ids
1503
1726
  # A list of `ExternalId` objects that contains the identifiers issued
1504
1727
  # to this resource by an external identity provider.
@@ -1511,6 +1734,8 @@ module Aws::IdentityStore
1511
1734
  # @!attribute [rw] display_name
1512
1735
  # A string containing the name of the user that is formatted for
1513
1736
  # display when the user is referenced. For example, "John Doe."
1737
+ #
1738
+ # Prefix search supports a maximum of 1,000 characters for the string.
1514
1739
  # @return [String]
1515
1740
  #
1516
1741
  # @!attribute [rw] nick_name
@@ -1559,15 +1784,48 @@ module Aws::IdentityStore
1559
1784
  # A string containing the time zone of the user.
1560
1785
  # @return [String]
1561
1786
  #
1562
- # @!attribute [rw] identity_store_id
1563
- # The globally unique identifier for the identity store.
1787
+ # @!attribute [rw] user_status
1788
+ # The current status of the user account.
1789
+ # @return [String]
1790
+ #
1791
+ # @!attribute [rw] photos
1792
+ # A list of photos associated with the user. Users can have up to 3
1793
+ # photos with metadata including type, display name, and primary
1794
+ # designation.
1795
+ # @return [Array<Types::Photo>]
1796
+ #
1797
+ # @!attribute [rw] website
1798
+ # The user's personal website or blog URL. This field stores website
1799
+ # information for personal or professional use.
1800
+ # @return [String]
1801
+ #
1802
+ # @!attribute [rw] birthdate
1803
+ # The user's birthdate in YYYY-MM-DD format. This field stores
1804
+ # personal birthdate information for the user.
1805
+ # @return [String]
1806
+ #
1807
+ # @!attribute [rw] created_at
1808
+ # The date and time the user was created.
1809
+ # @return [Time]
1810
+ #
1811
+ # @!attribute [rw] created_by
1812
+ # The identifier of the user or system that created the user.
1813
+ # @return [String]
1814
+ #
1815
+ # @!attribute [rw] updated_at
1816
+ # The date and time the user was last updated.
1817
+ # @return [Time]
1818
+ #
1819
+ # @!attribute [rw] updated_by
1820
+ # The identifier of the user or system that last updated the user.
1564
1821
  # @return [String]
1565
1822
  #
1566
1823
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/User AWS API Documentation
1567
1824
  #
1568
1825
  class User < Struct.new(
1569
- :user_name,
1826
+ :identity_store_id,
1570
1827
  :user_id,
1828
+ :user_name,
1571
1829
  :external_ids,
1572
1830
  :name,
1573
1831
  :display_name,
@@ -1581,8 +1839,15 @@ module Aws::IdentityStore
1581
1839
  :preferred_language,
1582
1840
  :locale,
1583
1841
  :timezone,
1584
- :identity_store_id)
1585
- SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone]
1842
+ :user_status,
1843
+ :photos,
1844
+ :website,
1845
+ :birthdate,
1846
+ :created_at,
1847
+ :created_by,
1848
+ :updated_at,
1849
+ :updated_by)
1850
+ SENSITIVE = [:user_name, :display_name, :nick_name, :profile_url, :user_type, :title, :preferred_language, :locale, :timezone, :website, :birthdate]
1586
1851
  include Aws::Structure
1587
1852
  end
1588
1853
 
@@ -1598,11 +1863,18 @@ module Aws::IdentityStore
1598
1863
  # fails.
1599
1864
  # @return [String]
1600
1865
  #
1866
+ # @!attribute [rw] reason
1867
+ # Indicates the reason for the validation error when the service is
1868
+ # unable to access a Customer Managed KMS key. For non-KMS permission
1869
+ # errors, this field is not included.
1870
+ # @return [String]
1871
+ #
1601
1872
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ValidationException AWS API Documentation
1602
1873
  #
1603
1874
  class ValidationException < Struct.new(
1604
1875
  :message,
1605
- :request_id)
1876
+ :request_id,
1877
+ :reason)
1606
1878
  SENSITIVE = []
1607
1879
  include Aws::Structure
1608
1880
  end