@aws-sdk/client-identitystore 3.161.0 → 3.165.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 (94) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/README.md +7 -7
  3. package/dist-cjs/Identitystore.js +225 -0
  4. package/dist-cjs/commands/CreateGroupCommand.js +36 -0
  5. package/dist-cjs/commands/CreateGroupMembershipCommand.js +36 -0
  6. package/dist-cjs/commands/CreateUserCommand.js +36 -0
  7. package/dist-cjs/commands/DeleteGroupCommand.js +36 -0
  8. package/dist-cjs/commands/DeleteGroupMembershipCommand.js +36 -0
  9. package/dist-cjs/commands/DeleteUserCommand.js +36 -0
  10. package/dist-cjs/commands/DescribeGroupMembershipCommand.js +36 -0
  11. package/dist-cjs/commands/GetGroupIdCommand.js +36 -0
  12. package/dist-cjs/commands/GetGroupMembershipIdCommand.js +36 -0
  13. package/dist-cjs/commands/GetUserIdCommand.js +36 -0
  14. package/dist-cjs/commands/IsMemberInGroupsCommand.js +36 -0
  15. package/dist-cjs/commands/ListGroupMembershipsCommand.js +36 -0
  16. package/dist-cjs/commands/ListGroupMembershipsForMemberCommand.js +36 -0
  17. package/dist-cjs/commands/UpdateGroupCommand.js +36 -0
  18. package/dist-cjs/commands/UpdateUserCommand.js +36 -0
  19. package/dist-cjs/commands/index.js +15 -0
  20. package/dist-cjs/models/models_0.js +360 -35
  21. package/dist-cjs/pagination/ListGroupMembershipsForMemberPaginator.js +36 -0
  22. package/dist-cjs/pagination/ListGroupMembershipsPaginator.js +36 -0
  23. package/dist-cjs/pagination/index.js +2 -0
  24. package/dist-cjs/protocols/Aws_json1_1.js +1478 -93
  25. package/dist-es/Identitystore.js +225 -0
  26. package/dist-es/commands/CreateGroupCommand.js +39 -0
  27. package/dist-es/commands/CreateGroupMembershipCommand.js +39 -0
  28. package/dist-es/commands/CreateUserCommand.js +39 -0
  29. package/dist-es/commands/DeleteGroupCommand.js +39 -0
  30. package/dist-es/commands/DeleteGroupMembershipCommand.js +39 -0
  31. package/dist-es/commands/DeleteUserCommand.js +39 -0
  32. package/dist-es/commands/DescribeGroupMembershipCommand.js +39 -0
  33. package/dist-es/commands/GetGroupIdCommand.js +39 -0
  34. package/dist-es/commands/GetGroupMembershipIdCommand.js +39 -0
  35. package/dist-es/commands/GetUserIdCommand.js +39 -0
  36. package/dist-es/commands/IsMemberInGroupsCommand.js +39 -0
  37. package/dist-es/commands/ListGroupMembershipsCommand.js +39 -0
  38. package/dist-es/commands/ListGroupMembershipsForMemberCommand.js +39 -0
  39. package/dist-es/commands/UpdateGroupCommand.js +39 -0
  40. package/dist-es/commands/UpdateUserCommand.js +39 -0
  41. package/dist-es/commands/index.js +15 -0
  42. package/dist-es/models/models_0.js +156 -34
  43. package/dist-es/pagination/ListGroupMembershipsForMemberPaginator.js +75 -0
  44. package/dist-es/pagination/ListGroupMembershipsPaginator.js +75 -0
  45. package/dist-es/pagination/index.js +2 -0
  46. package/dist-es/protocols/Aws_json1_1.js +1678 -50
  47. package/dist-types/Identitystore.d.ts +106 -2
  48. package/dist-types/IdentitystoreClient.d.ts +17 -2
  49. package/dist-types/commands/CreateGroupCommand.d.ts +35 -0
  50. package/dist-types/commands/CreateGroupMembershipCommand.d.ts +35 -0
  51. package/dist-types/commands/CreateUserCommand.d.ts +35 -0
  52. package/dist-types/commands/DeleteGroupCommand.d.ts +35 -0
  53. package/dist-types/commands/DeleteGroupMembershipCommand.d.ts +35 -0
  54. package/dist-types/commands/DeleteUserCommand.d.ts +35 -0
  55. package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +35 -0
  56. package/dist-types/commands/DescribeUserCommand.d.ts +1 -2
  57. package/dist-types/commands/GetGroupIdCommand.d.ts +35 -0
  58. package/dist-types/commands/GetGroupMembershipIdCommand.d.ts +35 -0
  59. package/dist-types/commands/GetUserIdCommand.d.ts +35 -0
  60. package/dist-types/commands/IsMemberInGroupsCommand.d.ts +35 -0
  61. package/dist-types/commands/ListGroupMembershipsCommand.d.ts +35 -0
  62. package/dist-types/commands/ListGroupMembershipsForMemberCommand.d.ts +35 -0
  63. package/dist-types/commands/UpdateGroupCommand.d.ts +35 -0
  64. package/dist-types/commands/UpdateUserCommand.d.ts +35 -0
  65. package/dist-types/commands/index.d.ts +15 -0
  66. package/dist-types/models/models_0.d.ts +1122 -125
  67. package/dist-types/pagination/ListGroupMembershipsForMemberPaginator.d.ts +4 -0
  68. package/dist-types/pagination/ListGroupMembershipsPaginator.d.ts +4 -0
  69. package/dist-types/pagination/index.d.ts +2 -0
  70. package/dist-types/protocols/Aws_json1_1.d.ts +45 -0
  71. package/dist-types/ts3.4/Identitystore.d.ts +75 -0
  72. package/dist-types/ts3.4/IdentitystoreClient.d.ts +17 -2
  73. package/dist-types/ts3.4/commands/CreateGroupCommand.d.ts +17 -0
  74. package/dist-types/ts3.4/commands/CreateGroupMembershipCommand.d.ts +17 -0
  75. package/dist-types/ts3.4/commands/CreateUserCommand.d.ts +17 -0
  76. package/dist-types/ts3.4/commands/DeleteGroupCommand.d.ts +17 -0
  77. package/dist-types/ts3.4/commands/DeleteGroupMembershipCommand.d.ts +17 -0
  78. package/dist-types/ts3.4/commands/DeleteUserCommand.d.ts +17 -0
  79. package/dist-types/ts3.4/commands/DescribeGroupMembershipCommand.d.ts +17 -0
  80. package/dist-types/ts3.4/commands/GetGroupIdCommand.d.ts +17 -0
  81. package/dist-types/ts3.4/commands/GetGroupMembershipIdCommand.d.ts +17 -0
  82. package/dist-types/ts3.4/commands/GetUserIdCommand.d.ts +17 -0
  83. package/dist-types/ts3.4/commands/IsMemberInGroupsCommand.d.ts +17 -0
  84. package/dist-types/ts3.4/commands/ListGroupMembershipsCommand.d.ts +17 -0
  85. package/dist-types/ts3.4/commands/ListGroupMembershipsForMemberCommand.d.ts +17 -0
  86. package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +17 -0
  87. package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +17 -0
  88. package/dist-types/ts3.4/commands/index.d.ts +15 -0
  89. package/dist-types/ts3.4/models/models_0.d.ts +565 -29
  90. package/dist-types/ts3.4/pagination/ListGroupMembershipsForMemberPaginator.d.ts +4 -0
  91. package/dist-types/ts3.4/pagination/ListGroupMembershipsPaginator.d.ts +4 -0
  92. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  93. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +45 -0
  94. package/package.json +26 -26
@@ -1,4 +1,5 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
+ import { DocumentType as __DocumentType } from "@aws-sdk/types";
2
3
  import { IdentitystoreServiceException as __BaseException } from "./IdentitystoreServiceException";
3
4
  /**
4
5
  * <p>You do not have sufficient access to perform this action.</p>
@@ -18,11 +19,481 @@ export declare class AccessDeniedException extends __BaseException {
18
19
  */
19
20
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
20
21
  }
22
+ /**
23
+ * <p>The address associated with the specified user.</p>
24
+ */
25
+ export interface Address {
26
+ /**
27
+ * <p>The
28
+ * street
29
+ * of the address.</p>
30
+ */
31
+ StreetAddress?: string;
32
+ /**
33
+ * <p>A string of the address locality.</p>
34
+ */
35
+ Locality?: string;
36
+ /**
37
+ * <p>The
38
+ * region
39
+ * of the address.</p>
40
+ */
41
+ Region?: string;
42
+ /**
43
+ * <p>The postal code of the address.</p>
44
+ */
45
+ PostalCode?: string;
46
+ /**
47
+ * <p>The country of the address.</p>
48
+ */
49
+ Country?: string;
50
+ /**
51
+ * <p>A string containing a formatted version of the address for display.</p>
52
+ */
53
+ Formatted?: string;
54
+ /**
55
+ * <p>A string representing the type of address. For example, "Home."</p>
56
+ */
57
+ Type?: string;
58
+ /**
59
+ * <p>A
60
+ * Boolean
61
+ * value
62
+ * representing whether this is the primary address for the associated
63
+ * resource.</p>
64
+ */
65
+ Primary?: boolean;
66
+ }
67
+ /**
68
+ * <p>The identifier issued to this resource by an external identity provider.</p>
69
+ */
70
+ export interface ExternalId {
71
+ /**
72
+ * <p>The issuer for an external identifier.</p>
73
+ */
74
+ Issuer: string | undefined;
75
+ /**
76
+ * <p>The identifier issued to this resource by an external identity provider.</p>
77
+ */
78
+ Id: string | undefined;
79
+ }
80
+ /**
81
+ * <p>An entity attribute that's unique to a specific entity.</p>
82
+ */
83
+ export interface UniqueAttribute {
84
+ /**
85
+ * <p>A string representation of the path to a given attribute or sub-attribute. Supports
86
+ * JMESPath.</p>
87
+ */
88
+ AttributePath: string | undefined;
89
+ /**
90
+ * <p>The value of the attribute. This is a <code>Document</code> type.
91
+ * This type is not supported by Java V1, Go V1, and older versions of the AWS CLI.</p>
92
+ */
93
+ AttributeValue: __DocumentType | undefined;
94
+ }
95
+ /**
96
+ * <p>A unique identifier for a user or group that is not the its primary identifier. This value can be
97
+ * an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a
98
+ * unique <code>GroupDisplayName</code>.</p>
99
+ */
100
+ export declare type AlternateIdentifier = AlternateIdentifier.ExternalIdMember | AlternateIdentifier.UniqueAttributeMember | AlternateIdentifier.$UnknownMember;
101
+ export declare namespace AlternateIdentifier {
102
+ /**
103
+ * <p>The identifier issued to this resource by an external identity provider.</p>
104
+ */
105
+ interface ExternalIdMember {
106
+ ExternalId: ExternalId;
107
+ UniqueAttribute?: never;
108
+ $unknown?: never;
109
+ }
110
+ /**
111
+ * <p>An entity attribute that's unique to a specific entity.</p>
112
+ */
113
+ interface UniqueAttributeMember {
114
+ ExternalId?: never;
115
+ UniqueAttribute: UniqueAttribute;
116
+ $unknown?: never;
117
+ }
118
+ interface $UnknownMember {
119
+ ExternalId?: never;
120
+ UniqueAttribute?: never;
121
+ $unknown: [string, any];
122
+ }
123
+ interface Visitor<T> {
124
+ ExternalId: (value: ExternalId) => T;
125
+ UniqueAttribute: (value: UniqueAttribute) => T;
126
+ _: (name: string, value: any) => T;
127
+ }
128
+ const visit: <T>(value: AlternateIdentifier, visitor: Visitor<T>) => T;
129
+ }
130
+ /**
131
+ * <p>An operation that applies to the requested group. This operation might add, replace, or remove an attribute.</p>
132
+ */
133
+ export interface AttributeOperation {
134
+ /**
135
+ * <p>A string representation of the path to a given attribute or sub-attribute. Supports
136
+ * JMESPath.</p>
137
+ */
138
+ AttributePath: string | undefined;
139
+ /**
140
+ * <p>The value of the attribute. This is a <code>Document</code> type.
141
+ * This type is not supported by Java V1, Go V1, and older versions of the AWS CLI.</p>
142
+ */
143
+ AttributeValue?: __DocumentType;
144
+ }
145
+ export interface GetGroupIdRequest {
146
+ /**
147
+ * <p>The globally unique identifier for the identity store.</p>
148
+ */
149
+ IdentityStoreId: string | undefined;
150
+ /**
151
+ * <p>A unique identifier for an identity resource that is not the primary identifier. This value can be
152
+ * an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a
153
+ * unique <code>GroupDisplayName</code>.</p>
154
+ */
155
+ AlternateIdentifier: AlternateIdentifier | undefined;
156
+ }
157
+ export interface GetGroupIdResponse {
158
+ /**
159
+ * <p>The identifier for a group in the identity store.</p>
160
+ */
161
+ GroupId: string | undefined;
162
+ /**
163
+ * <p>The globally unique identifier for the identity store.</p>
164
+ */
165
+ IdentityStoreId: string | undefined;
166
+ }
167
+ export declare enum ResourceType {
168
+ GROUP = "GROUP",
169
+ GROUP_MEMBERSHIP = "GROUP_MEMBERSHIP",
170
+ IDENTITY_STORE = "IDENTITY_STORE",
171
+ USER = "USER"
172
+ }
173
+ /**
174
+ * <p>Indicates that a requested resource is not found.</p>
175
+ */
176
+ export declare class ResourceNotFoundException extends __BaseException {
177
+ readonly name: "ResourceNotFoundException";
178
+ readonly $fault: "client";
179
+ /**
180
+ * <p>An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, and IDENTITY_STORE.</p>
181
+ */
182
+ ResourceType?: ResourceType | string;
183
+ /**
184
+ * <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>
185
+ */
186
+ ResourceId?: string;
187
+ Message?: string;
188
+ /**
189
+ * <p>The identifier for each request. This value is a globally unique ID that is generated by
190
+ * the identity store service for each sent request, and is then returned inside the exception
191
+ * if the request fails.</p>
192
+ */
193
+ RequestId?: string;
194
+ /**
195
+ * @internal
196
+ */
197
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
198
+ }
199
+ /**
200
+ * <p>The request failed because it contains a syntax error.</p>
201
+ */
202
+ export declare class ValidationException extends __BaseException {
203
+ readonly name: "ValidationException";
204
+ readonly $fault: "client";
205
+ Message?: string;
206
+ /**
207
+ * <p>The identifier for each request. This value is a globally unique ID that is generated by
208
+ * the identity store service for each sent request, and is then returned inside the exception
209
+ * if the request fails.</p>
210
+ */
211
+ RequestId?: string;
212
+ /**
213
+ * @internal
214
+ */
215
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
216
+ }
217
+ /**
218
+ * <p>An object containing the identifier of a group member.</p>
219
+ */
220
+ export declare type MemberId = MemberId.UserIdMember | MemberId.$UnknownMember;
221
+ export declare namespace MemberId {
222
+ /**
223
+ * <p>An object containing the identifiers of resources that can be members.</p>
224
+ */
225
+ interface UserIdMember {
226
+ UserId: string;
227
+ $unknown?: never;
228
+ }
229
+ interface $UnknownMember {
230
+ UserId?: never;
231
+ $unknown: [string, any];
232
+ }
233
+ interface Visitor<T> {
234
+ UserId: (value: string) => T;
235
+ _: (name: string, value: any) => T;
236
+ }
237
+ const visit: <T>(value: MemberId, visitor: Visitor<T>) => T;
238
+ }
239
+ export interface GetGroupMembershipIdRequest {
240
+ /**
241
+ * <p>The globally unique identifier for the identity store.</p>
242
+ */
243
+ IdentityStoreId: string | undefined;
244
+ /**
245
+ * <p>The identifier for a group in the identity store.</p>
246
+ */
247
+ GroupId: string | undefined;
248
+ /**
249
+ * <p>An object that contains the identifier of a group member. Setting the <code>UserID</code> field to the specific identifier for a user indicates that the user is a member of the group.</p>
250
+ */
251
+ MemberId: MemberId | undefined;
252
+ }
253
+ export interface GetGroupMembershipIdResponse {
254
+ /**
255
+ * <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
256
+ */
257
+ MembershipId: string | undefined;
258
+ /**
259
+ * <p>The globally unique identifier for the identity store.</p>
260
+ */
261
+ IdentityStoreId: string | undefined;
262
+ }
263
+ export interface GetUserIdRequest {
264
+ /**
265
+ * <p>The globally unique identifier for the identity store.</p>
266
+ */
267
+ IdentityStoreId: string | undefined;
268
+ /**
269
+ * <p>A unique identifier for an identity resource that is not the primary identifier.</p>
270
+ */
271
+ AlternateIdentifier: AlternateIdentifier | undefined;
272
+ }
273
+ export interface GetUserIdResponse {
274
+ /**
275
+ * <p>The identifier for a user in the identity store.</p>
276
+ */
277
+ UserId: string | undefined;
278
+ /**
279
+ * <p>The globally unique identifier for the identity store.</p>
280
+ */
281
+ IdentityStoreId: string | undefined;
282
+ }
283
+ export declare enum ConflictExceptionReason {
284
+ CONCURRENT_MODIFICATION = "CONCURRENT_MODIFICATION",
285
+ UNIQUENESS_CONSTRAINT_VIOLATION = "UNIQUENESS_CONSTRAINT_VIOLATION"
286
+ }
287
+ /**
288
+ * <p>This request cannot be completed for one of the following reasons:</p>
289
+ * <ul>
290
+ * <li>
291
+ * <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p>
292
+ * </li>
293
+ * <li>
294
+ * <p>The requested resource was being concurrently modified by another request.</p>
295
+ * </li>
296
+ * </ul>
297
+ */
298
+ export declare class ConflictException extends __BaseException {
299
+ readonly name: "ConflictException";
300
+ readonly $fault: "client";
301
+ Message?: string;
302
+ /**
303
+ * <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>
304
+ */
305
+ RequestId?: string;
306
+ /**
307
+ * <p>This request cannot be completed for one of the following reasons:</p>
308
+ * <ul>
309
+ * <li>
310
+ * <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p>
311
+ * </li>
312
+ * <li>
313
+ * <p>The requested resource was being concurrently modified by another request.</p>
314
+ * </li>
315
+ * </ul>
316
+ */
317
+ Reason?: ConflictExceptionReason | string;
318
+ /**
319
+ * @internal
320
+ */
321
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
322
+ }
323
+ export interface CreateGroupMembershipRequest {
324
+ /**
325
+ * <p>The globally unique identifier for the identity store.</p>
326
+ */
327
+ IdentityStoreId: string | undefined;
328
+ /**
329
+ * <p>The identifier for a group in the identity store.</p>
330
+ */
331
+ GroupId: string | undefined;
332
+ /**
333
+ * <p>An object that contains the identifier of a group member. Setting the <code>UserID</code> field to the specific identifier for a user indicates that the user is a member of the group.</p>
334
+ */
335
+ MemberId: MemberId | undefined;
336
+ }
337
+ export interface CreateGroupMembershipResponse {
338
+ /**
339
+ * <p>The identifier for a newly created <code>GroupMembership</code> in an identity store.</p>
340
+ */
341
+ MembershipId: string | undefined;
342
+ /**
343
+ * <p>The globally unique identifier for the identity store.</p>
344
+ */
345
+ IdentityStoreId: string | undefined;
346
+ }
347
+ /**
348
+ * <p>The request would cause the number of users or groups in the identity store to exceed the maximum allowed.</p>
349
+ */
350
+ export declare class ServiceQuotaExceededException extends __BaseException {
351
+ readonly name: "ServiceQuotaExceededException";
352
+ readonly $fault: "client";
353
+ Message?: string;
354
+ /**
355
+ * <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>
356
+ */
357
+ RequestId?: string;
358
+ /**
359
+ * @internal
360
+ */
361
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
362
+ }
363
+ export interface DeleteGroupMembershipRequest {
364
+ /**
365
+ * <p>The globally unique identifier for the identity store.</p>
366
+ */
367
+ IdentityStoreId: string | undefined;
368
+ /**
369
+ * <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
370
+ */
371
+ MembershipId: string | undefined;
372
+ }
373
+ export interface DeleteGroupMembershipResponse {
374
+ }
375
+ export interface DescribeGroupMembershipRequest {
376
+ /**
377
+ * <p>The globally unique identifier for the identity store.</p>
378
+ */
379
+ IdentityStoreId: string | undefined;
380
+ /**
381
+ * <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
382
+ */
383
+ MembershipId: string | undefined;
384
+ }
385
+ export interface DescribeGroupMembershipResponse {
386
+ /**
387
+ * <p>The globally unique identifier for the identity store.</p>
388
+ */
389
+ IdentityStoreId: string | undefined;
390
+ /**
391
+ * <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
392
+ */
393
+ MembershipId: string | undefined;
394
+ /**
395
+ * <p>The identifier for a group in the identity store.</p>
396
+ */
397
+ GroupId: string | undefined;
398
+ /**
399
+ * <p>An object containing the identifier of a group member.</p>
400
+ */
401
+ MemberId: MemberId | undefined;
402
+ }
403
+ export interface ListGroupMembershipsRequest {
404
+ /**
405
+ * <p>The globally unique identifier for the identity store.</p>
406
+ */
407
+ IdentityStoreId: string | undefined;
408
+ /**
409
+ * <p>The identifier for a group in the identity store.</p>
410
+ */
411
+ GroupId: string | undefined;
412
+ /**
413
+ * <p>The maximum number of results to be returned per request. This parameter is used in all
414
+ * <code>List</code> requests to specify how many results to return in one page.</p>
415
+ */
416
+ MaxResults?: number;
417
+ /**
418
+ * <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>
419
+ */
420
+ NextToken?: string;
421
+ }
422
+ /**
423
+ * <p>Contains the identifiers for a group, a group member, and a <code>GroupMembership</code>
424
+ * object in the identity store.</p>
425
+ */
426
+ export interface GroupMembership {
427
+ /**
428
+ * <p>The globally unique identifier for the identity store.</p>
429
+ */
430
+ IdentityStoreId: string | undefined;
431
+ /**
432
+ * <p>The identifier for a <code>GroupMembership</code> object in an identity store.</p>
433
+ */
434
+ MembershipId?: string;
435
+ /**
436
+ * <p>The identifier for a group in the identity store.</p>
437
+ */
438
+ GroupId?: string;
439
+ /**
440
+ * <p>An object that contains the identifier of a group member. Setting the <code>UserID</code> field to the specific identifier for a user indicates that the user is a member of the group.</p>
441
+ */
442
+ MemberId?: MemberId;
443
+ }
444
+ export interface ListGroupMembershipsResponse {
445
+ /**
446
+ * <p>A list of <code>GroupMembership</code> objects in the group.</p>
447
+ */
448
+ GroupMemberships: GroupMembership[] | undefined;
449
+ /**
450
+ * <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>
451
+ */
452
+ NextToken?: string;
453
+ }
454
+ export interface CreateGroupRequest {
455
+ /**
456
+ * <p>The globally unique identifier for the identity store.</p>
457
+ */
458
+ IdentityStoreId: string | undefined;
459
+ /**
460
+ * <p>A string containing the name of the group. This value is commonly displayed when the group is referenced.</p>
461
+ */
462
+ DisplayName?: string;
463
+ /**
464
+ * <p>A string containing the description of the group.</p>
465
+ */
466
+ Description?: string;
467
+ }
468
+ export interface CreateGroupResponse {
469
+ /**
470
+ * <p>The
471
+ * identifier
472
+ * of the newly created group in the identity store.</p>
473
+ */
474
+ GroupId: string | undefined;
475
+ /**
476
+ * <p>The globally unique identifier for the identity store.</p>
477
+ */
478
+ IdentityStoreId: string | undefined;
479
+ }
480
+ export interface DeleteGroupRequest {
481
+ /**
482
+ * <p>The globally unique identifier for the identity store.</p>
483
+ */
484
+ IdentityStoreId: string | undefined;
485
+ /**
486
+ * <p>The identifier for a group in the identity store.</p>
487
+ */
488
+ GroupId: string | undefined;
489
+ }
490
+ export interface DeleteGroupResponse {
491
+ }
21
492
  export interface DescribeGroupRequest {
22
493
  /**
23
494
  * <p>The globally unique identifier for the identity store, such as
24
495
  * <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
25
- * <code>1234567890</code> is a randomly generated string that contains number and lower
496
+ * <code>1234567890</code> is a randomly generated string that contains numbers and lower
26
497
  * case letters. This value is generated at the time that a new identity store is
27
498
  * created.</p>
28
499
  */
@@ -38,22 +509,143 @@ export interface DescribeGroupResponse {
38
509
  */
39
510
  GroupId: string | undefined;
40
511
  /**
41
- * <p>Contains the group’s display name value. The length limit is 1,024 characters. This
512
+ * <p>The group’s display name value. The length limit is 1,024 characters. This
42
513
  * value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new
43
514
  * line, carriage return, space, and nonbreaking space in this attribute. The characters
44
- * <code><>;:%</code> are excluded. This value is specified at the time that the
515
+ * <code>&lt;&gt;;:%</code> are excluded. This value is specified at the time that the
45
516
  * group is created and stored as an attribute of the group object in the identity
46
517
  * store.</p>
47
518
  */
48
- DisplayName: string | undefined;
519
+ DisplayName?: string;
520
+ /**
521
+ * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
522
+ * resource by an external identity provider.</p>
523
+ */
524
+ ExternalIds?: ExternalId[];
525
+ /**
526
+ * <p>A string containing a description of the group.</p>
527
+ */
528
+ Description?: string;
529
+ /**
530
+ * <p>The globally unique identifier for the identity store.</p>
531
+ */
532
+ IdentityStoreId: string | undefined;
533
+ }
534
+ /**
535
+ * <p>A query filter used by <code>ListUsers</code> and <code>ListGroups</code>. This filter
536
+ * object provides the attribute name and attribute value to search users or groups.</p>
537
+ */
538
+ export interface Filter {
539
+ /**
540
+ * <p>The attribute path that is used to specify which attribute name to search. Length limit
541
+ * is 255 characters. For example, <code>UserName</code> is a valid attribute path for the
542
+ * <code>ListUsers</code> API, and <code>DisplayName</code> is a valid attribute path for
543
+ * the <code>ListGroups</code> API.</p>
544
+ */
545
+ AttributePath: string | undefined;
546
+ /**
547
+ * <p>Represents the data for an attribute. Each attribute value is described as a name-value
548
+ * pair. </p>
549
+ */
550
+ AttributeValue: string | undefined;
551
+ }
552
+ export interface ListGroupsRequest {
553
+ /**
554
+ * <p>The globally unique identifier for the identity store, such as
555
+ * <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
556
+ * <code>1234567890</code> is a randomly generated string that contains numbers and lower
557
+ * case letters. This value is generated at the time that a new identity store is
558
+ * created.</p>
559
+ */
560
+ IdentityStoreId: string | undefined;
561
+ /**
562
+ * <p>The maximum number of results to be returned per request. This parameter is used in the
563
+ * <code>ListUsers</code> and <code>ListGroups</code> requests to specify how many results
564
+ * to return in one page. The length limit is 50 characters.</p>
565
+ */
566
+ MaxResults?: number;
567
+ /**
568
+ * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
569
+ * operations. This value is generated by the identity store service. It is returned in the
570
+ * API response if the total results are more than the size of one page. This token is also
571
+ * returned when it is used in the API request to search for the next page.</p>
572
+ */
573
+ NextToken?: string;
574
+ /**
575
+ * @deprecated
576
+ *
577
+ * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and
578
+ * <code>ListGroups</code> requests.</p>
579
+ */
580
+ Filters?: Filter[];
49
581
  }
50
582
  /**
51
- * <p>The request processing has failed because of an unknown error, exception or failure with
52
- * an internal server.</p>
583
+ * <p>A group object that contains a specified group’s metadata and attributes.</p>
584
+ */
585
+ export interface Group {
586
+ /**
587
+ * <p>The identifier for a group in the identity store.</p>
588
+ */
589
+ GroupId: string | undefined;
590
+ /**
591
+ * <p>The group’s display name value. The length limit is 1,024 characters. This
592
+ * value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new
593
+ * line, carriage return, space, and nonbreaking space in this attribute. The characters
594
+ * <code>&lt;&gt;;:%</code> are excluded. This value is specified at the time the group is
595
+ * created and stored as an attribute of the group object in the identity store.</p>
596
+ */
597
+ DisplayName?: string;
598
+ /**
599
+ * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
600
+ * resource by an external identity provider.</p>
601
+ */
602
+ ExternalIds?: ExternalId[];
603
+ /**
604
+ * <p>A string containing a description of the specified group.</p>
605
+ */
606
+ Description?: string;
607
+ /**
608
+ * <p>The globally unique identifier for the identity store.</p>
609
+ */
610
+ IdentityStoreId: string | undefined;
611
+ }
612
+ export interface ListGroupsResponse {
613
+ /**
614
+ * <p>A list of <code>Group</code> objects in the identity store.</p>
615
+ */
616
+ Groups: Group[] | undefined;
617
+ /**
618
+ * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
619
+ * operations. This value is generated by the identity store service. It is returned in the
620
+ * API response if the total results are more than the size of one page. This token is also
621
+ * returned when it1 is used in the API request to search for the next page.</p>
622
+ */
623
+ NextToken?: string;
624
+ }
625
+ export interface UpdateGroupRequest {
626
+ /**
627
+ * <p>The globally unique identifier for the identity store.</p>
628
+ */
629
+ IdentityStoreId: string | undefined;
630
+ /**
631
+ * <p>The identifier for a group in the identity store.</p>
632
+ */
633
+ GroupId: string | undefined;
634
+ /**
635
+ * <p>A list of <code>AttributeOperation</code> objects to apply to the requested group. These
636
+ * operations might add, replace, or remove an attribute.</p>
637
+ */
638
+ Operations: AttributeOperation[] | undefined;
639
+ }
640
+ export interface UpdateGroupResponse {
641
+ }
642
+ /**
643
+ * <p>The request processing has failed because of an unknown error, exception or failure with an internal server.</p>
53
644
  */
54
645
  export declare class InternalServerException extends __BaseException {
55
646
  readonly name: "InternalServerException";
56
647
  readonly $fault: "server";
648
+ $retryable: {};
57
649
  Message?: string;
58
650
  /**
59
651
  * <p>The identifier for each request. This value is a globally unique ID that is generated by
@@ -61,38 +653,90 @@ export declare class InternalServerException extends __BaseException {
61
653
  * if the request fails.</p>
62
654
  */
63
655
  RequestId?: string;
656
+ /**
657
+ * <p>The number of seconds that you would like to wait before retrying the next request.</p>
658
+ */
659
+ RetryAfterSeconds?: number;
64
660
  /**
65
661
  * @internal
66
662
  */
67
663
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
68
664
  }
69
- export declare enum ResourceType {
70
- GROUP = "GROUP",
71
- IDENTITY_STORE = "IDENTITY_STORE",
72
- USER = "USER"
665
+ export interface IsMemberInGroupsRequest {
666
+ /**
667
+ * <p>The globally unique identifier for the identity store.</p>
668
+ */
669
+ IdentityStoreId: string | undefined;
670
+ /**
671
+ * <p>An object containing the identifier of a group member.</p>
672
+ */
673
+ MemberId: MemberId | undefined;
674
+ /**
675
+ * <p>A list of identifiers for groups in the identity store.</p>
676
+ */
677
+ GroupIds: string[] | undefined;
73
678
  }
74
679
  /**
75
- * <p>Indicates that a requested resource is not found.</p>
680
+ * <p>Indicates whether a resource is a member of a group in the identity store.</p>
76
681
  */
77
- export declare class ResourceNotFoundException extends __BaseException {
78
- readonly name: "ResourceNotFoundException";
79
- readonly $fault: "client";
682
+ export interface GroupMembershipExistenceResult {
80
683
  /**
81
- * <p>The type of resource in the identity store service, which is an enum object. Valid
82
- * values include USER, GROUP, and IDENTITY_STORE.</p>
684
+ * <p>The identifier for a group in the identity store.</p>
83
685
  */
84
- ResourceType?: ResourceType | string;
686
+ GroupId?: string;
85
687
  /**
86
- * <p>The identifier for a resource in the identity store, which can be used as
87
- * <code>UserId</code> or <code>GroupId</code>. The format for <code>ResourceId</code> is
88
- * either <code>UUID</code> or <code>1234567890-UUID</code>, where <code>UUID</code> is a
89
- * randomly generated value for each resource when it is created and <code>1234567890</code>
90
- * represents the <code>IdentityStoreId</code> string value. In the case that the identity
91
- * store is migrated from a legacy single sign-on identity store, the <code>ResourceId</code> for that
92
- * identity store will be in the format of <code>UUID</code>. Otherwise, it will be in the
93
- * <code>1234567890-UUID</code> format.</p>
688
+ * <p>An object that contains the identifier of a group member. Setting the <code>UserID</code> field to the specific identifier for a user indicates that the user is a member of the group.</p>
94
689
  */
95
- ResourceId?: string;
690
+ MemberId?: MemberId;
691
+ /**
692
+ * <p>Indicates whether a membership relation exists or not.</p>
693
+ */
694
+ MembershipExists?: boolean;
695
+ }
696
+ export interface IsMemberInGroupsResponse {
697
+ /**
698
+ * <p>A list containing the results of membership existence checks.</p>
699
+ */
700
+ Results: GroupMembershipExistenceResult[] | undefined;
701
+ }
702
+ export interface ListGroupMembershipsForMemberRequest {
703
+ /**
704
+ * <p>The globally unique identifier for the identity store.</p>
705
+ */
706
+ IdentityStoreId: string | undefined;
707
+ /**
708
+ * <p>An object that contains the identifier of a group member. Setting the <code>UserID</code> field to the specific identifier for a user indicates that the user is a member of the group.</p>
709
+ */
710
+ MemberId: MemberId | undefined;
711
+ /**
712
+ * <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>
713
+ */
714
+ MaxResults?: number;
715
+ /**
716
+ * <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>
717
+ */
718
+ NextToken?: string;
719
+ }
720
+ export interface ListGroupMembershipsForMemberResponse {
721
+ /**
722
+ * <p>A list of <code>GroupMembership</code> objects in the group for a specified member.</p>
723
+ */
724
+ GroupMemberships: GroupMembership[] | undefined;
725
+ /**
726
+ * <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.
727
+ * </p>
728
+ */
729
+ NextToken?: string;
730
+ }
731
+ /**
732
+ * <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
733
+ */
734
+ export declare class ThrottlingException extends __BaseException {
735
+ readonly name: "ThrottlingException";
736
+ readonly $fault: "client";
737
+ $retryable: {
738
+ throttling: boolean;
739
+ };
96
740
  Message?: string;
97
741
  /**
98
742
  * <p>The identifier for each request. This value is a globally unique ID that is generated by
@@ -100,53 +744,181 @@ export declare class ResourceNotFoundException extends __BaseException {
100
744
  * if the request fails.</p>
101
745
  */
102
746
  RequestId?: string;
747
+ /**
748
+ * <p>The number of seconds that you would like to wait before retrying the next
749
+ * request.</p>
750
+ */
751
+ RetryAfterSeconds?: number;
103
752
  /**
104
753
  * @internal
105
754
  */
106
- constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
755
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
107
756
  }
108
757
  /**
109
- * <p>Indicates that the principal has crossed the throttling limits of the API
110
- * operations.</p>
758
+ * <p>The email address associated with the user.</p>
111
759
  */
112
- export declare class ThrottlingException extends __BaseException {
113
- readonly name: "ThrottlingException";
114
- readonly $fault: "client";
115
- Message?: string;
760
+ export interface Email {
761
+ /**
762
+ * <p>A string containing an email address. For example, "johndoe@amazon.com."</p>
763
+ */
764
+ Value?: string;
765
+ /**
766
+ * <p>A string representing the type of address. For example, "Work."</p>
767
+ */
768
+ Type?: string;
769
+ /**
770
+ * <p>A
771
+ * Boolean
772
+ * value
773
+ * representing whether this is the primary email
774
+ * address
775
+ * for the associated resource.</p>
776
+ */
777
+ Primary?: boolean;
778
+ }
779
+ /**
780
+ * <p>The
781
+ * full name
782
+ * of the user.</p>
783
+ */
784
+ export interface Name {
785
+ /**
786
+ * <p>A string containing a formatted version of the name for display.</p>
787
+ */
788
+ Formatted?: string;
789
+ /**
790
+ * <p>The family name of the user.</p>
791
+ */
792
+ FamilyName?: string;
793
+ /**
794
+ * <p>The given name of the user.</p>
795
+ */
796
+ GivenName?: string;
797
+ /**
798
+ * <p>The middle name of the user.</p>
799
+ */
800
+ MiddleName?: string;
801
+ /**
802
+ * <p>The honorific prefix of the user. For example, "Dr."</p>
803
+ */
804
+ HonorificPrefix?: string;
805
+ /**
806
+ * <p>The honorific suffix of the user. For example, "M.D."</p>
807
+ */
808
+ HonorificSuffix?: string;
809
+ }
810
+ /**
811
+ * <p>The phone number associated with the user.</p>
812
+ */
813
+ export interface PhoneNumber {
814
+ /**
815
+ * <p>A string containing a phone number. For example,
816
+ * "8675309"
817
+ * or "+1 (800) 123-4567".</p>
818
+ */
819
+ Value?: string;
820
+ /**
821
+ * <p>A string representing the type of a phone number. For example, "Mobile."</p>
822
+ */
823
+ Type?: string;
824
+ /**
825
+ * <p>A
826
+ * Boolean
827
+ * value
828
+ * representing whether this is the primary phone number for the associated
829
+ * resource.</p>
830
+ */
831
+ Primary?: boolean;
832
+ }
833
+ export interface CreateUserRequest {
834
+ /**
835
+ * <p>The globally unique identifier for the identity store.</p>
836
+ */
837
+ IdentityStoreId: string | undefined;
838
+ /**
839
+ * <p>A unique string used to identify the user. The length limit is 128 characters.
840
+ * This value can consist of letters, accented characters, symbols, numbers, and punctuation.
841
+ * 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>
842
+ */
843
+ UserName?: string;
844
+ /**
845
+ * <p>An object containing the user's name.</p>
846
+ */
847
+ Name?: Name;
848
+ /**
849
+ * <p>A string containing the user's name. This value is typically formatted for display when
850
+ * the user is referenced. For example, "John Doe."</p>
851
+ */
852
+ DisplayName?: string;
853
+ /**
854
+ * <p>A string containing an alternate name for the user.</p>
855
+ */
856
+ NickName?: string;
857
+ /**
858
+ * <p>A string containing a URL that may be associated with the user.</p>
859
+ */
860
+ ProfileUrl?: string;
861
+ /**
862
+ * <p>A list of <code>Email</code> objects containing email addresses associated with the user.</p>
863
+ */
864
+ Emails?: Email[];
865
+ /**
866
+ * <p>A list of <code>Address</code> objects containing addresses associated with the user.</p>
867
+ */
868
+ Addresses?: Address[];
869
+ /**
870
+ * <p>A list of <code>PhoneNumber</code> objects containing phone numbers associated with the user.</p>
871
+ */
872
+ PhoneNumbers?: PhoneNumber[];
873
+ /**
874
+ * <p>A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.</p>
875
+ */
876
+ UserType?: string;
877
+ /**
878
+ * <p>A string containing the user's title. Possible values are left unspecified given that they depend on each customer's specific needs.</p>
879
+ */
880
+ Title?: string;
881
+ /**
882
+ * <p>A string containing the preferred language of the user. For example, "American English"
883
+ * or "en-us."</p>
884
+ */
885
+ PreferredLanguage?: string;
886
+ /**
887
+ * <p>A string containing the user's geographical region or location.</p>
888
+ */
889
+ Locale?: string;
890
+ /**
891
+ * <p>A string containing the user's time zone.</p>
892
+ */
893
+ Timezone?: string;
894
+ }
895
+ export interface CreateUserResponse {
116
896
  /**
117
- * <p>The identifier for each request. This value is a globally unique ID that is generated by
118
- * the identity store service for each sent request, and is then returned inside the exception
119
- * if the request fails.</p>
897
+ * <p>The identifier of the newly created user in the identity store.</p>
120
898
  */
121
- RequestId?: string;
899
+ UserId: string | undefined;
122
900
  /**
123
- * @internal
901
+ * <p>The globally unique identifier for the identity store.</p>
124
902
  */
125
- constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
903
+ IdentityStoreId: string | undefined;
126
904
  }
127
- /**
128
- * <p>The request failed because it contains a syntax error.</p>
129
- */
130
- export declare class ValidationException extends __BaseException {
131
- readonly name: "ValidationException";
132
- readonly $fault: "client";
133
- Message?: string;
905
+ export interface DeleteUserRequest {
134
906
  /**
135
- * <p>The identifier for each request. This value is a globally unique ID that is generated by
136
- * the identity store service for each sent request, and is then returned inside the exception
137
- * if the request fails.</p>
907
+ * <p>The globally unique identifier for the identity store.</p>
138
908
  */
139
- RequestId?: string;
909
+ IdentityStoreId: string | undefined;
140
910
  /**
141
- * @internal
911
+ * <p>The identifier for a user in the identity store.</p>
142
912
  */
143
- constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
913
+ UserId: string | undefined;
914
+ }
915
+ export interface DeleteUserResponse {
144
916
  }
145
917
  export interface DescribeUserRequest {
146
918
  /**
147
919
  * <p>The globally unique identifier for the identity store, such as
148
920
  * <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
149
- * <code>1234567890</code> is a randomly generated string that contains number and lower
921
+ * <code>1234567890</code> is a randomly generated string that contains numbers and lower
150
922
  * case letters. This value is generated at the time that a new identity store is
151
923
  * created.</p>
152
924
  */
@@ -158,105 +930,85 @@ export interface DescribeUserRequest {
158
930
  }
159
931
  export interface DescribeUserResponse {
160
932
  /**
161
- * <p>Contains the user’s user name value. The length limit is 128 characters. This value can
162
- * consist of letters, accented characters, symbols, numbers, and punctuation. The characters
163
- * <code><>;:%</code> are excluded. This value is specified at the time the user is
933
+ * <p>A unique string used to identify the user. The length limit is 128 characters. This value can consist of
934
+ * letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is
164
935
  * created and stored as an attribute of the user object in the identity store.</p>
165
936
  */
166
- UserName: string | undefined;
937
+ UserName?: string;
167
938
  /**
168
939
  * <p>The identifier for a user in the identity store.</p>
169
940
  */
170
941
  UserId: string | undefined;
171
- }
172
- /**
173
- * <p>A query filter used by <code>ListUsers</code> and <code>ListGroups</code>. This filter
174
- * object provides the attribute name and attribute value to search users or groups.</p>
175
- */
176
- export interface Filter {
177
942
  /**
178
- * <p>The attribute path that is used to specify which attribute name to search. Length limit
179
- * is 255 characters. For example, <code>UserName</code> is a valid attribute path for the
180
- * <code>ListUsers</code> API, and <code>DisplayName</code> is a valid attribute path for
181
- * the <code>ListGroups</code> API.</p>
943
+ * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
944
+ * resource by an external identity provider.</p>
182
945
  */
183
- AttributePath: string | undefined;
946
+ ExternalIds?: ExternalId[];
184
947
  /**
185
- * <p>Represents the data for an attribute. Each attribute value is described as a name-value
186
- * pair. </p>
948
+ * <p>The name of the user.</p>
187
949
  */
188
- AttributeValue: string | undefined;
189
- }
190
- export interface ListGroupsRequest {
950
+ Name?: Name;
191
951
  /**
192
- * <p>The globally unique identifier for the identity store, such as
193
- * <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
194
- * <code>1234567890</code> is a randomly generated string that contains number and lower
195
- * case letters. This value is generated at the time that a new identity store is
196
- * created.</p>
952
+ * <p>The user's name value for display.</p>
197
953
  */
198
- IdentityStoreId: string | undefined;
954
+ DisplayName?: string;
199
955
  /**
200
- * <p>The maximum number of results to be returned per request. This parameter is used in the
201
- * <code>ListUsers</code> and <code>ListGroups</code> request to specify how many results
202
- * to return in one page. The length limit is 50 characters.</p>
956
+ * <p>An alternative descriptive name for the user.</p>
203
957
  */
204
- MaxResults?: number;
958
+ NickName?: string;
205
959
  /**
206
- * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
207
- * operations. This value is generated by the identity store service. It is returned in the
208
- * API response if the total results are more than the size of one page. This token is also
209
- * returned when it is used in the API request to search for the next page.</p>
960
+ * <p>A URL link for the user's profile.</p>
210
961
  */
211
- NextToken?: string;
962
+ ProfileUrl?: string;
212
963
  /**
213
- * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and
214
- * <code>ListGroups</code> request. </p>
964
+ * <p>The user's email value.</p>
215
965
  */
216
- Filters?: Filter[];
217
- }
218
- /**
219
- * <p>A group object, which contains a specified group’s metadata and attributes.</p>
220
- */
221
- export interface Group {
966
+ Emails?: Email[];
222
967
  /**
223
- * <p>The identifier for a group in the identity store.</p>
968
+ * <p>The user's physical address.</p>
224
969
  */
225
- GroupId: string | undefined;
970
+ Addresses?: Address[];
226
971
  /**
227
- * <p>Contains the group’s display name value. The length limit is 1,024 characters. This
228
- * value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new
229
- * line, carriage return, space, and nonbreaking space in this attribute. The characters
230
- * <code><>;:%</code> are excluded. This value is specified at the time the group is
231
- * created and stored as an attribute of the group object in the identity store.</p>
972
+ * <p>A list of <code>PhoneNumber</code> objects associated with a user.</p>
232
973
  */
233
- DisplayName: string | undefined;
234
- }
235
- export interface ListGroupsResponse {
974
+ PhoneNumbers?: PhoneNumber[];
236
975
  /**
237
- * <p>A list of <code>Group</code> objects in the identity store.</p>
976
+ * <p>A string indicating the user's type.</p>
238
977
  */
239
- Groups: Group[] | undefined;
978
+ UserType?: string;
240
979
  /**
241
- * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
242
- * operations. This value is generated by the identity store service. It is returned in the
243
- * API response if the total results are more than the size of one page. This token is also
244
- * returned when it1 is used in the API request to search for the next page.</p>
980
+ * <p>A string containing the user's title.</p>
245
981
  */
246
- NextToken?: string;
982
+ Title?: string;
983
+ /**
984
+ * <p>The preferred language of the user.</p>
985
+ */
986
+ PreferredLanguage?: string;
987
+ /**
988
+ * <p>A string containing the user's geographical region or location.</p>
989
+ */
990
+ Locale?: string;
991
+ /**
992
+ * <p>The time zone for a user.</p>
993
+ */
994
+ Timezone?: string;
995
+ /**
996
+ * <p>The globally unique identifier for the identity store.</p>
997
+ */
998
+ IdentityStoreId: string | undefined;
247
999
  }
248
1000
  export interface ListUsersRequest {
249
1001
  /**
250
1002
  * <p>The globally unique identifier for the identity store, such as
251
1003
  * <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
252
- * <code>1234567890</code> is a randomly generated string that contains number and lower
1004
+ * <code>1234567890</code> is a randomly generated string that contains numbers and lower
253
1005
  * case letters. This value is generated at the time that a new identity store is
254
1006
  * created.</p>
255
1007
  */
256
1008
  IdentityStoreId: string | undefined;
257
1009
  /**
258
1010
  * <p>The maximum number of results to be returned per request. This parameter is used in the
259
- * <code>ListUsers</code> and <code>ListGroups</code> request to specify how many results
1011
+ * <code>ListUsers</code> and <code>ListGroups</code> requests to specify how many results
260
1012
  * to return in one page. The length limit is 50 characters.</p>
261
1013
  */
262
1014
  MaxResults?: number;
@@ -268,26 +1020,90 @@ export interface ListUsersRequest {
268
1020
  */
269
1021
  NextToken?: string;
270
1022
  /**
1023
+ * @deprecated
1024
+ *
271
1025
  * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and
272
- * <code>ListGroups</code> request. </p>
1026
+ * <code>ListGroups</code> requests. </p>
273
1027
  */
274
1028
  Filters?: Filter[];
275
1029
  }
276
1030
  /**
277
- * <p>A user object, which contains a specified user’s metadata and attributes.</p>
1031
+ * <p>A user object that contains a specified user’s metadata and attributes.</p>
278
1032
  */
279
1033
  export interface User {
280
1034
  /**
281
- * <p>Contains the user’s user name value. The length limit is 128 characters. This value can
282
- * consist of letters, accented characters, symbols, numbers, and punctuation. The characters
283
- * <code><>;:%</code> are excluded. This value is specified at the time the user is
1035
+ * <p>A unique string used to identify the user. The length limit is 128 characters. This value can
1036
+ * consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is
284
1037
  * created and stored as an attribute of the user object in the identity store.</p>
285
1038
  */
286
- UserName: string | undefined;
1039
+ UserName?: string;
287
1040
  /**
288
1041
  * <p>The identifier for a user in the identity store.</p>
289
1042
  */
290
1043
  UserId: string | undefined;
1044
+ /**
1045
+ * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
1046
+ * resource by an external identity provider.</p>
1047
+ */
1048
+ ExternalIds?: ExternalId[];
1049
+ /**
1050
+ * <p>An object containing the user's name.</p>
1051
+ */
1052
+ Name?: Name;
1053
+ /**
1054
+ * <p>A string containing the user's name that's formatted for display when the user is
1055
+ * referenced. For example, "John Doe."</p>
1056
+ */
1057
+ DisplayName?: string;
1058
+ /**
1059
+ * <p>A string containing an alternate name for the user.</p>
1060
+ */
1061
+ NickName?: string;
1062
+ /**
1063
+ * <p>A string containing a URL that may be associated with the user.</p>
1064
+ */
1065
+ ProfileUrl?: string;
1066
+ /**
1067
+ * <p>A list of <code>Email</code> objects containing email addresses associated with the user.</p>
1068
+ */
1069
+ Emails?: Email[];
1070
+ /**
1071
+ * <p>A list of <code>Address</code> objects containing addresses associated with the user.</p>
1072
+ */
1073
+ Addresses?: Address[];
1074
+ /**
1075
+ * <p>A list of <code>PhoneNumber</code> objects containing phone numbers associated with the user.</p>
1076
+ */
1077
+ PhoneNumbers?: PhoneNumber[];
1078
+ /**
1079
+ * <p>A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.</p>
1080
+ */
1081
+ UserType?: string;
1082
+ /**
1083
+ * <p>A string containing the user's title. Possible values depend on each customer's specific
1084
+ * needs, so they are left
1085
+ * unspecified.</p>
1086
+ */
1087
+ Title?: string;
1088
+ /**
1089
+ * <p>A string containing the preferred language of the user. For example, "American English"
1090
+ * or "en-us."</p>
1091
+ */
1092
+ PreferredLanguage?: string;
1093
+ /**
1094
+ * <p>A string containing the user's geographical region or location.</p>
1095
+ */
1096
+ Locale?: string;
1097
+ /**
1098
+ * <p>A string containing the
1099
+ * user's
1100
+ * time zone.</p>
1101
+ */
1102
+ Timezone?: string;
1103
+ /**
1104
+ * <p>The globally unique identifier for the identity store.</p>
1105
+ */
1106
+ IdentityStoreId: string | undefined;
291
1107
  }
292
1108
  export interface ListUsersResponse {
293
1109
  /**
@@ -302,22 +1118,131 @@ export interface ListUsersResponse {
302
1118
  */
303
1119
  NextToken?: string;
304
1120
  }
1121
+ export interface UpdateUserRequest {
1122
+ /**
1123
+ * <p>The globally unique identifier for the identity store.</p>
1124
+ */
1125
+ IdentityStoreId: string | undefined;
1126
+ /**
1127
+ * <p>The identifier for a user in the identity store.</p>
1128
+ */
1129
+ UserId: string | undefined;
1130
+ /**
1131
+ * <p>A list of <code>AttributeOperation</code> objects to apply to the requested user. These
1132
+ * operations might add, replace, or remove an attribute.</p>
1133
+ */
1134
+ Operations: AttributeOperation[] | undefined;
1135
+ }
1136
+ export interface UpdateUserResponse {
1137
+ }
305
1138
  /**
306
1139
  * @internal
307
1140
  */
308
- export declare const DescribeGroupRequestFilterSensitiveLog: (obj: DescribeGroupRequest) => any;
1141
+ export declare const AddressFilterSensitiveLog: (obj: Address) => any;
309
1142
  /**
310
1143
  * @internal
311
1144
  */
312
- export declare const DescribeGroupResponseFilterSensitiveLog: (obj: DescribeGroupResponse) => any;
1145
+ export declare const ExternalIdFilterSensitiveLog: (obj: ExternalId) => any;
313
1146
  /**
314
1147
  * @internal
315
1148
  */
316
- export declare const DescribeUserRequestFilterSensitiveLog: (obj: DescribeUserRequest) => any;
1149
+ export declare const UniqueAttributeFilterSensitiveLog: (obj: UniqueAttribute) => any;
317
1150
  /**
318
1151
  * @internal
319
1152
  */
320
- export declare const DescribeUserResponseFilterSensitiveLog: (obj: DescribeUserResponse) => any;
1153
+ export declare const AlternateIdentifierFilterSensitiveLog: (obj: AlternateIdentifier) => any;
1154
+ /**
1155
+ * @internal
1156
+ */
1157
+ export declare const AttributeOperationFilterSensitiveLog: (obj: AttributeOperation) => any;
1158
+ /**
1159
+ * @internal
1160
+ */
1161
+ export declare const GetGroupIdRequestFilterSensitiveLog: (obj: GetGroupIdRequest) => any;
1162
+ /**
1163
+ * @internal
1164
+ */
1165
+ export declare const GetGroupIdResponseFilterSensitiveLog: (obj: GetGroupIdResponse) => any;
1166
+ /**
1167
+ * @internal
1168
+ */
1169
+ export declare const MemberIdFilterSensitiveLog: (obj: MemberId) => any;
1170
+ /**
1171
+ * @internal
1172
+ */
1173
+ export declare const GetGroupMembershipIdRequestFilterSensitiveLog: (obj: GetGroupMembershipIdRequest) => any;
1174
+ /**
1175
+ * @internal
1176
+ */
1177
+ export declare const GetGroupMembershipIdResponseFilterSensitiveLog: (obj: GetGroupMembershipIdResponse) => any;
1178
+ /**
1179
+ * @internal
1180
+ */
1181
+ export declare const GetUserIdRequestFilterSensitiveLog: (obj: GetUserIdRequest) => any;
1182
+ /**
1183
+ * @internal
1184
+ */
1185
+ export declare const GetUserIdResponseFilterSensitiveLog: (obj: GetUserIdResponse) => any;
1186
+ /**
1187
+ * @internal
1188
+ */
1189
+ export declare const CreateGroupMembershipRequestFilterSensitiveLog: (obj: CreateGroupMembershipRequest) => any;
1190
+ /**
1191
+ * @internal
1192
+ */
1193
+ export declare const CreateGroupMembershipResponseFilterSensitiveLog: (obj: CreateGroupMembershipResponse) => any;
1194
+ /**
1195
+ * @internal
1196
+ */
1197
+ export declare const DeleteGroupMembershipRequestFilterSensitiveLog: (obj: DeleteGroupMembershipRequest) => any;
1198
+ /**
1199
+ * @internal
1200
+ */
1201
+ export declare const DeleteGroupMembershipResponseFilterSensitiveLog: (obj: DeleteGroupMembershipResponse) => any;
1202
+ /**
1203
+ * @internal
1204
+ */
1205
+ export declare const DescribeGroupMembershipRequestFilterSensitiveLog: (obj: DescribeGroupMembershipRequest) => any;
1206
+ /**
1207
+ * @internal
1208
+ */
1209
+ export declare const DescribeGroupMembershipResponseFilterSensitiveLog: (obj: DescribeGroupMembershipResponse) => any;
1210
+ /**
1211
+ * @internal
1212
+ */
1213
+ export declare const ListGroupMembershipsRequestFilterSensitiveLog: (obj: ListGroupMembershipsRequest) => any;
1214
+ /**
1215
+ * @internal
1216
+ */
1217
+ export declare const GroupMembershipFilterSensitiveLog: (obj: GroupMembership) => any;
1218
+ /**
1219
+ * @internal
1220
+ */
1221
+ export declare const ListGroupMembershipsResponseFilterSensitiveLog: (obj: ListGroupMembershipsResponse) => any;
1222
+ /**
1223
+ * @internal
1224
+ */
1225
+ export declare const CreateGroupRequestFilterSensitiveLog: (obj: CreateGroupRequest) => any;
1226
+ /**
1227
+ * @internal
1228
+ */
1229
+ export declare const CreateGroupResponseFilterSensitiveLog: (obj: CreateGroupResponse) => any;
1230
+ /**
1231
+ * @internal
1232
+ */
1233
+ export declare const DeleteGroupRequestFilterSensitiveLog: (obj: DeleteGroupRequest) => any;
1234
+ /**
1235
+ * @internal
1236
+ */
1237
+ export declare const DeleteGroupResponseFilterSensitiveLog: (obj: DeleteGroupResponse) => any;
1238
+ /**
1239
+ * @internal
1240
+ */
1241
+ export declare const DescribeGroupRequestFilterSensitiveLog: (obj: DescribeGroupRequest) => any;
1242
+ /**
1243
+ * @internal
1244
+ */
1245
+ export declare const DescribeGroupResponseFilterSensitiveLog: (obj: DescribeGroupResponse) => any;
321
1246
  /**
322
1247
  * @internal
323
1248
  */
@@ -334,6 +1259,70 @@ export declare const GroupFilterSensitiveLog: (obj: Group) => any;
334
1259
  * @internal
335
1260
  */
336
1261
  export declare const ListGroupsResponseFilterSensitiveLog: (obj: ListGroupsResponse) => any;
1262
+ /**
1263
+ * @internal
1264
+ */
1265
+ export declare const UpdateGroupRequestFilterSensitiveLog: (obj: UpdateGroupRequest) => any;
1266
+ /**
1267
+ * @internal
1268
+ */
1269
+ export declare const UpdateGroupResponseFilterSensitiveLog: (obj: UpdateGroupResponse) => any;
1270
+ /**
1271
+ * @internal
1272
+ */
1273
+ export declare const IsMemberInGroupsRequestFilterSensitiveLog: (obj: IsMemberInGroupsRequest) => any;
1274
+ /**
1275
+ * @internal
1276
+ */
1277
+ export declare const GroupMembershipExistenceResultFilterSensitiveLog: (obj: GroupMembershipExistenceResult) => any;
1278
+ /**
1279
+ * @internal
1280
+ */
1281
+ export declare const IsMemberInGroupsResponseFilterSensitiveLog: (obj: IsMemberInGroupsResponse) => any;
1282
+ /**
1283
+ * @internal
1284
+ */
1285
+ export declare const ListGroupMembershipsForMemberRequestFilterSensitiveLog: (obj: ListGroupMembershipsForMemberRequest) => any;
1286
+ /**
1287
+ * @internal
1288
+ */
1289
+ export declare const ListGroupMembershipsForMemberResponseFilterSensitiveLog: (obj: ListGroupMembershipsForMemberResponse) => any;
1290
+ /**
1291
+ * @internal
1292
+ */
1293
+ export declare const EmailFilterSensitiveLog: (obj: Email) => any;
1294
+ /**
1295
+ * @internal
1296
+ */
1297
+ export declare const NameFilterSensitiveLog: (obj: Name) => any;
1298
+ /**
1299
+ * @internal
1300
+ */
1301
+ export declare const PhoneNumberFilterSensitiveLog: (obj: PhoneNumber) => any;
1302
+ /**
1303
+ * @internal
1304
+ */
1305
+ export declare const CreateUserRequestFilterSensitiveLog: (obj: CreateUserRequest) => any;
1306
+ /**
1307
+ * @internal
1308
+ */
1309
+ export declare const CreateUserResponseFilterSensitiveLog: (obj: CreateUserResponse) => any;
1310
+ /**
1311
+ * @internal
1312
+ */
1313
+ export declare const DeleteUserRequestFilterSensitiveLog: (obj: DeleteUserRequest) => any;
1314
+ /**
1315
+ * @internal
1316
+ */
1317
+ export declare const DeleteUserResponseFilterSensitiveLog: (obj: DeleteUserResponse) => any;
1318
+ /**
1319
+ * @internal
1320
+ */
1321
+ export declare const DescribeUserRequestFilterSensitiveLog: (obj: DescribeUserRequest) => any;
1322
+ /**
1323
+ * @internal
1324
+ */
1325
+ export declare const DescribeUserResponseFilterSensitiveLog: (obj: DescribeUserResponse) => any;
337
1326
  /**
338
1327
  * @internal
339
1328
  */
@@ -346,3 +1335,11 @@ export declare const UserFilterSensitiveLog: (obj: User) => any;
346
1335
  * @internal
347
1336
  */
348
1337
  export declare const ListUsersResponseFilterSensitiveLog: (obj: ListUsersResponse) => any;
1338
+ /**
1339
+ * @internal
1340
+ */
1341
+ export declare const UpdateUserRequestFilterSensitiveLog: (obj: UpdateUserRequest) => any;
1342
+ /**
1343
+ * @internal
1344
+ */
1345
+ export declare const UpdateUserResponseFilterSensitiveLog: (obj: UpdateUserResponse) => any;