aws-sdk-identitystore 1.74.0 → 1.76.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.
@@ -178,10 +178,20 @@ module Aws::IdentityStore
178
178
 
179
179
  # @!attribute [rw] identity_store_id
180
180
  # The globally unique identifier for the identity store.
181
+ #
182
+ # You can specify the identity store by ID or by Amazon Resource Name
183
+ # (ARN). For example, identity store ID `d-1234567890` or identity
184
+ # store ARN
185
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
181
186
  # @return [String]
182
187
  #
183
188
  # @!attribute [rw] group_id
184
189
  # The identifier for a group in the identity store.
190
+ #
191
+ # You can specify the group by ID or by Amazon Resource Name (ARN).
192
+ # For example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or
193
+ # group ARN
194
+ # `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
185
195
  # @return [String]
186
196
  #
187
197
  # @!attribute [rw] member_id
@@ -200,26 +210,38 @@ module Aws::IdentityStore
200
210
  include Aws::Structure
201
211
  end
202
212
 
213
+ # @!attribute [rw] identity_store_id
214
+ # The globally unique identifier for the identity store.
215
+ # @return [String]
216
+ #
203
217
  # @!attribute [rw] membership_id
204
218
  # The identifier for a newly created `GroupMembership` in an identity
205
219
  # store.
206
220
  # @return [String]
207
221
  #
208
- # @!attribute [rw] identity_store_id
209
- # The globally unique identifier for the identity store.
222
+ # @!attribute [rw] membership_arn
223
+ # The Amazon Resource Name (ARN) of the newly created group membership
224
+ # in the identity store. For example,
225
+ # `arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`.
210
226
  # @return [String]
211
227
  #
212
228
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateGroupMembershipResponse AWS API Documentation
213
229
  #
214
230
  class CreateGroupMembershipResponse < Struct.new(
231
+ :identity_store_id,
215
232
  :membership_id,
216
- :identity_store_id)
233
+ :membership_arn)
217
234
  SENSITIVE = []
218
235
  include Aws::Structure
219
236
  end
220
237
 
221
238
  # @!attribute [rw] identity_store_id
222
239
  # The globally unique identifier for the identity store.
240
+ #
241
+ # You can specify the identity store by ID or by Amazon Resource Name
242
+ # (ARN). For example, identity store ID `d-1234567890` or identity
243
+ # store ARN
244
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
223
245
  # @return [String]
224
246
  #
225
247
  # @!attribute [rw] display_name
@@ -243,25 +265,42 @@ module Aws::IdentityStore
243
265
  include Aws::Structure
244
266
  end
245
267
 
268
+ # @!attribute [rw] identity_store_id
269
+ # The globally unique identifier for the identity store.
270
+ # @return [String]
271
+ #
246
272
  # @!attribute [rw] group_id
247
273
  # The identifier of the newly created group in the identity store.
248
274
  # @return [String]
249
275
  #
250
- # @!attribute [rw] identity_store_id
251
- # The globally unique identifier for the identity store.
276
+ # @!attribute [rw] group_arn
277
+ # The Amazon Resource Name (ARN) of the newly created group in the
278
+ # identity store. For example,
279
+ # `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
280
+ # @return [String]
281
+ #
282
+ # @!attribute [rw] revision
283
+ # The revision of the newly created group in the identity store.
252
284
  # @return [String]
253
285
  #
254
286
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateGroupResponse AWS API Documentation
255
287
  #
256
288
  class CreateGroupResponse < Struct.new(
289
+ :identity_store_id,
257
290
  :group_id,
258
- :identity_store_id)
291
+ :group_arn,
292
+ :revision)
259
293
  SENSITIVE = []
260
294
  include Aws::Structure
261
295
  end
262
296
 
263
297
  # @!attribute [rw] identity_store_id
264
298
  # The globally unique identifier for the identity store.
299
+ #
300
+ # You can specify the identity store by ID or by Amazon Resource Name
301
+ # (ARN). For example, identity store ID `d-1234567890` or identity
302
+ # store ARN
303
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
265
304
  # @return [String]
266
305
  #
267
306
  # @!attribute [rw] user_name
@@ -394,21 +433,43 @@ module Aws::IdentityStore
394
433
  # The identifier of the newly created user in the identity store.
395
434
  # @return [String]
396
435
  #
436
+ # @!attribute [rw] user_arn
437
+ # The Amazon Resource Name (ARN) of the newly created user in the
438
+ # identity store. For example,
439
+ # `arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.
440
+ # @return [String]
441
+ #
442
+ # @!attribute [rw] revision
443
+ # The revision of the newly created user in the identity store.
444
+ # @return [String]
445
+ #
397
446
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateUserResponse AWS API Documentation
398
447
  #
399
448
  class CreateUserResponse < Struct.new(
400
449
  :identity_store_id,
401
- :user_id)
450
+ :user_id,
451
+ :user_arn,
452
+ :revision)
402
453
  SENSITIVE = []
403
454
  include Aws::Structure
404
455
  end
405
456
 
406
457
  # @!attribute [rw] identity_store_id
407
458
  # The globally unique identifier for the identity store.
459
+ #
460
+ # You can specify the identity store by ID or by Amazon Resource Name
461
+ # (ARN). For example, identity store ID `d-1234567890` or identity
462
+ # store ARN
463
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
408
464
  # @return [String]
409
465
  #
410
466
  # @!attribute [rw] membership_id
411
467
  # The identifier for a `GroupMembership` in an identity store.
468
+ #
469
+ # You can specify the group membership by ID or by Amazon Resource
470
+ # Name (ARN). For example, membership ID
471
+ # `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333` or membership ARN
472
+ # `arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`.
412
473
  # @return [String]
413
474
  #
414
475
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteGroupMembershipRequest AWS API Documentation
@@ -426,17 +487,36 @@ module Aws::IdentityStore
426
487
 
427
488
  # @!attribute [rw] identity_store_id
428
489
  # The globally unique identifier for the identity store.
490
+ #
491
+ # You can specify the identity store by ID or by Amazon Resource Name
492
+ # (ARN). For example, identity store ID `d-1234567890` or identity
493
+ # store ARN
494
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
429
495
  # @return [String]
430
496
  #
431
497
  # @!attribute [rw] group_id
432
498
  # The identifier for a group in the identity store.
499
+ #
500
+ # You can specify the group by ID or by Amazon Resource Name (ARN).
501
+ # For example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or
502
+ # group ARN
503
+ # `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
504
+ # @return [String]
505
+ #
506
+ # @!attribute [rw] revision
507
+ # The expected current revision of the group. When you provide this
508
+ # value, the group is deleted only if it matches the current revision
509
+ # of the group in the identity store. If the value doesn't match, the
510
+ # operation fails with a `ConflictException`. If you don't provide
511
+ # this value, the group is deleted regardless of its current revision.
433
512
  # @return [String]
434
513
  #
435
514
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteGroupRequest AWS API Documentation
436
515
  #
437
516
  class DeleteGroupRequest < Struct.new(
438
517
  :identity_store_id,
439
- :group_id)
518
+ :group_id,
519
+ :revision)
440
520
  SENSITIVE = []
441
521
  include Aws::Structure
442
522
  end
@@ -447,17 +527,35 @@ module Aws::IdentityStore
447
527
 
448
528
  # @!attribute [rw] identity_store_id
449
529
  # The globally unique identifier for the identity store.
530
+ #
531
+ # You can specify the identity store by ID or by Amazon Resource Name
532
+ # (ARN). For example, identity store ID `d-1234567890` or identity
533
+ # store ARN
534
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
450
535
  # @return [String]
451
536
  #
452
537
  # @!attribute [rw] user_id
453
538
  # The identifier for a user in the identity store.
539
+ #
540
+ # You can specify the user by ID or by Amazon Resource Name (ARN). For
541
+ # example, user ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` or user ARN
542
+ # `arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.
543
+ # @return [String]
544
+ #
545
+ # @!attribute [rw] revision
546
+ # The expected current revision of the user. When you provide this
547
+ # value, the user is deleted only if it matches the current revision
548
+ # of the user in the identity store. If the value doesn't match, the
549
+ # operation fails with a `ConflictException`. If you don't provide
550
+ # this value, the user is deleted regardless of its current revision.
454
551
  # @return [String]
455
552
  #
456
553
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteUserRequest AWS API Documentation
457
554
  #
458
555
  class DeleteUserRequest < Struct.new(
459
556
  :identity_store_id,
460
- :user_id)
557
+ :user_id,
558
+ :revision)
461
559
  SENSITIVE = []
462
560
  include Aws::Structure
463
561
  end
@@ -468,10 +566,20 @@ module Aws::IdentityStore
468
566
 
469
567
  # @!attribute [rw] identity_store_id
470
568
  # The globally unique identifier for the identity store.
569
+ #
570
+ # You can specify the identity store by ID or by Amazon Resource Name
571
+ # (ARN). For example, identity store ID `d-1234567890` or identity
572
+ # store ARN
573
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
471
574
  # @return [String]
472
575
  #
473
576
  # @!attribute [rw] membership_id
474
577
  # The identifier for a `GroupMembership` in an identity store.
578
+ #
579
+ # You can specify the group membership by ID or by Amazon Resource
580
+ # Name (ARN). For example, membership ID
581
+ # `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333` or membership ARN
582
+ # `arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`.
475
583
  # @return [String]
476
584
  #
477
585
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupMembershipRequest AWS API Documentation
@@ -491,6 +599,12 @@ module Aws::IdentityStore
491
599
  # The identifier for a `GroupMembership` in an identity store.
492
600
  # @return [String]
493
601
  #
602
+ # @!attribute [rw] membership_arn
603
+ # The Amazon Resource Name (ARN) of the group membership in the
604
+ # identity store. For example,
605
+ # `arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`.
606
+ # @return [String]
607
+ #
494
608
  # @!attribute [rw] group_id
495
609
  # The identifier for a group in the identity store.
496
610
  # @return [String]
@@ -522,6 +636,7 @@ module Aws::IdentityStore
522
636
  class DescribeGroupMembershipResponse < Struct.new(
523
637
  :identity_store_id,
524
638
  :membership_id,
639
+ :membership_arn,
525
640
  :group_id,
526
641
  :member_id,
527
642
  :created_at,
@@ -538,10 +653,20 @@ module Aws::IdentityStore
538
653
  # `1234567890` is a randomly generated string that contains numbers
539
654
  # and lower case letters. This value is generated at the time that a
540
655
  # new identity store is created.
656
+ #
657
+ # You can specify the identity store by ID or by Amazon Resource Name
658
+ # (ARN). For example, identity store ID `d-1234567890` or identity
659
+ # store ARN
660
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
541
661
  # @return [String]
542
662
  #
543
663
  # @!attribute [rw] group_id
544
664
  # The identifier for a group in the identity store.
665
+ #
666
+ # You can specify the group by ID or by Amazon Resource Name (ARN).
667
+ # For example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or
668
+ # group ARN
669
+ # `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
545
670
  # @return [String]
546
671
  #
547
672
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupRequest AWS API Documentation
@@ -553,10 +678,25 @@ module Aws::IdentityStore
553
678
  include Aws::Structure
554
679
  end
555
680
 
681
+ # @!attribute [rw] identity_store_id
682
+ # The globally unique identifier for the identity store.
683
+ # @return [String]
684
+ #
556
685
  # @!attribute [rw] group_id
557
686
  # The identifier for a group in the identity store.
558
687
  # @return [String]
559
688
  #
689
+ # @!attribute [rw] group_arn
690
+ # The Amazon Resource Name (ARN) of the group in the identity store.
691
+ # For example,
692
+ # `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
693
+ # @return [String]
694
+ #
695
+ # @!attribute [rw] revision
696
+ # The current revision of the group in the identity store. This value
697
+ # changes each time the group is modified.
698
+ # @return [String]
699
+ #
560
700
  # @!attribute [rw] display_name
561
701
  # The group’s display name value. The length limit is 1,024
562
702
  # characters. This value can consist of letters, accented characters,
@@ -591,36 +731,86 @@ module Aws::IdentityStore
591
731
  # The identifier of the user or system that last updated the group.
592
732
  # @return [String]
593
733
  #
594
- # @!attribute [rw] identity_store_id
595
- # The globally unique identifier for the identity store.
596
- # @return [String]
597
- #
598
734
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupResponse AWS API Documentation
599
735
  #
600
736
  class DescribeGroupResponse < Struct.new(
737
+ :identity_store_id,
601
738
  :group_id,
739
+ :group_arn,
740
+ :revision,
602
741
  :display_name,
603
742
  :external_ids,
604
743
  :description,
605
744
  :created_at,
606
745
  :updated_at,
607
746
  :created_by,
608
- :updated_by,
609
- :identity_store_id)
747
+ :updated_by)
610
748
  SENSITIVE = [:display_name, :description]
611
749
  include Aws::Structure
612
750
  end
613
751
 
752
+ # @!attribute [rw] identity_store_id
753
+ # The globally unique identifier for the identity store.
754
+ #
755
+ # You can specify the identity store by ID or by Amazon Resource Name
756
+ # (ARN). For example, identity store ID `d-1234567890` or identity
757
+ # store ARN
758
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
759
+ # @return [String]
760
+ #
761
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeIdentityStoreRequest AWS API Documentation
762
+ #
763
+ class DescribeIdentityStoreRequest < Struct.new(
764
+ :identity_store_id)
765
+ SENSITIVE = []
766
+ include Aws::Structure
767
+ end
768
+
769
+ # @!attribute [rw] identity_store_id
770
+ # The globally unique identifier for the identity store.
771
+ # @return [String]
772
+ #
773
+ # @!attribute [rw] identity_store_arn
774
+ # The Amazon Resource Name (ARN) of the identity store. For example,
775
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
776
+ # @return [String]
777
+ #
778
+ # @!attribute [rw] network_configuration
779
+ # The network configuration of the identity store. This configuration
780
+ # controls whether access through a virtual private cloud (VPC)
781
+ # endpoint is required, and which source VPCs and IP addresses are
782
+ # allowed.
783
+ # @return [Types::NetworkConfigurationDetails]
784
+ #
785
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeIdentityStoreResponse AWS API Documentation
786
+ #
787
+ class DescribeIdentityStoreResponse < Struct.new(
788
+ :identity_store_id,
789
+ :identity_store_arn,
790
+ :network_configuration)
791
+ SENSITIVE = []
792
+ include Aws::Structure
793
+ end
794
+
614
795
  # @!attribute [rw] identity_store_id
615
796
  # The globally unique identifier for the identity store, such as
616
797
  # `d-1234567890`. In this example, `d-` is a fixed prefix, and
617
798
  # `1234567890` is a randomly generated string that contains numbers
618
799
  # and lower case letters. This value is generated at the time that a
619
800
  # new identity store is created.
801
+ #
802
+ # You can specify the identity store by ID or by Amazon Resource Name
803
+ # (ARN). For example, identity store ID `d-1234567890` or identity
804
+ # store ARN
805
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
620
806
  # @return [String]
621
807
  #
622
808
  # @!attribute [rw] user_id
623
809
  # The identifier for a user in the identity store.
810
+ #
811
+ # You can specify the user by ID or by Amazon Resource Name (ARN). For
812
+ # example, user ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` or user ARN
813
+ # `arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.
624
814
  # @return [String]
625
815
  #
626
816
  # @!attribute [rw] extensions
@@ -647,6 +837,17 @@ module Aws::IdentityStore
647
837
  # The identifier for a user in the identity store.
648
838
  # @return [String]
649
839
  #
840
+ # @!attribute [rw] user_arn
841
+ # The Amazon Resource Name (ARN) of the user in the identity store.
842
+ # For example,
843
+ # `arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.
844
+ # @return [String]
845
+ #
846
+ # @!attribute [rw] revision
847
+ # The current revision of the user in the identity store. This value
848
+ # changes each time the user is modified.
849
+ # @return [String]
850
+ #
650
851
  # @!attribute [rw] user_name
651
852
  # A unique string used to identify the user. The length limit is 128
652
853
  # characters. This value can consist of letters, accented characters,
@@ -758,6 +959,8 @@ module Aws::IdentityStore
758
959
  class DescribeUserResponse < Struct.new(
759
960
  :identity_store_id,
760
961
  :user_id,
962
+ :user_arn,
963
+ :revision,
761
964
  :user_name,
762
965
  :external_ids,
763
966
  :name,
@@ -860,6 +1063,11 @@ module Aws::IdentityStore
860
1063
 
861
1064
  # @!attribute [rw] identity_store_id
862
1065
  # The globally unique identifier for the identity store.
1066
+ #
1067
+ # You can specify the identity store by ID or by Amazon Resource Name
1068
+ # (ARN). For example, identity store ID `d-1234567890` or identity
1069
+ # store ARN
1070
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
863
1071
  # @return [String]
864
1072
  #
865
1073
  # @!attribute [rw] alternate_identifier
@@ -879,29 +1087,46 @@ module Aws::IdentityStore
879
1087
  include Aws::Structure
880
1088
  end
881
1089
 
1090
+ # @!attribute [rw] identity_store_id
1091
+ # The globally unique identifier for the identity store.
1092
+ # @return [String]
1093
+ #
882
1094
  # @!attribute [rw] group_id
883
1095
  # The identifier for a group in the identity store.
884
1096
  # @return [String]
885
1097
  #
886
- # @!attribute [rw] identity_store_id
887
- # The globally unique identifier for the identity store.
1098
+ # @!attribute [rw] group_arn
1099
+ # The Amazon Resource Name (ARN) of the group in the identity store.
1100
+ # For example,
1101
+ # `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
888
1102
  # @return [String]
889
1103
  #
890
1104
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupIdResponse AWS API Documentation
891
1105
  #
892
1106
  class GetGroupIdResponse < Struct.new(
1107
+ :identity_store_id,
893
1108
  :group_id,
894
- :identity_store_id)
1109
+ :group_arn)
895
1110
  SENSITIVE = []
896
1111
  include Aws::Structure
897
1112
  end
898
1113
 
899
1114
  # @!attribute [rw] identity_store_id
900
1115
  # The globally unique identifier for the identity store.
1116
+ #
1117
+ # You can specify the identity store by ID or by Amazon Resource Name
1118
+ # (ARN). For example, identity store ID `d-1234567890` or identity
1119
+ # store ARN
1120
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
901
1121
  # @return [String]
902
1122
  #
903
1123
  # @!attribute [rw] group_id
904
1124
  # The identifier for a group in the identity store.
1125
+ #
1126
+ # You can specify the group by ID or by Amazon Resource Name (ARN).
1127
+ # For example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or
1128
+ # group ARN
1129
+ # `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
905
1130
  # @return [String]
906
1131
  #
907
1132
  # @!attribute [rw] member_id
@@ -920,25 +1145,37 @@ module Aws::IdentityStore
920
1145
  include Aws::Structure
921
1146
  end
922
1147
 
1148
+ # @!attribute [rw] identity_store_id
1149
+ # The globally unique identifier for the identity store.
1150
+ # @return [String]
1151
+ #
923
1152
  # @!attribute [rw] membership_id
924
1153
  # The identifier for a `GroupMembership` in an identity store.
925
1154
  # @return [String]
926
1155
  #
927
- # @!attribute [rw] identity_store_id
928
- # The globally unique identifier for the identity store.
1156
+ # @!attribute [rw] membership_arn
1157
+ # The Amazon Resource Name (ARN) of the group membership in the
1158
+ # identity store. For example,
1159
+ # `arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`.
929
1160
  # @return [String]
930
1161
  #
931
1162
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupMembershipIdResponse AWS API Documentation
932
1163
  #
933
1164
  class GetGroupMembershipIdResponse < Struct.new(
1165
+ :identity_store_id,
934
1166
  :membership_id,
935
- :identity_store_id)
1167
+ :membership_arn)
936
1168
  SENSITIVE = []
937
1169
  include Aws::Structure
938
1170
  end
939
1171
 
940
1172
  # @!attribute [rw] identity_store_id
941
1173
  # The globally unique identifier for the identity store.
1174
+ #
1175
+ # You can specify the identity store by ID or by Amazon Resource Name
1176
+ # (ARN). For example, identity store ID `d-1234567890` or identity
1177
+ # store ARN
1178
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
942
1179
  # @return [String]
943
1180
  #
944
1181
  # @!attribute [rw] alternate_identifier
@@ -966,11 +1203,18 @@ module Aws::IdentityStore
966
1203
  # The identifier for a user in the identity store.
967
1204
  # @return [String]
968
1205
  #
1206
+ # @!attribute [rw] user_arn
1207
+ # The Amazon Resource Name (ARN) of the user in the identity store.
1208
+ # For example,
1209
+ # `arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.
1210
+ # @return [String]
1211
+ #
969
1212
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetUserIdResponse AWS API Documentation
970
1213
  #
971
1214
  class GetUserIdResponse < Struct.new(
972
1215
  :identity_store_id,
973
- :user_id)
1216
+ :user_id,
1217
+ :user_arn)
974
1218
  SENSITIVE = []
975
1219
  include Aws::Structure
976
1220
  end
@@ -978,10 +1222,29 @@ module Aws::IdentityStore
978
1222
  # A group object that contains the metadata and attributes for a
979
1223
  # specified group.
980
1224
  #
1225
+ # @!attribute [rw] identity_store_id
1226
+ # The globally unique identifier for the identity store.
1227
+ # @return [String]
1228
+ #
981
1229
  # @!attribute [rw] group_id
982
1230
  # The identifier for a group in the identity store.
983
1231
  # @return [String]
984
1232
  #
1233
+ # @!attribute [rw] group_arn
1234
+ # The Amazon Resource Name (ARN) of the group in the identity store.
1235
+ # For example,
1236
+ # `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
1237
+ # @return [String]
1238
+ #
1239
+ # @!attribute [rw] revision
1240
+ # The current revision of the group in the identity store. This value
1241
+ # changes each time the group is modified. You can provide it as the
1242
+ # `Revision` parameter of an `UpdateGroup` or `DeleteGroup` request to
1243
+ # make the operation conditional on the group not having changed.
1244
+ # Treat this value as an opaque token: don't parse it or rely on its
1245
+ # format or ordering.
1246
+ # @return [String]
1247
+ #
985
1248
  # @!attribute [rw] display_name
986
1249
  # The display name value for the group. The length limit is 1,024
987
1250
  # characters. This value can consist of letters, accented characters,
@@ -1018,22 +1281,20 @@ module Aws::IdentityStore
1018
1281
  # The identifier of the user or system that last updated the group.
1019
1282
  # @return [String]
1020
1283
  #
1021
- # @!attribute [rw] identity_store_id
1022
- # The globally unique identifier for the identity store.
1023
- # @return [String]
1024
- #
1025
1284
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/Group AWS API Documentation
1026
1285
  #
1027
1286
  class Group < Struct.new(
1287
+ :identity_store_id,
1028
1288
  :group_id,
1289
+ :group_arn,
1290
+ :revision,
1029
1291
  :display_name,
1030
1292
  :external_ids,
1031
1293
  :description,
1032
1294
  :created_at,
1033
1295
  :updated_at,
1034
1296
  :created_by,
1035
- :updated_by,
1036
- :identity_store_id)
1297
+ :updated_by)
1037
1298
  SENSITIVE = [:display_name, :description]
1038
1299
  include Aws::Structure
1039
1300
  end
@@ -1049,6 +1310,12 @@ module Aws::IdentityStore
1049
1310
  # The identifier for a `GroupMembership` object in an identity store.
1050
1311
  # @return [String]
1051
1312
  #
1313
+ # @!attribute [rw] membership_arn
1314
+ # The Amazon Resource Name (ARN) of the group membership in the
1315
+ # identity store. For example,
1316
+ # `arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`.
1317
+ # @return [String]
1318
+ #
1052
1319
  # @!attribute [rw] group_id
1053
1320
  # The identifier for a group in the identity store.
1054
1321
  # @return [String]
@@ -1082,6 +1349,7 @@ module Aws::IdentityStore
1082
1349
  class GroupMembership < Struct.new(
1083
1350
  :identity_store_id,
1084
1351
  :membership_id,
1352
+ :membership_arn,
1085
1353
  :group_id,
1086
1354
  :member_id,
1087
1355
  :created_at,
@@ -1119,6 +1387,27 @@ module Aws::IdentityStore
1119
1387
  include Aws::Structure
1120
1388
  end
1121
1389
 
1390
+ # A structure that contains the identifiers for an identity store: its
1391
+ # globally unique identifier (ID) and Amazon Resource Name (ARN).
1392
+ #
1393
+ # @!attribute [rw] identity_store_id
1394
+ # The globally unique identifier for the identity store.
1395
+ # @return [String]
1396
+ #
1397
+ # @!attribute [rw] identity_store_arn
1398
+ # The Amazon Resource Name (ARN) of the identity store. For example,
1399
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
1400
+ # @return [String]
1401
+ #
1402
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/IdentityStore AWS API Documentation
1403
+ #
1404
+ class IdentityStore < Struct.new(
1405
+ :identity_store_id,
1406
+ :identity_store_arn)
1407
+ SENSITIVE = []
1408
+ include Aws::Structure
1409
+ end
1410
+
1122
1411
  # The request processing has failed because of an unknown error,
1123
1412
  # exception or failure with an internal server.
1124
1413
  #
@@ -1148,6 +1437,11 @@ module Aws::IdentityStore
1148
1437
 
1149
1438
  # @!attribute [rw] identity_store_id
1150
1439
  # The globally unique identifier for the identity store.
1440
+ #
1441
+ # You can specify the identity store by ID or by Amazon Resource Name
1442
+ # (ARN). For example, identity store ID `d-1234567890` or identity
1443
+ # store ARN
1444
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
1151
1445
  # @return [String]
1152
1446
  #
1153
1447
  # @!attribute [rw] member_id
@@ -1156,6 +1450,11 @@ module Aws::IdentityStore
1156
1450
  #
1157
1451
  # @!attribute [rw] group_ids
1158
1452
  # A list of identifiers for groups in the identity store.
1453
+ #
1454
+ # You can specify each group by ID or by Amazon Resource Name (ARN).
1455
+ # For example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or
1456
+ # group ARN
1457
+ # `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
1159
1458
  # @return [Array<String>]
1160
1459
  #
1161
1460
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/IsMemberInGroupsRequest AWS API Documentation
@@ -1182,6 +1481,11 @@ module Aws::IdentityStore
1182
1481
 
1183
1482
  # @!attribute [rw] identity_store_id
1184
1483
  # The globally unique identifier for the identity store.
1484
+ #
1485
+ # You can specify the identity store by ID or by Amazon Resource Name
1486
+ # (ARN). For example, identity store ID `d-1234567890` or identity
1487
+ # store ARN
1488
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
1185
1489
  # @return [String]
1186
1490
  #
1187
1491
  # @!attribute [rw] member_id
@@ -1192,9 +1496,8 @@ module Aws::IdentityStore
1192
1496
  #
1193
1497
  # @!attribute [rw] max_results
1194
1498
  # The maximum number of results to be returned per request. This
1195
- # parameter is used in the ` ListUsers` and `ListGroups` requests to
1196
- # specify how many results to return in one page. The length limit is
1197
- # 50 characters.
1499
+ # parameter is used in all `List` requests to specify how many results
1500
+ # to return in one page.
1198
1501
  # @return [Integer]
1199
1502
  #
1200
1503
  # @!attribute [rw] next_token
@@ -1202,8 +1505,8 @@ module Aws::IdentityStore
1202
1505
  # ListGroupMemberships` API operations. This value is generated by the
1203
1506
  # identity store service. It is returned in the API response if the
1204
1507
  # total results are more than the size of one page. This token is also
1205
- # returned when it is used in the API request to search for the next
1206
- # page.
1508
+ # returned when it is used in the API request to retrieve the next
1509
+ # page of results.
1207
1510
  # @return [String]
1208
1511
  #
1209
1512
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsForMemberRequest AWS API Documentation
@@ -1227,8 +1530,8 @@ module Aws::IdentityStore
1227
1530
  # ListGroupMemberships` API operations. This value is generated by the
1228
1531
  # identity store service. It is returned in the API response if the
1229
1532
  # total results are more than the size of one page. This token is also
1230
- # returned when it is used in the API request to search for the next
1231
- # page.
1533
+ # returned when it is used in the API request to retrieve the next
1534
+ # page of results.
1232
1535
  # @return [String]
1233
1536
  #
1234
1537
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsForMemberResponse AWS API Documentation
@@ -1242,10 +1545,20 @@ module Aws::IdentityStore
1242
1545
 
1243
1546
  # @!attribute [rw] identity_store_id
1244
1547
  # The globally unique identifier for the identity store.
1548
+ #
1549
+ # You can specify the identity store by ID or by Amazon Resource Name
1550
+ # (ARN). For example, identity store ID `d-1234567890` or identity
1551
+ # store ARN
1552
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
1245
1553
  # @return [String]
1246
1554
  #
1247
1555
  # @!attribute [rw] group_id
1248
1556
  # The identifier for a group in the identity store.
1557
+ #
1558
+ # You can specify the group by ID or by Amazon Resource Name (ARN).
1559
+ # For example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or
1560
+ # group ARN
1561
+ # `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
1249
1562
  # @return [String]
1250
1563
  #
1251
1564
  # @!attribute [rw] max_results
@@ -1259,8 +1572,8 @@ module Aws::IdentityStore
1259
1572
  # ListGroupMemberships` API operations. This value is generated by the
1260
1573
  # identity store service. It is returned in the API response if the
1261
1574
  # total results are more than the size of one page. This token is also
1262
- # returned when it is used in the API request to search for the next
1263
- # page.
1575
+ # returned when it is used in the API request to retrieve the next
1576
+ # page of results.
1264
1577
  # @return [String]
1265
1578
  #
1266
1579
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsRequest AWS API Documentation
@@ -1283,8 +1596,8 @@ module Aws::IdentityStore
1283
1596
  # ListGroupMemberships` API operations. This value is generated by the
1284
1597
  # identity store service. It is returned in the API response if the
1285
1598
  # total results are more than the size of one page. This token is also
1286
- # returned when it is used in the API request to search for the next
1287
- # page.
1599
+ # returned when it is used in the API request to retrieve the next
1600
+ # page of results.
1288
1601
  # @return [String]
1289
1602
  #
1290
1603
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsResponse AWS API Documentation
@@ -1302,13 +1615,17 @@ module Aws::IdentityStore
1302
1615
  # `1234567890` is a randomly generated string that contains numbers
1303
1616
  # and lower case letters. This value is generated at the time that a
1304
1617
  # new identity store is created.
1618
+ #
1619
+ # You can specify the identity store by ID or by Amazon Resource Name
1620
+ # (ARN). For example, identity store ID `d-1234567890` or identity
1621
+ # store ARN
1622
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
1305
1623
  # @return [String]
1306
1624
  #
1307
1625
  # @!attribute [rw] max_results
1308
1626
  # The maximum number of results to be returned per request. This
1309
- # parameter is used in the ` ListUsers` and `ListGroups` requests to
1310
- # specify how many results to return in one page. The length limit is
1311
- # 50 characters.
1627
+ # parameter is used in all `List` requests to specify how many results
1628
+ # to return in one page.
1312
1629
  # @return [Integer]
1313
1630
  #
1314
1631
  # @!attribute [rw] next_token
@@ -1316,7 +1633,7 @@ module Aws::IdentityStore
1316
1633
  # operations. This value is generated by the identity store service.
1317
1634
  # It is returned in the API response if the total results are more
1318
1635
  # than the size of one page. This token is also returned when it is
1319
- # used in the API request to search for the next page.
1636
+ # used in the API request to retrieve the next page of results.
1320
1637
  # @return [String]
1321
1638
  #
1322
1639
  # @!attribute [rw] filters
@@ -1344,7 +1661,7 @@ module Aws::IdentityStore
1344
1661
  # operations. This value is generated by the identity store service.
1345
1662
  # It is returned in the API response if the total results are more
1346
1663
  # than the size of one page. This token is also returned when it is
1347
- # used in the API request to search for the next page.
1664
+ # used in the API request to retrieve the next page of results.
1348
1665
  # @return [String]
1349
1666
  #
1350
1667
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupsResponse AWS API Documentation
@@ -1356,12 +1673,63 @@ module Aws::IdentityStore
1356
1673
  include Aws::Structure
1357
1674
  end
1358
1675
 
1676
+ # @!attribute [rw] max_results
1677
+ # The maximum number of results to return per request. This parameter
1678
+ # is used in all ` List` operations to specify how many results to
1679
+ # return on one page. If you don't specify a value, the operation
1680
+ # uses a default page size.
1681
+ # @return [Integer]
1682
+ #
1683
+ # @!attribute [rw] next_token
1684
+ # The pagination token used for the `ListIdentityStores` API
1685
+ # operation. This value is generated by the identity store service. It
1686
+ # is returned in the API response if the total results are more than
1687
+ # the size of one page. This token is also returned when it is used in
1688
+ # the API request to retrieve the next page of results.
1689
+ # @return [String]
1690
+ #
1691
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListIdentityStoresRequest AWS API Documentation
1692
+ #
1693
+ class ListIdentityStoresRequest < Struct.new(
1694
+ :max_results,
1695
+ :next_token)
1696
+ SENSITIVE = []
1697
+ include Aws::Structure
1698
+ end
1699
+
1700
+ # @!attribute [rw] identity_stores
1701
+ # A list of `IdentityStore` objects, each of which contains the
1702
+ # identifiers for an identity store that you have access to.
1703
+ # @return [Array<Types::IdentityStore>]
1704
+ #
1705
+ # @!attribute [rw] next_token
1706
+ # The pagination token used for the `ListIdentityStores` API
1707
+ # operation. This value is generated by the identity store service. It
1708
+ # is returned in the API response if the total results are more than
1709
+ # the size of one page. This token is also returned when it is used in
1710
+ # the API request to retrieve the next page of results.
1711
+ # @return [String]
1712
+ #
1713
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListIdentityStoresResponse AWS API Documentation
1714
+ #
1715
+ class ListIdentityStoresResponse < Struct.new(
1716
+ :identity_stores,
1717
+ :next_token)
1718
+ SENSITIVE = []
1719
+ include Aws::Structure
1720
+ end
1721
+
1359
1722
  # @!attribute [rw] identity_store_id
1360
1723
  # The globally unique identifier for the identity store, such as
1361
1724
  # `d-1234567890`. In this example, `d-` is a fixed prefix, and
1362
1725
  # `1234567890` is a randomly generated string that contains numbers
1363
1726
  # and lower case letters. This value is generated at the time that a
1364
1727
  # new identity store is created.
1728
+ #
1729
+ # You can specify the identity store by ID or by Amazon Resource Name
1730
+ # (ARN). For example, identity store ID `d-1234567890` or identity
1731
+ # store ARN
1732
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
1365
1733
  # @return [String]
1366
1734
  #
1367
1735
  # @!attribute [rw] extensions
@@ -1372,9 +1740,8 @@ module Aws::IdentityStore
1372
1740
  #
1373
1741
  # @!attribute [rw] max_results
1374
1742
  # The maximum number of results to be returned per request. This
1375
- # parameter is used in the ` ListUsers` and `ListGroups` requests to
1376
- # specify how many results to return in one page. The length limit is
1377
- # 50 characters.
1743
+ # parameter is used in all `List` requests to specify how many results
1744
+ # to return in one page.
1378
1745
  # @return [Integer]
1379
1746
  #
1380
1747
  # @!attribute [rw] next_token
@@ -1382,7 +1749,7 @@ module Aws::IdentityStore
1382
1749
  # operations. This value is generated by the identity store service.
1383
1750
  # It is returned in the API response if the total results are more
1384
1751
  # than the size of one page. This token is also returned when it is
1385
- # used in the API request to search for the next page.
1752
+ # used in the API request to retrieve the next page of results.
1386
1753
  # @return [String]
1387
1754
  #
1388
1755
  # @!attribute [rw] filters
@@ -1411,7 +1778,7 @@ module Aws::IdentityStore
1411
1778
  # operations. This value is generated by the identity store service.
1412
1779
  # It is returned in the API response if the total results are more
1413
1780
  # than the size of one page. This token is also returned when it is
1414
- # used in the API request to search for the next page.
1781
+ # used in the API request to retrieve the next page of results.
1415
1782
  # @return [String]
1416
1783
  #
1417
1784
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListUsersResponse AWS API Documentation
@@ -1430,8 +1797,11 @@ module Aws::IdentityStore
1430
1797
  # @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.
1431
1798
  #
1432
1799
  # @!attribute [rw] user_id
1433
- # An object containing the identifiers of resources that can be
1434
- # members.
1800
+ # The identifier for a user in the identity store.
1801
+ #
1802
+ # You can specify the user by ID or by Amazon Resource Name (ARN). For
1803
+ # example, user ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` or user ARN
1804
+ # `arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.
1435
1805
  # @return [String]
1436
1806
  #
1437
1807
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/MemberId AWS API Documentation
@@ -1486,6 +1856,110 @@ module Aws::IdentityStore
1486
1856
  include Aws::Structure
1487
1857
  end
1488
1858
 
1859
+ # The network configuration that controls how an identity store can be
1860
+ # accessed. You provide this object in a request.
1861
+ #
1862
+ # @!attribute [rw] vpce_access_required
1863
+ # Specifies whether the identity store can be accessed only through a
1864
+ # virtual private cloud (VPC) endpoint. When set to `true`, requests
1865
+ # must originate from a VPC endpoint.
1866
+ #
1867
+ # This value must be set to either `true` or `false` when you provide
1868
+ # `NetworkConfiguration` in a request.
1869
+ # @return [Boolean]
1870
+ #
1871
+ # @!attribute [rw] api_restrict_source_vpcs
1872
+ # A list of virtual private cloud (VPC) IDs that are allowed to access
1873
+ # the identity store API operations. A request is denied unless it
1874
+ # originates from a VPC in this list, or from an IP address in
1875
+ # `ApiAllowSourceIps` if you specified one. If you don't specify a
1876
+ # value, access isn't restricted to specific VPCs, but the VPC
1877
+ # endpoint requirement set by `VpceAccessRequired` still applies.
1878
+ # @return [Array<String>]
1879
+ #
1880
+ # @!attribute [rw] api_allow_source_ips
1881
+ # A list of IP address CIDR ranges that are allowed to access the
1882
+ # identity store API operations. A request from an IP address in this
1883
+ # list bypasses the identity store's other API network controls:
1884
+ # it's permitted even if it doesn't come through a VPC endpoint
1885
+ # required by `VpceAccessRequired`, and even if it doesn't originate
1886
+ # from a VPC in `ApiRestrictSourceVpcs`. If you don't specify a
1887
+ # value, no such IP address exception applies.
1888
+ # @return [Array<String>]
1889
+ #
1890
+ # @!attribute [rw] scim_allow_source_ips
1891
+ # A list of IP address CIDR ranges that are allowed to access the
1892
+ # identity store through the System for Cross-domain Identity
1893
+ # Management (SCIM) protocol. Requests from IP addresses outside these
1894
+ # ranges are denied. If you don't specify a value, SCIM requests
1895
+ # remain subject to the identity store's other network controls, such
1896
+ # as the VPC endpoint requirement set by `VpceAccessRequired`.
1897
+ #
1898
+ # For example, to allow SCIM traffic from the public internet while
1899
+ # still requiring the identity store API operations to be accessed
1900
+ # through a VPC endpoint, set `VpceAccessRequired` to `true` and set
1901
+ # this value to `0.0.0.0/0`.
1902
+ # @return [Array<String>]
1903
+ #
1904
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/NetworkConfiguration AWS API Documentation
1905
+ #
1906
+ class NetworkConfiguration < Struct.new(
1907
+ :vpce_access_required,
1908
+ :api_restrict_source_vpcs,
1909
+ :api_allow_source_ips,
1910
+ :scim_allow_source_ips)
1911
+ SENSITIVE = []
1912
+ include Aws::Structure
1913
+ end
1914
+
1915
+ # The network configuration that controls how an identity store can be
1916
+ # accessed. This object is returned as part of service API responses.
1917
+ #
1918
+ # @!attribute [rw] vpce_access_required
1919
+ # Specifies whether the identity store can be accessed only through a
1920
+ # virtual private cloud (VPC) endpoint. When set to `true`, requests
1921
+ # must originate from a VPC endpoint.
1922
+ # @return [Boolean]
1923
+ #
1924
+ # @!attribute [rw] api_restrict_source_vpcs
1925
+ # A list of virtual private cloud (VPC) IDs that are allowed to access
1926
+ # the identity store API operations. A request is denied unless it
1927
+ # originates from a VPC in this list, or from an IP address in
1928
+ # `ApiAllowSourceIps` if one is configured. If this field is empty,
1929
+ # access isn't restricted to specific VPCs, but the VPC endpoint
1930
+ # requirement from `VpceAccessRequired` still applies.
1931
+ # @return [Array<String>]
1932
+ #
1933
+ # @!attribute [rw] api_allow_source_ips
1934
+ # A list of IP address CIDR ranges that are allowed to access the
1935
+ # identity store API operations. A request from an IP address in this
1936
+ # list bypasses the identity store's other API network controls:
1937
+ # it's permitted even if it doesn't come through a VPC endpoint
1938
+ # required by `VpceAccessRequired`, and even if it doesn't originate
1939
+ # from a VPC in `ApiRestrictSourceVpcs`. If this field is empty, no
1940
+ # such IP address exception applies.
1941
+ # @return [Array<String>]
1942
+ #
1943
+ # @!attribute [rw] scim_allow_source_ips
1944
+ # A list of IP address CIDR ranges that are allowed to access the
1945
+ # identity store through the System for Cross-domain Identity
1946
+ # Management (SCIM) protocol. Requests from IP addresses outside these
1947
+ # ranges are denied. If this field is empty, SCIM requests remain
1948
+ # subject to the identity store's other network controls, such as the
1949
+ # VPC endpoint requirement.
1950
+ # @return [Array<String>]
1951
+ #
1952
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/NetworkConfigurationDetails AWS API Documentation
1953
+ #
1954
+ class NetworkConfigurationDetails < Struct.new(
1955
+ :vpce_access_required,
1956
+ :api_restrict_source_vpcs,
1957
+ :api_allow_source_ips,
1958
+ :scim_allow_source_ips)
1959
+ SENSITIVE = []
1960
+ include Aws::Structure
1961
+ end
1962
+
1489
1963
  # The phone number associated with the user.
1490
1964
  #
1491
1965
  # @!attribute [rw] value
@@ -1698,10 +2172,20 @@ module Aws::IdentityStore
1698
2172
 
1699
2173
  # @!attribute [rw] identity_store_id
1700
2174
  # The globally unique identifier for the identity store.
2175
+ #
2176
+ # You can specify the identity store by ID or by Amazon Resource Name
2177
+ # (ARN). For example, identity store ID `d-1234567890` or identity
2178
+ # store ARN
2179
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
1701
2180
  # @return [String]
1702
2181
  #
1703
2182
  # @!attribute [rw] group_id
1704
2183
  # The identifier for a group in the identity store.
2184
+ #
2185
+ # You can specify the group by ID or by Amazon Resource Name (ARN).
2186
+ # For example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or
2187
+ # group ARN
2188
+ # `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
1705
2189
  # @return [String]
1706
2190
  #
1707
2191
  # @!attribute [rw] operations
@@ -1715,26 +2199,121 @@ module Aws::IdentityStore
1715
2199
  # [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html
1716
2200
  # @return [Array<Types::AttributeOperation>]
1717
2201
  #
2202
+ # @!attribute [rw] revision
2203
+ # The expected current revision of the group. When you provide this
2204
+ # value, the update is applied only if it matches the current revision
2205
+ # of the group in the identity store, which prevents you from
2206
+ # overwriting concurrent changes. If the value doesn't match, the
2207
+ # operation fails with a `ConflictException`. If you don't provide
2208
+ # this value, the update is applied unconditionally.
2209
+ # @return [String]
2210
+ #
1718
2211
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateGroupRequest AWS API Documentation
1719
2212
  #
1720
2213
  class UpdateGroupRequest < Struct.new(
1721
2214
  :identity_store_id,
1722
2215
  :group_id,
1723
- :operations)
2216
+ :operations,
2217
+ :revision)
1724
2218
  SENSITIVE = []
1725
2219
  include Aws::Structure
1726
2220
  end
1727
2221
 
2222
+ # @!attribute [rw] identity_store_id
2223
+ # The globally unique identifier for the identity store.
2224
+ # @return [String]
2225
+ #
2226
+ # @!attribute [rw] group_id
2227
+ # The identifier for a group in the identity store.
2228
+ # @return [String]
2229
+ #
2230
+ # @!attribute [rw] group_arn
2231
+ # The Amazon Resource Name (ARN) of the group in the identity store.
2232
+ # For example,
2233
+ # `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
2234
+ # @return [String]
2235
+ #
2236
+ # @!attribute [rw] revision
2237
+ # The revision of the group after the requested update is applied.
2238
+ # @return [String]
2239
+ #
1728
2240
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateGroupResponse AWS API Documentation
1729
2241
  #
1730
- class UpdateGroupResponse < Aws::EmptyStructure; end
2242
+ class UpdateGroupResponse < Struct.new(
2243
+ :identity_store_id,
2244
+ :group_id,
2245
+ :group_arn,
2246
+ :revision)
2247
+ SENSITIVE = []
2248
+ include Aws::Structure
2249
+ end
1731
2250
 
1732
2251
  # @!attribute [rw] identity_store_id
1733
2252
  # The globally unique identifier for the identity store.
2253
+ #
2254
+ # You can specify the identity store by ID or by Amazon Resource Name
2255
+ # (ARN). For example, identity store ID `d-1234567890` or identity
2256
+ # store ARN
2257
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
2258
+ # @return [String]
2259
+ #
2260
+ # @!attribute [rw] network_configuration
2261
+ # The network configuration to apply to the identity store. This
2262
+ # controls whether access through a virtual private cloud (VPC)
2263
+ # endpoint is required and the source VPCs and IP addresses that are
2264
+ # allowed to access the identity store.
2265
+ #
2266
+ # When you provide `NetworkConfiguration` in a request, the service
2267
+ # performs a full replacement of the identity store's current network
2268
+ # configuration with the values you specify. Any values that you omit
2269
+ # are cleared. To preserve or change the allowed source VPCs or IP
2270
+ # address ranges, include the complete set of values that you want in
2271
+ # the request. To clear a list, omit it; an empty list is not
2272
+ # accepted.
2273
+ # @return [Types::NetworkConfiguration]
2274
+ #
2275
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateIdentityStoreRequest AWS API Documentation
2276
+ #
2277
+ class UpdateIdentityStoreRequest < Struct.new(
2278
+ :identity_store_id,
2279
+ :network_configuration)
2280
+ SENSITIVE = []
2281
+ include Aws::Structure
2282
+ end
2283
+
2284
+ # @!attribute [rw] identity_store_id
2285
+ # The globally unique identifier for the identity store.
2286
+ # @return [String]
2287
+ #
2288
+ # @!attribute [rw] identity_store_arn
2289
+ # The Amazon Resource Name (ARN) of the identity store. For example,
2290
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
2291
+ # @return [String]
2292
+ #
2293
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateIdentityStoreResponse AWS API Documentation
2294
+ #
2295
+ class UpdateIdentityStoreResponse < Struct.new(
2296
+ :identity_store_id,
2297
+ :identity_store_arn)
2298
+ SENSITIVE = []
2299
+ include Aws::Structure
2300
+ end
2301
+
2302
+ # @!attribute [rw] identity_store_id
2303
+ # The globally unique identifier for the identity store.
2304
+ #
2305
+ # You can specify the identity store by ID or by Amazon Resource Name
2306
+ # (ARN). For example, identity store ID `d-1234567890` or identity
2307
+ # store ARN
2308
+ # `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
1734
2309
  # @return [String]
1735
2310
  #
1736
2311
  # @!attribute [rw] user_id
1737
2312
  # The identifier for a user in the identity store.
2313
+ #
2314
+ # You can specify the user by ID or by Amazon Resource Name (ARN). For
2315
+ # example, user ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` or user ARN
2316
+ # `arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.
1738
2317
  # @return [String]
1739
2318
  #
1740
2319
  # @!attribute [rw] operations
@@ -1748,19 +2327,54 @@ module Aws::IdentityStore
1748
2327
  # [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html
1749
2328
  # @return [Array<Types::AttributeOperation>]
1750
2329
  #
2330
+ # @!attribute [rw] revision
2331
+ # The expected current revision of the user. When you provide this
2332
+ # value, the update is applied only if it matches the current revision
2333
+ # of the user in the identity store, which prevents you from
2334
+ # overwriting concurrent changes. If the value doesn't match, the
2335
+ # operation fails with a `ConflictException`. If you don't provide
2336
+ # this value, the update is applied unconditionally.
2337
+ # @return [String]
2338
+ #
1751
2339
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateUserRequest AWS API Documentation
1752
2340
  #
1753
2341
  class UpdateUserRequest < Struct.new(
1754
2342
  :identity_store_id,
1755
2343
  :user_id,
1756
- :operations)
2344
+ :operations,
2345
+ :revision)
1757
2346
  SENSITIVE = []
1758
2347
  include Aws::Structure
1759
2348
  end
1760
2349
 
2350
+ # @!attribute [rw] identity_store_id
2351
+ # The globally unique identifier for the identity store.
2352
+ # @return [String]
2353
+ #
2354
+ # @!attribute [rw] user_id
2355
+ # The identifier for a user in the identity store.
2356
+ # @return [String]
2357
+ #
2358
+ # @!attribute [rw] user_arn
2359
+ # The Amazon Resource Name (ARN) of the user in the identity store.
2360
+ # For example,
2361
+ # `arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.
2362
+ # @return [String]
2363
+ #
2364
+ # @!attribute [rw] revision
2365
+ # The revision of the user after the requested update is applied.
2366
+ # @return [String]
2367
+ #
1761
2368
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateUserResponse AWS API Documentation
1762
2369
  #
1763
- class UpdateUserResponse < Aws::EmptyStructure; end
2370
+ class UpdateUserResponse < Struct.new(
2371
+ :identity_store_id,
2372
+ :user_id,
2373
+ :user_arn,
2374
+ :revision)
2375
+ SENSITIVE = []
2376
+ include Aws::Structure
2377
+ end
1764
2378
 
1765
2379
  # A user object that contains the metadata and attributes for a
1766
2380
  # specified user.
@@ -1773,6 +2387,21 @@ module Aws::IdentityStore
1773
2387
  # The identifier for a user in the identity store.
1774
2388
  # @return [String]
1775
2389
  #
2390
+ # @!attribute [rw] user_arn
2391
+ # The Amazon Resource Name (ARN) of the user in the identity store.
2392
+ # For example,
2393
+ # `arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.
2394
+ # @return [String]
2395
+ #
2396
+ # @!attribute [rw] revision
2397
+ # The current revision of the user in the identity store. This value
2398
+ # changes each time the user is modified. You can provide it as the
2399
+ # `Revision` parameter of an `UpdateUser` or `DeleteUser` request to
2400
+ # make the operation conditional on the user not having changed. Treat
2401
+ # this value as an opaque token: don't parse it or rely on its format
2402
+ # or ordering.
2403
+ # @return [String]
2404
+ #
1776
2405
  # @!attribute [rw] user_name
1777
2406
  # A unique string used to identify the user. The length limit is 128
1778
2407
  # characters. This value can consist of letters, accented characters,
@@ -1893,6 +2522,8 @@ module Aws::IdentityStore
1893
2522
  class User < Struct.new(
1894
2523
  :identity_store_id,
1895
2524
  :user_id,
2525
+ :user_arn,
2526
+ :revision,
1896
2527
  :user_name,
1897
2528
  :external_ids,
1898
2529
  :name,