@aws-sdk/client-identitystore 3.922.0 → 3.926.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.
Files changed (30) hide show
  1. package/README.md +1 -8
  2. package/dist-cjs/index.js +210 -7
  3. package/dist-es/models/models_0.js +43 -0
  4. package/dist-es/protocols/Aws_json1_1.js +163 -9
  5. package/dist-types/Identitystore.d.ts +1 -8
  6. package/dist-types/IdentitystoreClient.d.ts +1 -8
  7. package/dist-types/auth/httpAuthSchemeProvider.d.ts +1 -1
  8. package/dist-types/commands/CreateGroupCommand.d.ts +1 -9
  9. package/dist-types/commands/CreateGroupMembershipCommand.d.ts +1 -9
  10. package/dist-types/commands/CreateUserCommand.d.ts +12 -10
  11. package/dist-types/commands/DeleteGroupCommand.d.ts +1 -9
  12. package/dist-types/commands/DeleteGroupMembershipCommand.d.ts +1 -9
  13. package/dist-types/commands/DeleteUserCommand.d.ts +1 -9
  14. package/dist-types/commands/DescribeGroupCommand.d.ts +5 -7
  15. package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +5 -6
  16. package/dist-types/commands/DescribeUserCommand.d.ts +18 -8
  17. package/dist-types/commands/GetGroupIdCommand.d.ts +1 -6
  18. package/dist-types/commands/GetGroupMembershipIdCommand.d.ts +1 -6
  19. package/dist-types/commands/GetUserIdCommand.d.ts +2 -7
  20. package/dist-types/commands/IsMemberInGroupsCommand.d.ts +1 -6
  21. package/dist-types/commands/ListGroupMembershipsCommand.d.ts +5 -6
  22. package/dist-types/commands/ListGroupMembershipsForMemberCommand.d.ts +5 -6
  23. package/dist-types/commands/ListGroupsCommand.d.ts +5 -7
  24. package/dist-types/commands/ListUsersCommand.d.ts +18 -9
  25. package/dist-types/commands/UpdateGroupCommand.d.ts +2 -10
  26. package/dist-types/commands/UpdateUserCommand.d.ts +2 -10
  27. package/dist-types/index.d.ts +1 -8
  28. package/dist-types/models/models_0.d.ts +365 -202
  29. package/dist-types/ts3.4/models/models_0.d.ts +80 -6
  30. package/package.json +8 -8
@@ -1,6 +1,17 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { DocumentType as __DocumentType } from "@smithy/types";
3
3
  import { IdentitystoreServiceException as __BaseException } from "./IdentitystoreServiceException";
4
+ /**
5
+ * @public
6
+ * @enum
7
+ */
8
+ export declare const AccessDeniedExceptionReason: {
9
+ readonly KMS_ACCESS_DENIED: "KMS_ACCESS_DENIED";
10
+ };
11
+ /**
12
+ * @public
13
+ */
14
+ export type AccessDeniedExceptionReason = (typeof AccessDeniedExceptionReason)[keyof typeof AccessDeniedExceptionReason];
4
15
  /**
5
16
  * <p>You do not have sufficient access to perform this action.</p>
6
17
  * @public
@@ -10,12 +21,15 @@ export declare class AccessDeniedException extends __BaseException {
10
21
  readonly $fault: "client";
11
22
  Message?: string | undefined;
12
23
  /**
13
- * <p>The identifier for each request. This value is a globally unique ID that is generated by
14
- * the identity store service for each sent request, and is then returned inside the exception
15
- * if the request fails.</p>
24
+ * <p>The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.</p>
16
25
  * @public
17
26
  */
18
27
  RequestId?: string | undefined;
28
+ /**
29
+ * <p>Indicates the reason for an access denial when returned by KMS while accessing a Customer Managed KMS key. For non-KMS access-denied errors, this field is not included.</p>
30
+ * @public
31
+ */
32
+ Reason?: AccessDeniedExceptionReason | undefined;
19
33
  /**
20
34
  * @internal
21
35
  */
@@ -27,9 +41,7 @@ export declare class AccessDeniedException extends __BaseException {
27
41
  */
28
42
  export interface Address {
29
43
  /**
30
- * <p>The
31
- * street
32
- * of the address.</p>
44
+ * <p>The street of the address.</p>
33
45
  * @public
34
46
  */
35
47
  StreetAddress?: string | undefined;
@@ -39,9 +51,7 @@ export interface Address {
39
51
  */
40
52
  Locality?: string | undefined;
41
53
  /**
42
- * <p>The
43
- * region
44
- * of the address.</p>
54
+ * <p>The region of the address.</p>
45
55
  * @public
46
56
  */
47
57
  Region?: string | undefined;
@@ -66,8 +76,7 @@ export interface Address {
66
76
  */
67
77
  Type?: string | undefined;
68
78
  /**
69
- * <p>A Boolean value representing whether this is the primary address for the associated
70
- * resource.</p>
79
+ * <p>A Boolean value representing whether this is the primary address for the associated resource.</p>
71
80
  * @public
72
81
  */
73
82
  Primary?: boolean | undefined;
@@ -94,21 +103,18 @@ export interface ExternalId {
94
103
  */
95
104
  export interface UniqueAttribute {
96
105
  /**
97
- * <p>A string representation of the path to a given attribute or sub-attribute. Supports
98
- * JMESPath.</p>
106
+ * <p>A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.</p>
99
107
  * @public
100
108
  */
101
109
  AttributePath: string | undefined;
102
110
  /**
103
- * <p>The value of the attribute. This is a <code>Document</code> type.
104
- * This type is not supported by Java V1, Go V1, and older versions of the CLI.</p>
111
+ * <p>The value of the attribute. This is a <code>Document</code> type. This type is not supported by Java V1, Go V1, and older versions of the CLI.</p>
105
112
  * @public
106
113
  */
107
114
  AttributeValue: __DocumentType | undefined;
108
115
  }
109
116
  /**
110
- * <p>A unique identifier for a user or group that is not the primary identifier. This value can be
111
- * an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute.</p>
117
+ * <p>A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute.</p>
112
118
  * @public
113
119
  */
114
120
  export type AlternateIdentifier = AlternateIdentifier.ExternalIdMember | AlternateIdentifier.UniqueAttributeMember | AlternateIdentifier.$UnknownMember;
@@ -155,14 +161,12 @@ export declare namespace AlternateIdentifier {
155
161
  */
156
162
  export interface AttributeOperation {
157
163
  /**
158
- * <p>A string representation of the path to a given attribute or sub-attribute. Supports
159
- * JMESPath.</p>
164
+ * <p>A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.</p>
160
165
  * @public
161
166
  */
162
167
  AttributePath: string | undefined;
163
168
  /**
164
- * <p>The value of the attribute. This is a <code>Document</code> type.
165
- * This type is not supported by Java V1, Go V1, and older versions of the CLI.</p>
169
+ * <p>The value of the attribute. This is a <code>Document</code> type. This type is not supported by Java V1, Go V1, and older versions of the CLI.</p>
166
170
  * @public
167
171
  */
168
172
  AttributeValue?: __DocumentType | undefined;
@@ -177,8 +181,7 @@ export interface GetGroupIdRequest {
177
181
  */
178
182
  IdentityStoreId: string | undefined;
179
183
  /**
180
- * <p>A unique identifier for a user or group that is not the primary identifier. This value can be
181
- * an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid path is <code>displayName</code>.</p>
184
+ * <p>A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid path is <code> displayName</code>.</p>
182
185
  * @public
183
186
  */
184
187
  AlternateIdentifier: AlternateIdentifier | undefined;
@@ -208,9 +211,7 @@ export declare class InternalServerException extends __BaseException {
208
211
  $retryable: {};
209
212
  Message?: string | undefined;
210
213
  /**
211
- * <p>The identifier for each request. This value is a globally unique ID that is generated by
212
- * the identity store service for each sent request, and is then returned inside the exception
213
- * if the request fails.</p>
214
+ * <p>The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.</p>
214
215
  * @public
215
216
  */
216
217
  RequestId?: string | undefined;
@@ -224,6 +225,17 @@ export declare class InternalServerException extends __BaseException {
224
225
  */
225
226
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
226
227
  }
228
+ /**
229
+ * @public
230
+ * @enum
231
+ */
232
+ export declare const ResourceNotFoundExceptionReason: {
233
+ readonly KMS_KEY_NOT_FOUND: "KMS_KEY_NOT_FOUND";
234
+ };
235
+ /**
236
+ * @public
237
+ */
238
+ export type ResourceNotFoundExceptionReason = (typeof ResourceNotFoundExceptionReason)[keyof typeof ResourceNotFoundExceptionReason];
227
239
  /**
228
240
  * @public
229
241
  * @enum
@@ -251,15 +263,18 @@ export declare class ResourceNotFoundException extends __BaseException {
251
263
  */
252
264
  ResourceType?: ResourceType | undefined;
253
265
  /**
254
- * <p>The identifier for a resource in the identity store that can be used as <code>UserId</code> or <code>GroupId</code>. The format for <code>ResourceId</code> is either <code>UUID</code> or <code>1234567890-UUID</code>, where <code>UUID</code> is a randomly generated value for each resource when it is created and <code>1234567890</code> represents the <code>IdentityStoreId</code> string value. In the case that the identity store is migrated from a legacy SSO identity store, the <code>ResourceId</code> for that identity store will be in the format of <code>UUID</code>. Otherwise, it will be in the <code>1234567890-UUID</code> format.</p>
266
+ * <p>The identifier for a resource in the identity store that can be used as <code>UserId</code> or <code>GroupId</code>. The format for <code>ResourceId</code> is either <code>UUID</code> or <code>1234567890-UUID</code>, where <code>UUID</code> is a randomly generated value for each resource when it is created and <code>1234567890</code> represents the <code> IdentityStoreId</code> string value. In the case that the identity store is migrated from a legacy SSO identity store, the <code>ResourceId</code> for that identity store will be in the format of <code>UUID</code>. Otherwise, it will be in the <code>1234567890-UUID</code> format.</p>
255
267
  * @public
256
268
  */
257
269
  ResourceId?: string | undefined;
270
+ /**
271
+ * <p>Indicates the reason for a resource not found error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.</p>
272
+ * @public
273
+ */
274
+ Reason?: ResourceNotFoundExceptionReason | undefined;
258
275
  Message?: string | undefined;
259
276
  /**
260
- * <p>The identifier for each request. This value is a globally unique ID that is generated by
261
- * the identity store service for each sent request, and is then returned inside the exception
262
- * if the request fails.</p>
277
+ * <p>The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.</p>
263
278
  * @public
264
279
  */
265
280
  RequestId?: string | undefined;
@@ -268,6 +283,17 @@ export declare class ResourceNotFoundException extends __BaseException {
268
283
  */
269
284
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
270
285
  }
286
+ /**
287
+ * @public
288
+ * @enum
289
+ */
290
+ export declare const ThrottlingExceptionReason: {
291
+ readonly KMS_THROTTLING: "KMS_THROTTLING";
292
+ };
293
+ /**
294
+ * @public
295
+ */
296
+ export type ThrottlingExceptionReason = (typeof ThrottlingExceptionReason)[keyof typeof ThrottlingExceptionReason];
271
297
  /**
272
298
  * <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
273
299
  * @public
@@ -280,9 +306,7 @@ export declare class ThrottlingException extends __BaseException {
280
306
  };
281
307
  Message?: string | undefined;
282
308
  /**
283
- * <p>The identifier for each request. This value is a globally unique ID that is generated by
284
- * the identity store service for each sent request, and is then returned inside the exception
285
- * if the request fails.</p>
309
+ * <p>The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.</p>
286
310
  * @public
287
311
  */
288
312
  RequestId?: string | undefined;
@@ -291,11 +315,30 @@ export declare class ThrottlingException extends __BaseException {
291
315
  * @public
292
316
  */
293
317
  RetryAfterSeconds?: number | undefined;
318
+ /**
319
+ * <p>Indicates the reason for the throttling error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.</p>
320
+ * @public
321
+ */
322
+ Reason?: ThrottlingExceptionReason | undefined;
294
323
  /**
295
324
  * @internal
296
325
  */
297
326
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
298
327
  }
328
+ /**
329
+ * @public
330
+ * @enum
331
+ */
332
+ export declare const ValidationExceptionReason: {
333
+ readonly KMS_DISABLED: "KMS_DISABLED";
334
+ readonly KMS_INVALID_ARN: "KMS_INVALID_ARN";
335
+ readonly KMS_INVALID_KEY_USAGE: "KMS_INVALID_KEY_USAGE";
336
+ readonly KMS_INVALID_STATE: "KMS_INVALID_STATE";
337
+ };
338
+ /**
339
+ * @public
340
+ */
341
+ export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
299
342
  /**
300
343
  * <p>The request failed because it contains a syntax error.</p>
301
344
  * @public
@@ -305,12 +348,15 @@ export declare class ValidationException extends __BaseException {
305
348
  readonly $fault: "client";
306
349
  Message?: string | undefined;
307
350
  /**
308
- * <p>The identifier for each request. This value is a globally unique ID that is generated by
309
- * the identity store service for each sent request, and is then returned inside the exception
310
- * if the request fails.</p>
351
+ * <p>The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.</p>
311
352
  * @public
312
353
  */
313
354
  RequestId?: string | undefined;
355
+ /**
356
+ * <p>Indicates the reason for the validation error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.</p>
357
+ * @public
358
+ */
359
+ Reason?: ValidationExceptionReason | undefined;
314
360
  /**
315
361
  * @internal
316
362
  */
@@ -391,8 +437,7 @@ export interface GetUserIdRequest {
391
437
  */
392
438
  IdentityStoreId: string | undefined;
393
439
  /**
394
- * <p>A unique identifier for a user or group that is not the primary identifier. This value can be
395
- * an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid paths are <code>userName</code> and <code>emails.value</code>.</p>
440
+ * <p>A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid paths are <code> userName</code> and <code>emails.value</code>.</p>
396
441
  * @public
397
442
  */
398
443
  AlternateIdentifier: AlternateIdentifier | undefined;
@@ -402,15 +447,15 @@ export interface GetUserIdRequest {
402
447
  */
403
448
  export interface GetUserIdResponse {
404
449
  /**
405
- * <p>The identifier for a user in the identity store.</p>
450
+ * <p>The globally unique identifier for the identity store.</p>
406
451
  * @public
407
452
  */
408
- UserId: string | undefined;
453
+ IdentityStoreId: string | undefined;
409
454
  /**
410
- * <p>The globally unique identifier for the identity store.</p>
455
+ * <p>The identifier for a user in the identity store.</p>
411
456
  * @public
412
457
  */
413
- IdentityStoreId: string | undefined;
458
+ UserId: string | undefined;
414
459
  }
415
460
  /**
416
461
  * @public
@@ -425,15 +470,7 @@ export declare const ConflictExceptionReason: {
425
470
  */
426
471
  export type ConflictExceptionReason = (typeof ConflictExceptionReason)[keyof typeof ConflictExceptionReason];
427
472
  /**
428
- * <p>This request cannot be completed for one of the following reasons:</p>
429
- * <ul>
430
- * <li>
431
- * <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p>
432
- * </li>
433
- * <li>
434
- * <p>The requested resource was being concurrently modified by another request.</p>
435
- * </li>
436
- * </ul>
473
+ * <p>This request cannot be completed for one of the following reasons:</p> <ul> <li> <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p> </li> <li> <p>The requested resource was being concurrently modified by another request.</p> </li> </ul>
437
474
  * @public
438
475
  */
439
476
  export declare class ConflictException extends __BaseException {
@@ -446,15 +483,7 @@ export declare class ConflictException extends __BaseException {
446
483
  */
447
484
  RequestId?: string | undefined;
448
485
  /**
449
- * <p>This request cannot be completed for one of the following reasons:</p>
450
- * <ul>
451
- * <li>
452
- * <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p>
453
- * </li>
454
- * <li>
455
- * <p>The requested resource was being concurrently modified by another request.</p>
456
- * </li>
457
- * </ul>
486
+ * <p>This request cannot be completed for one of the following reasons:</p> <ul> <li> <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p> </li> <li> <p>The requested resource was being concurrently modified by another request.</p> </li> </ul>
458
487
  * @public
459
488
  */
460
489
  Reason?: ConflictExceptionReason | undefined;
@@ -488,8 +517,7 @@ export interface CreateGroupMembershipRequest {
488
517
  */
489
518
  export interface CreateGroupMembershipResponse {
490
519
  /**
491
- * <p>The identifier for a newly created <code>GroupMembership</code> in an identity
492
- * store.</p>
520
+ * <p>The identifier for a newly created <code>GroupMembership</code> in an identity store.</p>
493
521
  * @public
494
522
  */
495
523
  MembershipId: string | undefined;
@@ -576,6 +604,26 @@ export interface DescribeGroupMembershipResponse {
576
604
  * @public
577
605
  */
578
606
  MemberId: MemberId | undefined;
607
+ /**
608
+ * <p>The date and time the group membership was created.</p>
609
+ * @public
610
+ */
611
+ CreatedAt?: Date | undefined;
612
+ /**
613
+ * <p>The date and time the group membership was last updated.</p>
614
+ * @public
615
+ */
616
+ UpdatedAt?: Date | undefined;
617
+ /**
618
+ * <p>The identifier of the user or system that created the group membership.</p>
619
+ * @public
620
+ */
621
+ CreatedBy?: string | undefined;
622
+ /**
623
+ * <p>The identifier of the user or system that last updated the group membership.</p>
624
+ * @public
625
+ */
626
+ UpdatedBy?: string | undefined;
579
627
  }
580
628
  /**
581
629
  * @public
@@ -592,20 +640,18 @@ export interface ListGroupMembershipsRequest {
592
640
  */
593
641
  GroupId: string | undefined;
594
642
  /**
595
- * <p>The maximum number of results to be returned per request. This parameter is used in all
596
- * <code>List</code> requests to specify how many results to return in one page.</p>
643
+ * <p>The maximum number of results to be returned per request. This parameter is used in all <code> List</code> requests to specify how many results to return in one page.</p>
597
644
  * @public
598
645
  */
599
646
  MaxResults?: number | undefined;
600
647
  /**
601
- * <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code> and <code>ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</p>
648
+ * <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code> and <code> ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</p>
602
649
  * @public
603
650
  */
604
651
  NextToken?: string | undefined;
605
652
  }
606
653
  /**
607
- * <p>Contains the identifiers for a group, a group member, and a <code>GroupMembership</code>
608
- * object in the identity store.</p>
654
+ * <p>Contains the identifiers for a group, a group member, and a <code>GroupMembership</code> object in the identity store.</p>
609
655
  * @public
610
656
  */
611
657
  export interface GroupMembership {
@@ -629,6 +675,26 @@ export interface GroupMembership {
629
675
  * @public
630
676
  */
631
677
  MemberId?: MemberId | undefined;
678
+ /**
679
+ * <p>The date and time the group membership was created.</p>
680
+ * @public
681
+ */
682
+ CreatedAt?: Date | undefined;
683
+ /**
684
+ * <p>The date and time the group membership was last updated.</p>
685
+ * @public
686
+ */
687
+ UpdatedAt?: Date | undefined;
688
+ /**
689
+ * <p>The identifier of the user or system that created the group membership.</p>
690
+ * @public
691
+ */
692
+ CreatedBy?: string | undefined;
693
+ /**
694
+ * <p>The identifier of the user or system that last updated the group membership.</p>
695
+ * @public
696
+ */
697
+ UpdatedBy?: string | undefined;
632
698
  }
633
699
  /**
634
700
  * @public
@@ -640,7 +706,7 @@ export interface ListGroupMembershipsResponse {
640
706
  */
641
707
  GroupMemberships: GroupMembership[] | undefined;
642
708
  /**
643
- * <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code>, and <code>ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</p>
709
+ * <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code>, and <code> ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</p>
644
710
  * @public
645
711
  */
646
712
  NextToken?: string | undefined;
@@ -655,9 +721,7 @@ export interface CreateGroupRequest {
655
721
  */
656
722
  IdentityStoreId: string | undefined;
657
723
  /**
658
- * <p>A string containing the name of the group. This value is commonly displayed when the
659
- * group is referenced. <code>Administrator</code> and <code>AWSAdministrators</code> are
660
- * reserved names and can't be used for users or groups.</p>
724
+ * <p>A string containing the name of the group. This value is commonly displayed when the group is referenced. <code>Administrator</code> and <code>AWSAdministrators</code> are reserved names and can't be used for users or groups.</p>
661
725
  * @public
662
726
  */
663
727
  DisplayName?: string | undefined;
@@ -672,9 +736,7 @@ export interface CreateGroupRequest {
672
736
  */
673
737
  export interface CreateGroupResponse {
674
738
  /**
675
- * <p>The
676
- * identifier
677
- * of the newly created group in the identity store.</p>
739
+ * <p>The identifier of the newly created group in the identity store.</p>
678
740
  * @public
679
741
  */
680
742
  GroupId: string | undefined;
@@ -709,11 +771,7 @@ export interface DeleteGroupResponse {
709
771
  */
710
772
  export interface DescribeGroupRequest {
711
773
  /**
712
- * <p>The globally unique identifier for the identity store, such as
713
- * <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
714
- * <code>1234567890</code> is a randomly generated string that contains numbers and lower
715
- * case letters. This value is generated at the time that a new identity store is
716
- * created.</p>
774
+ * <p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p>
717
775
  * @public
718
776
  */
719
777
  IdentityStoreId: string | undefined;
@@ -733,17 +791,12 @@ export interface DescribeGroupResponse {
733
791
  */
734
792
  GroupId: string | undefined;
735
793
  /**
736
- * <p>The group’s display name value. The length limit is 1,024 characters. This
737
- * value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new
738
- * line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the
739
- * group is created and stored as an attribute of the group object in the identity
740
- * store.</p>
794
+ * <p>The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.</p>
741
795
  * @public
742
796
  */
743
797
  DisplayName?: string | undefined;
744
798
  /**
745
- * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
746
- * resource by an external identity provider.</p>
799
+ * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this resource by an external identity provider.</p>
747
800
  * @public
748
801
  */
749
802
  ExternalIds?: ExternalId[] | undefined;
@@ -752,6 +805,26 @@ export interface DescribeGroupResponse {
752
805
  * @public
753
806
  */
754
807
  Description?: string | undefined;
808
+ /**
809
+ * <p>The date and time the group was created.</p>
810
+ * @public
811
+ */
812
+ CreatedAt?: Date | undefined;
813
+ /**
814
+ * <p>The date and time the group was last updated.</p>
815
+ * @public
816
+ */
817
+ UpdatedAt?: Date | undefined;
818
+ /**
819
+ * <p>The identifier of the user or system that created the group.</p>
820
+ * @public
821
+ */
822
+ CreatedBy?: string | undefined;
823
+ /**
824
+ * <p>The identifier of the user or system that last updated the group.</p>
825
+ * @public
826
+ */
827
+ UpdatedBy?: string | undefined;
755
828
  /**
756
829
  * <p>The globally unique identifier for the identity store.</p>
757
830
  * @public
@@ -759,22 +832,17 @@ export interface DescribeGroupResponse {
759
832
  IdentityStoreId: string | undefined;
760
833
  }
761
834
  /**
762
- * <p>A query filter used by <code>ListUsers</code> and <code>ListGroups</code>. This filter
763
- * object provides the attribute name and attribute value to search users or groups.</p>
835
+ * <p>A query filter used by <code>ListUsers</code> and <code>ListGroups</code>. This filter object provides the attribute name and attribute value to search users or groups.</p>
764
836
  * @public
765
837
  */
766
838
  export interface Filter {
767
839
  /**
768
- * <p>The attribute path that is used to specify which attribute name to search. Length limit
769
- * is 255 characters. For example, <code>UserName</code> is a valid attribute path for the
770
- * <code>ListUsers</code> API, and <code>DisplayName</code> is a valid attribute path for
771
- * the <code>ListGroups</code> API.</p>
840
+ * <p>The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, <code>UserName</code> is a valid attribute path for the <code> ListUsers</code> API, and <code>DisplayName</code> is a valid attribute path for the <code> ListGroups</code> API.</p>
772
841
  * @public
773
842
  */
774
843
  AttributePath: string | undefined;
775
844
  /**
776
- * <p>Represents the data for an attribute. Each attribute value is described as a name-value
777
- * pair. </p>
845
+ * <p>Represents the data for an attribute. Each attribute value is described as a name-value pair. </p>
778
846
  * @public
779
847
  */
780
848
  AttributeValue: string | undefined;
@@ -784,32 +852,22 @@ export interface Filter {
784
852
  */
785
853
  export interface ListGroupsRequest {
786
854
  /**
787
- * <p>The globally unique identifier for the identity store, such as
788
- * <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
789
- * <code>1234567890</code> is a randomly generated string that contains numbers and lower
790
- * case letters. This value is generated at the time that a new identity store is
791
- * created.</p>
855
+ * <p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p>
792
856
  * @public
793
857
  */
794
858
  IdentityStoreId: string | undefined;
795
859
  /**
796
- * <p>The maximum number of results to be returned per request. This parameter is used in the
797
- * <code>ListUsers</code> and <code>ListGroups</code> requests to specify how many results
798
- * to return in one page. The length limit is 50 characters.</p>
860
+ * <p>The maximum number of results to be returned per request. This parameter is used in the <code> ListUsers</code> and <code>ListGroups</code> requests to specify how many results to return in one page. The length limit is 50 characters.</p>
799
861
  * @public
800
862
  */
801
863
  MaxResults?: number | undefined;
802
864
  /**
803
- * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
804
- * operations. This value is generated by the identity store service. It is returned in the
805
- * API response if the total results are more than the size of one page. This token is also
806
- * returned when it is used in the API request to search for the next page.</p>
865
+ * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</p>
807
866
  * @public
808
867
  */
809
868
  NextToken?: string | undefined;
810
869
  /**
811
- * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and
812
- * <code>ListGroups</code> requests.</p>
870
+ * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and <code> ListGroups</code> requests.</p>
813
871
  *
814
872
  * @deprecated Using filters with ListGroups API is deprecated, please use GetGroupId API instead.
815
873
  * @public
@@ -827,17 +885,12 @@ export interface Group {
827
885
  */
828
886
  GroupId: string | undefined;
829
887
  /**
830
- * <p>The display name value for the group. The length limit is 1,024 characters. This value
831
- * can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line,
832
- * carriage return, space, and nonbreaking space in this attribute. This value is specified at
833
- * the time the group is created and stored as an attribute of the group object in the
834
- * identity store.</p>
888
+ * <p>The display name value for the group. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.</p> <p>Prefix search supports a maximum of 1,000 characters for the string.</p>
835
889
  * @public
836
890
  */
837
891
  DisplayName?: string | undefined;
838
892
  /**
839
- * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
840
- * resource by an external identity provider.</p>
893
+ * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this resource by an external identity provider.</p>
841
894
  * @public
842
895
  */
843
896
  ExternalIds?: ExternalId[] | undefined;
@@ -846,6 +899,26 @@ export interface Group {
846
899
  * @public
847
900
  */
848
901
  Description?: string | undefined;
902
+ /**
903
+ * <p>The date and time the group was created.</p>
904
+ * @public
905
+ */
906
+ CreatedAt?: Date | undefined;
907
+ /**
908
+ * <p>The date and time the group was last updated.</p>
909
+ * @public
910
+ */
911
+ UpdatedAt?: Date | undefined;
912
+ /**
913
+ * <p>The identifier of the user or system that created the group.</p>
914
+ * @public
915
+ */
916
+ CreatedBy?: string | undefined;
917
+ /**
918
+ * <p>The identifier of the user or system that last updated the group.</p>
919
+ * @public
920
+ */
921
+ UpdatedBy?: string | undefined;
849
922
  /**
850
923
  * <p>The globally unique identifier for the identity store.</p>
851
924
  * @public
@@ -862,10 +935,7 @@ export interface ListGroupsResponse {
862
935
  */
863
936
  Groups: Group[] | undefined;
864
937
  /**
865
- * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
866
- * operations. This value is generated by the identity store service. It is returned in the
867
- * API response if the total results are more than the size of one page. This token is also
868
- * returned when it1 is used in the API request to search for the next page.</p>
938
+ * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</p>
869
939
  * @public
870
940
  */
871
941
  NextToken?: string | undefined;
@@ -885,8 +955,7 @@ export interface UpdateGroupRequest {
885
955
  */
886
956
  GroupId: string | undefined;
887
957
  /**
888
- * <p>A list of <code>AttributeOperation</code> objects to apply to the requested group. These
889
- * operations might add, replace, or remove an attribute.</p>
958
+ * <p>A list of <code>AttributeOperation</code> objects to apply to the requested group. These operations might add, replace, or remove an attribute. For more information on the attributes that can be added, replaced, or removed, see <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html">Group</a>.</p>
890
959
  * @public
891
960
  */
892
961
  Operations: AttributeOperation[] | undefined;
@@ -962,12 +1031,12 @@ export interface ListGroupMembershipsForMemberRequest {
962
1031
  */
963
1032
  MemberId: MemberId | undefined;
964
1033
  /**
965
- * <p>The maximum number of results to be returned per request. This parameter is used in the <code>ListUsers</code> and <code>ListGroups</code> requests to specify how many results to return in one page. The length limit is 50 characters.</p>
1034
+ * <p>The maximum number of results to be returned per request. This parameter is used in the <code> ListUsers</code> and <code>ListGroups</code> requests to specify how many results to return in one page. The length limit is 50 characters.</p>
966
1035
  * @public
967
1036
  */
968
1037
  MaxResults?: number | undefined;
969
1038
  /**
970
- * <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code>, and <code>ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</p>
1039
+ * <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code>, and <code> ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</p>
971
1040
  * @public
972
1041
  */
973
1042
  NextToken?: string | undefined;
@@ -982,8 +1051,7 @@ export interface ListGroupMembershipsForMemberResponse {
982
1051
  */
983
1052
  GroupMemberships: GroupMembership[] | undefined;
984
1053
  /**
985
- * <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code>, and <code>ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
986
- * </p>
1054
+ * <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code>, and <code> ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page. </p>
987
1055
  * @public
988
1056
  */
989
1057
  NextToken?: string | undefined;
@@ -1004,16 +1072,13 @@ export interface Email {
1004
1072
  */
1005
1073
  Type?: string | undefined;
1006
1074
  /**
1007
- * <p>A Boolean value representing whether this is the primary email address for the
1008
- * associated resource.</p>
1075
+ * <p>A Boolean value representing whether this is the primary email address for the associated resource.</p>
1009
1076
  * @public
1010
1077
  */
1011
1078
  Primary?: boolean | undefined;
1012
1079
  }
1013
1080
  /**
1014
- * <p>The
1015
- * full name
1016
- * of the user.</p>
1081
+ * <p>The full name of the user.</p>
1017
1082
  * @public
1018
1083
  */
1019
1084
  export interface Name {
@@ -1054,9 +1119,7 @@ export interface Name {
1054
1119
  */
1055
1120
  export interface PhoneNumber {
1056
1121
  /**
1057
- * <p>A string containing a phone number. For example,
1058
- * "8675309"
1059
- * or "+1 (800) 123-4567".</p>
1122
+ * <p>A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567". </p>
1060
1123
  * @public
1061
1124
  */
1062
1125
  Value?: string | undefined;
@@ -1066,8 +1129,33 @@ export interface PhoneNumber {
1066
1129
  */
1067
1130
  Type?: string | undefined;
1068
1131
  /**
1069
- * <p>A Boolean value representing whether this is the primary phone number for the associated
1070
- * resource.</p>
1132
+ * <p>A Boolean value representing whether this is the primary phone number for the associated resource.</p>
1133
+ * @public
1134
+ */
1135
+ Primary?: boolean | undefined;
1136
+ }
1137
+ /**
1138
+ * <p>Contains information about a user's photo. Users can have up to 3 photos, with one designated as primary. Supports common image formats, including jpg, jpeg, png, and gif.</p>
1139
+ * @public
1140
+ */
1141
+ export interface Photo {
1142
+ /**
1143
+ * <p>The photo data or URL. Supported formats include jpg, jpeg, png, and gif. This field is required for all photo entries.</p>
1144
+ * @public
1145
+ */
1146
+ Value: string | undefined;
1147
+ /**
1148
+ * <p>The type of photo. This field is optional and can be used to categorize different types of photos.</p>
1149
+ * @public
1150
+ */
1151
+ Type?: string | undefined;
1152
+ /**
1153
+ * <p>A human-readable description of the photo for display purposes. This optional field provides context about the photo.</p>
1154
+ * @public
1155
+ */
1156
+ Display?: string | undefined;
1157
+ /**
1158
+ * <p>Specifies whether this is the user's primary photo. Default value is <code>false</code>. Only one photo can be designated as primary per user.</p>
1071
1159
  * @public
1072
1160
  */
1073
1161
  Primary?: boolean | undefined;
@@ -1082,22 +1170,17 @@ export interface CreateUserRequest {
1082
1170
  */
1083
1171
  IdentityStoreId: string | undefined;
1084
1172
  /**
1085
- * <p>A unique string used to identify the user. The length limit is 128 characters. This
1086
- * value can consist of letters, accented characters, symbols, numbers, and punctuation. This
1087
- * value is specified at the time the user is created and stored as an attribute of the user
1088
- * object in the identity store. <code>Administrator</code> and <code>AWSAdministrators</code>
1089
- * are reserved names and can't be used for users or groups.</p>
1173
+ * <p>A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. <code>Administrator</code> and <code>AWSAdministrators</code> are reserved names and can't be used for users or groups.</p>
1090
1174
  * @public
1091
1175
  */
1092
1176
  UserName?: string | undefined;
1093
1177
  /**
1094
- * <p>An object containing the name of the user.</p>
1178
+ * <p>An object containing the name of the user. When used in IAM Identity Center, this parameter is required.</p>
1095
1179
  * @public
1096
1180
  */
1097
1181
  Name?: Name | undefined;
1098
1182
  /**
1099
- * <p>A string containing the name of the user. This value is typically formatted for display
1100
- * when the user is referenced. For example, "John Doe." </p>
1183
+ * <p>A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, "John Doe." When used in IAM Identity Center, this parameter is required.</p>
1101
1184
  * @public
1102
1185
  */
1103
1186
  DisplayName?: string | undefined;
@@ -1127,20 +1210,17 @@ export interface CreateUserRequest {
1127
1210
  */
1128
1211
  PhoneNumbers?: PhoneNumber[] | undefined;
1129
1212
  /**
1130
- * <p>A string indicating the type of user. Possible values are left unspecified. The value
1131
- * can vary based on your specific use case.</p>
1213
+ * <p>A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.</p>
1132
1214
  * @public
1133
1215
  */
1134
1216
  UserType?: string | undefined;
1135
1217
  /**
1136
- * <p>A string containing the title of the user. Possible values are left unspecified. The
1137
- * value can vary based on your specific use case.</p>
1218
+ * <p>A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.</p>
1138
1219
  * @public
1139
1220
  */
1140
1221
  Title?: string | undefined;
1141
1222
  /**
1142
- * <p>A string containing the preferred language of the user. For example, "American English"
1143
- * or "en-us."</p>
1223
+ * <p>A string containing the preferred language of the user. For example, "American English" or "en-us."</p>
1144
1224
  * @public
1145
1225
  */
1146
1226
  PreferredLanguage?: string | undefined;
@@ -1154,21 +1234,36 @@ export interface CreateUserRequest {
1154
1234
  * @public
1155
1235
  */
1156
1236
  Timezone?: string | undefined;
1237
+ /**
1238
+ * <p>A list of photos associated with the user. You can add up to 3 photos per user. Each photo can include a value, type, display name, and primary designation.</p>
1239
+ * @public
1240
+ */
1241
+ Photos?: Photo[] | undefined;
1242
+ /**
1243
+ * <p>The user's personal website or blog URL. This field allows users to provide a link to their personal or professional website.</p>
1244
+ * @public
1245
+ */
1246
+ Website?: string | undefined;
1247
+ /**
1248
+ * <p>The user's birthdate in YYYY-MM-DD format. This field supports standard date format for storing personal information.</p>
1249
+ * @public
1250
+ */
1251
+ Birthdate?: string | undefined;
1157
1252
  }
1158
1253
  /**
1159
1254
  * @public
1160
1255
  */
1161
1256
  export interface CreateUserResponse {
1162
1257
  /**
1163
- * <p>The identifier of the newly created user in the identity store.</p>
1258
+ * <p>The globally unique identifier for the identity store.</p>
1164
1259
  * @public
1165
1260
  */
1166
- UserId: string | undefined;
1261
+ IdentityStoreId: string | undefined;
1167
1262
  /**
1168
- * <p>The globally unique identifier for the identity store.</p>
1263
+ * <p>The identifier of the newly created user in the identity store.</p>
1169
1264
  * @public
1170
1265
  */
1171
- IdentityStoreId: string | undefined;
1266
+ UserId: string | undefined;
1172
1267
  }
1173
1268
  /**
1174
1269
  * @public
@@ -1195,11 +1290,7 @@ export interface DeleteUserResponse {
1195
1290
  */
1196
1291
  export interface DescribeUserRequest {
1197
1292
  /**
1198
- * <p>The globally unique identifier for the identity store, such as
1199
- * <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
1200
- * <code>1234567890</code> is a randomly generated string that contains numbers and lower
1201
- * case letters. This value is generated at the time that a new identity store is
1202
- * created.</p>
1293
+ * <p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p>
1203
1294
  * @public
1204
1295
  */
1205
1296
  IdentityStoreId: string | undefined;
@@ -1209,25 +1300,39 @@ export interface DescribeUserRequest {
1209
1300
  */
1210
1301
  UserId: string | undefined;
1211
1302
  }
1303
+ /**
1304
+ * @public
1305
+ * @enum
1306
+ */
1307
+ export declare const UserStatus: {
1308
+ readonly DISABLED: "DISABLED";
1309
+ readonly ENABLED: "ENABLED";
1310
+ };
1311
+ /**
1312
+ * @public
1313
+ */
1314
+ export type UserStatus = (typeof UserStatus)[keyof typeof UserStatus];
1212
1315
  /**
1213
1316
  * @public
1214
1317
  */
1215
1318
  export interface DescribeUserResponse {
1216
1319
  /**
1217
- * <p>A unique string used to identify the user. The length limit is 128 characters. This value can consist of
1218
- * letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is
1219
- * created and stored as an attribute of the user object in the identity store.</p>
1320
+ * <p>The globally unique identifier for the identity store.</p>
1220
1321
  * @public
1221
1322
  */
1222
- UserName?: string | undefined;
1323
+ IdentityStoreId: string | undefined;
1223
1324
  /**
1224
1325
  * <p>The identifier for a user in the identity store.</p>
1225
1326
  * @public
1226
1327
  */
1227
1328
  UserId: string | undefined;
1228
1329
  /**
1229
- * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
1230
- * resource by an external identity provider.</p>
1330
+ * <p>A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.</p>
1331
+ * @public
1332
+ */
1333
+ UserName?: string | undefined;
1334
+ /**
1335
+ * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this resource by an external identity provider.</p>
1231
1336
  * @public
1232
1337
  */
1233
1338
  ExternalIds?: ExternalId[] | undefined;
@@ -1292,42 +1397,67 @@ export interface DescribeUserResponse {
1292
1397
  */
1293
1398
  Timezone?: string | undefined;
1294
1399
  /**
1295
- * <p>The globally unique identifier for the identity store.</p>
1400
+ * <p>The current status of the user account.</p>
1296
1401
  * @public
1297
1402
  */
1298
- IdentityStoreId: string | undefined;
1403
+ UserStatus?: UserStatus | undefined;
1404
+ /**
1405
+ * <p>A list of photos associated with the user. Returns up to 3 photos with their associated metadata including type, display name, and primary designation.</p>
1406
+ * @public
1407
+ */
1408
+ Photos?: Photo[] | undefined;
1409
+ /**
1410
+ * <p>The user's personal website or blog URL. Returns the stored website information for the user.</p>
1411
+ * @public
1412
+ */
1413
+ Website?: string | undefined;
1414
+ /**
1415
+ * <p>The user's birthdate in YYYY-MM-DD format. This field returns the stored birthdate information for the user.</p>
1416
+ * @public
1417
+ */
1418
+ Birthdate?: string | undefined;
1419
+ /**
1420
+ * <p>The date and time the user was created.</p>
1421
+ * @public
1422
+ */
1423
+ CreatedAt?: Date | undefined;
1424
+ /**
1425
+ * <p>The identifier of the user or system that created the user.</p>
1426
+ * @public
1427
+ */
1428
+ CreatedBy?: string | undefined;
1429
+ /**
1430
+ * <p>The date and time the user was last updated.</p>
1431
+ * @public
1432
+ */
1433
+ UpdatedAt?: Date | undefined;
1434
+ /**
1435
+ * <p>The identifier of the user or system that last updated the user.</p>
1436
+ * @public
1437
+ */
1438
+ UpdatedBy?: string | undefined;
1299
1439
  }
1300
1440
  /**
1301
1441
  * @public
1302
1442
  */
1303
1443
  export interface ListUsersRequest {
1304
1444
  /**
1305
- * <p>The globally unique identifier for the identity store, such as
1306
- * <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
1307
- * <code>1234567890</code> is a randomly generated string that contains numbers and lower
1308
- * case letters. This value is generated at the time that a new identity store is
1309
- * created.</p>
1445
+ * <p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p>
1310
1446
  * @public
1311
1447
  */
1312
1448
  IdentityStoreId: string | undefined;
1313
1449
  /**
1314
- * <p>The maximum number of results to be returned per request. This parameter is used in the
1315
- * <code>ListUsers</code> and <code>ListGroups</code> requests to specify how many results
1316
- * to return in one page. The length limit is 50 characters.</p>
1450
+ * <p>The maximum number of results to be returned per request. This parameter is used in the <code> ListUsers</code> and <code>ListGroups</code> requests to specify how many results to return in one page. The length limit is 50 characters.</p>
1317
1451
  * @public
1318
1452
  */
1319
1453
  MaxResults?: number | undefined;
1320
1454
  /**
1321
- * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
1322
- * operations. This value is generated by the identity store service. It is returned in the
1323
- * API response if the total results are more than the size of one page. This token is also
1324
- * returned when it is used in the API request to search for the next page.</p>
1455
+ * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</p>
1325
1456
  * @public
1326
1457
  */
1327
1458
  NextToken?: string | undefined;
1328
1459
  /**
1329
- * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and
1330
- * <code>ListGroups</code> requests. </p>
1460
+ * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and <code> ListGroups</code> requests. </p>
1331
1461
  *
1332
1462
  * @deprecated Using filters with ListUsers API is deprecated, please use GetGroupId API instead.
1333
1463
  * @public
@@ -1340,20 +1470,22 @@ export interface ListUsersRequest {
1340
1470
  */
1341
1471
  export interface User {
1342
1472
  /**
1343
- * <p>A unique string used to identify the user. The length limit is 128 characters. This value can
1344
- * consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is
1345
- * created and stored as an attribute of the user object in the identity store.</p>
1473
+ * <p>The globally unique identifier for the identity store.</p>
1346
1474
  * @public
1347
1475
  */
1348
- UserName?: string | undefined;
1476
+ IdentityStoreId: string | undefined;
1349
1477
  /**
1350
1478
  * <p>The identifier for a user in the identity store.</p>
1351
1479
  * @public
1352
1480
  */
1353
1481
  UserId: string | undefined;
1354
1482
  /**
1355
- * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
1356
- * resource by an external identity provider.</p>
1483
+ * <p>A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.</p>
1484
+ * @public
1485
+ */
1486
+ UserName?: string | undefined;
1487
+ /**
1488
+ * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this resource by an external identity provider.</p>
1357
1489
  * @public
1358
1490
  */
1359
1491
  ExternalIds?: ExternalId[] | undefined;
@@ -1363,8 +1495,7 @@ export interface User {
1363
1495
  */
1364
1496
  Name?: Name | undefined;
1365
1497
  /**
1366
- * <p>A string containing the name of the user that is formatted for display when the user is
1367
- * referenced. For example, "John Doe."</p>
1498
+ * <p>A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."</p> <p>Prefix search supports a maximum of 1,000 characters for the string.</p>
1368
1499
  * @public
1369
1500
  */
1370
1501
  DisplayName?: string | undefined;
@@ -1394,20 +1525,17 @@ export interface User {
1394
1525
  */
1395
1526
  PhoneNumbers?: PhoneNumber[] | undefined;
1396
1527
  /**
1397
- * <p>A string indicating the type of user. Possible values are left unspecified. The value
1398
- * can vary based on your specific use case.</p>
1528
+ * <p>A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.</p>
1399
1529
  * @public
1400
1530
  */
1401
1531
  UserType?: string | undefined;
1402
1532
  /**
1403
- * <p>A string containing the title of the user. Possible values are left unspecified. The
1404
- * value can vary based on your specific use case.</p>
1533
+ * <p>A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.</p>
1405
1534
  * @public
1406
1535
  */
1407
1536
  Title?: string | undefined;
1408
1537
  /**
1409
- * <p>A string containing the preferred language of the user. For example, "American English"
1410
- * or "en-us."</p>
1538
+ * <p>A string containing the preferred language of the user. For example, "American English" or "en-us."</p>
1411
1539
  * @public
1412
1540
  */
1413
1541
  PreferredLanguage?: string | undefined;
@@ -1422,10 +1550,45 @@ export interface User {
1422
1550
  */
1423
1551
  Timezone?: string | undefined;
1424
1552
  /**
1425
- * <p>The globally unique identifier for the identity store.</p>
1553
+ * <p>The current status of the user account.</p>
1426
1554
  * @public
1427
1555
  */
1428
- IdentityStoreId: string | undefined;
1556
+ UserStatus?: UserStatus | undefined;
1557
+ /**
1558
+ * <p>A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.</p>
1559
+ * @public
1560
+ */
1561
+ Photos?: Photo[] | undefined;
1562
+ /**
1563
+ * <p>The user's personal website or blog URL. This field stores website information for personal or professional use.</p>
1564
+ * @public
1565
+ */
1566
+ Website?: string | undefined;
1567
+ /**
1568
+ * <p>The user's birthdate in YYYY-MM-DD format. This field stores personal birthdate information for the user.</p>
1569
+ * @public
1570
+ */
1571
+ Birthdate?: string | undefined;
1572
+ /**
1573
+ * <p>The date and time the user was created.</p>
1574
+ * @public
1575
+ */
1576
+ CreatedAt?: Date | undefined;
1577
+ /**
1578
+ * <p>The identifier of the user or system that created the user.</p>
1579
+ * @public
1580
+ */
1581
+ CreatedBy?: string | undefined;
1582
+ /**
1583
+ * <p>The date and time the user was last updated.</p>
1584
+ * @public
1585
+ */
1586
+ UpdatedAt?: Date | undefined;
1587
+ /**
1588
+ * <p>The identifier of the user or system that last updated the user.</p>
1589
+ * @public
1590
+ */
1591
+ UpdatedBy?: string | undefined;
1429
1592
  }
1430
1593
  /**
1431
1594
  * @public
@@ -1437,10 +1600,7 @@ export interface ListUsersResponse {
1437
1600
  */
1438
1601
  Users: User[] | undefined;
1439
1602
  /**
1440
- * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
1441
- * operations. This value is generated by the identity store service. It is returned in the
1442
- * API response if the total results are more than the size of one page. This token is also
1443
- * returned when it is used in the API request to search for the next page.</p>
1603
+ * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</p>
1444
1604
  * @public
1445
1605
  */
1446
1606
  NextToken?: string | undefined;
@@ -1460,8 +1620,7 @@ export interface UpdateUserRequest {
1460
1620
  */
1461
1621
  UserId: string | undefined;
1462
1622
  /**
1463
- * <p>A list of <code>AttributeOperation</code> objects to apply to the requested user. These
1464
- * operations might add, replace, or remove an attribute.</p>
1623
+ * <p>A list of <code>AttributeOperation</code> objects to apply to the requested user. These operations might add, replace, or remove an attribute. For more information on the attributes that can be added, replaced, or removed, see <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html">User</a>.</p>
1465
1624
  * @public
1466
1625
  */
1467
1626
  Operations: AttributeOperation[] | undefined;
@@ -1535,6 +1694,10 @@ export declare const NameFilterSensitiveLog: (obj: Name) => any;
1535
1694
  * @internal
1536
1695
  */
1537
1696
  export declare const PhoneNumberFilterSensitiveLog: (obj: PhoneNumber) => any;
1697
+ /**
1698
+ * @internal
1699
+ */
1700
+ export declare const PhotoFilterSensitiveLog: (obj: Photo) => any;
1538
1701
  /**
1539
1702
  * @internal
1540
1703
  */