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