@aws-sdk/client-identitystore 3.162.0 → 3.168.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.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,30 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.168.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.167.0...v3.168.0) (2022-09-09)
7
+
8
+ **Note:** Version bump only for package @aws-sdk/client-identitystore
9
+
10
+
11
+
12
+
13
+
14
+ # [3.165.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.164.0...v3.165.0) (2022-09-06)
15
+
16
+ **Note:** Version bump only for package @aws-sdk/client-identitystore
17
+
18
+
19
+
20
+
21
+
22
+ # [3.163.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.162.0...v3.163.0) (2022-09-01)
23
+
24
+ **Note:** Version bump only for package @aws-sdk/client-identitystore
25
+
26
+
27
+
28
+
29
+
6
30
  # [3.162.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.161.0...v3.162.0) (2022-08-31)
7
31
 
8
32
 
package/README.md CHANGED
@@ -9,10 +9,19 @@
9
9
 
10
10
  AWS SDK for JavaScript Identitystore Client for Node.js, Browser and React Native.
11
11
 
12
- <p>The AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your
13
- identities (users and groups). For more information about AWS, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">AWS Single Sign-On User
12
+ <p>The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of
13
+ your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User
14
14
  Guide</a>.</p>
15
15
 
16
+ <note>
17
+ <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and
18
+ <code>identitystore</code> API namespaces will continue to retain their original name for
19
+ backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p>
20
+ </note>
21
+
22
+ <p>This reference guide describes the identity store operations that you can call
23
+ programatically and includes detailed information on data types and errors.</p>
24
+
16
25
  ## Installing
17
26
 
18
27
  To install the this package, simply type add or install @aws-sdk/client-identitystore
@@ -1834,6 +1834,9 @@ const loadRestJsonErrorCode = (output, data) => {
1834
1834
  if (typeof cleanValue === "number") {
1835
1835
  cleanValue = cleanValue.toString();
1836
1836
  }
1837
+ if (cleanValue.indexOf(",") >= 0) {
1838
+ cleanValue = cleanValue.split(",")[0];
1839
+ }
1837
1840
  if (cleanValue.indexOf(":") >= 0) {
1838
1841
  cleanValue = cleanValue.split(":")[0];
1839
1842
  }
@@ -2156,6 +2156,9 @@ var loadRestJsonErrorCode = function (output, data) {
2156
2156
  if (typeof cleanValue === "number") {
2157
2157
  cleanValue = cleanValue.toString();
2158
2158
  }
2159
+ if (cleanValue.indexOf(",") >= 0) {
2160
+ cleanValue = cleanValue.split(",")[0];
2161
+ }
2159
2162
  if (cleanValue.indexOf(":") >= 0) {
2160
2163
  cleanValue = cleanValue.split(":")[0];
2161
2164
  }
@@ -20,9 +20,18 @@ import { UpdateGroupCommandInput, UpdateGroupCommandOutput } from "./commands/Up
20
20
  import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
21
21
  import { IdentitystoreClient } from "./IdentitystoreClient";
22
22
  /**
23
- * <p>The AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your
24
- * identities (users and groups). For more information about AWS, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">AWS Single Sign-On User
23
+ * <p>The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of
24
+ * your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User
25
25
  * Guide</a>.</p>
26
+ *
27
+ * <note>
28
+ * <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and
29
+ * <code>identitystore</code> API namespaces will continue to retain their original name for
30
+ * backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p>
31
+ * </note>
32
+ *
33
+ * <p>This reference guide describes the identity store operations that you can call
34
+ * programatically and includes detailed information on data types and errors.</p>
26
35
  */
27
36
  export declare class Identitystore extends IdentitystoreClient {
28
37
  /**
@@ -62,13 +71,14 @@ export declare class Identitystore extends IdentitystoreClient {
62
71
  deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
63
72
  deleteUser(args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
64
73
  /**
65
- * <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity store.</p>
74
+ * <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity
75
+ * store.</p>
66
76
  */
67
77
  describeGroup(args: DescribeGroupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGroupCommandOutput>;
68
78
  describeGroup(args: DescribeGroupCommandInput, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
69
79
  describeGroup(args: DescribeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
70
80
  /**
71
- * <p>Retrieves membership metadata and attributes from <code>MembershipId</code> in a group.</p>
81
+ * <p>Retrieves membership metadata and attributes from <code>MembershipId</code> in an identity store.</p>
72
82
  */
73
83
  describeGroupMembership(args: DescribeGroupMembershipCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGroupMembershipCommandOutput>;
74
84
  describeGroupMembership(args: DescribeGroupMembershipCommandInput, cb: (err: any, data?: DescribeGroupMembershipCommandOutput) => void): void;
@@ -86,7 +96,7 @@ export declare class Identitystore extends IdentitystoreClient {
86
96
  getGroupId(args: GetGroupIdCommandInput, cb: (err: any, data?: GetGroupIdCommandOutput) => void): void;
87
97
  getGroupId(args: GetGroupIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupIdCommandOutput) => void): void;
88
98
  /**
89
- * <p>Retrieves the <code>MembershipId</code> in a group.</p>
99
+ * <p>Retrieves the <code>MembershipId</code> in an identity store.</p>
90
100
  */
91
101
  getGroupMembershipId(args: GetGroupMembershipIdCommandInput, options?: __HttpHandlerOptions): Promise<GetGroupMembershipIdCommandOutput>;
92
102
  getGroupMembershipId(args: GetGroupMembershipIdCommandInput, cb: (err: any, data?: GetGroupMembershipIdCommandOutput) => void): void;
@@ -98,7 +108,7 @@ export declare class Identitystore extends IdentitystoreClient {
98
108
  getUserId(args: GetUserIdCommandInput, cb: (err: any, data?: GetUserIdCommandOutput) => void): void;
99
109
  getUserId(args: GetUserIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserIdCommandOutput) => void): void;
100
110
  /**
101
- * <p>Returns if a member exists in specified groups.</p>
111
+ * <p>Checks the user's membership in all requested groups and returns if the member exists in all queried groups.</p>
102
112
  */
103
113
  isMemberInGroups(args: IsMemberInGroupsCommandInput, options?: __HttpHandlerOptions): Promise<IsMemberInGroupsCommandOutput>;
104
114
  isMemberInGroups(args: IsMemberInGroupsCommandInput, cb: (err: any, data?: IsMemberInGroupsCommandOutput) => void): void;
@@ -116,19 +126,19 @@ export declare class Identitystore extends IdentitystoreClient {
116
126
  listGroupMembershipsForMember(args: ListGroupMembershipsForMemberCommandInput, cb: (err: any, data?: ListGroupMembershipsForMemberCommandOutput) => void): void;
117
127
  listGroupMembershipsForMember(args: ListGroupMembershipsForMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupMembershipsForMemberCommandOutput) => void): void;
118
128
  /**
119
- * <p>
120
- * <i>Filtering for a group by the group <code>DisplayName</code> attribute is deprecated. Instead, use the <code>GetGroupId</code> API action.</i>
121
- * </p>
122
- * <p>Lists all groups in the identity store. Returns a paginated list of complete <code>Group</code> objects.</p>
129
+ * <p>Lists the attribute name and value of the group that you specified in the search. We
130
+ * only support <code>DisplayName</code> as a valid filter attribute path currently, and
131
+ * filter is required. This API returns minimum attributes, including <code>GroupId</code> and
132
+ * group <code>DisplayName</code> in the response.</p>
123
133
  */
124
134
  listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupsCommandOutput>;
125
135
  listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
126
136
  listGroups(args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
127
137
  /**
128
- * <p>
129
- * <i>Filtering for a user by the <code>UserName</code> attribute is deprecated. Instead, use the <code>GetUserId</code> API action.</i>
130
- * </p>
131
- * <p>Lists all users in the identity store. Returns a paginated list of complete <code>User</code> objects.</p>
138
+ * <p>Lists the attribute name and value of the user that you specified in the search. We only
139
+ * support <code>UserName</code> as a valid filter attribute path currently, and filter is
140
+ * required. This API returns minimum attributes, including <code>UserId</code> and
141
+ * <code>UserName</code> in the response.</p>
132
142
  */
133
143
  listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise<ListUsersCommandOutput>;
134
144
  listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
@@ -145,9 +145,18 @@ declare type IdentitystoreClientResolvedConfigType = __SmithyResolvedConfigurati
145
145
  export interface IdentitystoreClientResolvedConfig extends IdentitystoreClientResolvedConfigType {
146
146
  }
147
147
  /**
148
- * <p>The AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your
149
- * identities (users and groups). For more information about AWS, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">AWS Single Sign-On User
148
+ * <p>The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of
149
+ * your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User
150
150
  * Guide</a>.</p>
151
+ *
152
+ * <note>
153
+ * <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and
154
+ * <code>identitystore</code> API namespaces will continue to retain their original name for
155
+ * backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p>
156
+ * </note>
157
+ *
158
+ * <p>This reference guide describes the identity store operations that you can call
159
+ * programatically and includes detailed information on data types and errors.</p>
151
160
  */
152
161
  export declare class IdentitystoreClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IdentitystoreClientResolvedConfig> {
153
162
  /**
@@ -7,7 +7,8 @@ export interface DescribeGroupCommandInput extends DescribeGroupRequest {
7
7
  export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity store.</p>
10
+ * <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity
11
+ * store.</p>
11
12
  * @example
12
13
  * Use a bare-bones client and the command you need to make an API call.
13
14
  * ```javascript
@@ -7,7 +7,7 @@ export interface DescribeGroupMembershipCommandInput extends DescribeGroupMember
7
7
  export interface DescribeGroupMembershipCommandOutput extends DescribeGroupMembershipResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Retrieves membership metadata and attributes from <code>MembershipId</code> in a group.</p>
10
+ * <p>Retrieves membership metadata and attributes from <code>MembershipId</code> in an identity store.</p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -7,7 +7,7 @@ export interface GetGroupMembershipIdCommandInput extends GetGroupMembershipIdRe
7
7
  export interface GetGroupMembershipIdCommandOutput extends GetGroupMembershipIdResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Retrieves the <code>MembershipId</code> in a group.</p>
10
+ * <p>Retrieves the <code>MembershipId</code> in an identity store.</p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -7,7 +7,7 @@ export interface IsMemberInGroupsCommandInput extends IsMemberInGroupsRequest {
7
7
  export interface IsMemberInGroupsCommandOutput extends IsMemberInGroupsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Returns if a member exists in specified groups.</p>
10
+ * <p>Checks the user's membership in all requested groups and returns if the member exists in all queried groups.</p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -7,10 +7,10 @@ export interface ListGroupsCommandInput extends ListGroupsRequest {
7
7
  export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>
11
- * <i>Filtering for a group by the group <code>DisplayName</code> attribute is deprecated. Instead, use the <code>GetGroupId</code> API action.</i>
12
- * </p>
13
- * <p>Lists all groups in the identity store. Returns a paginated list of complete <code>Group</code> objects.</p>
10
+ * <p>Lists the attribute name and value of the group that you specified in the search. We
11
+ * only support <code>DisplayName</code> as a valid filter attribute path currently, and
12
+ * filter is required. This API returns minimum attributes, including <code>GroupId</code> and
13
+ * group <code>DisplayName</code> in the response.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -7,10 +7,10 @@ export interface ListUsersCommandInput extends ListUsersRequest {
7
7
  export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>
11
- * <i>Filtering for a user by the <code>UserName</code> attribute is deprecated. Instead, use the <code>GetUserId</code> API action.</i>
12
- * </p>
13
- * <p>Lists all users in the identity store. Returns a paginated list of complete <code>User</code> objects.</p>
10
+ * <p>Lists the attribute name and value of the user that you specified in the search. We only
11
+ * support <code>UserName</code> as a valid filter attribute path currently, and filter is
12
+ * required. This API returns minimum attributes, including <code>UserId</code> and
13
+ * <code>UserName</code> in the response.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -24,7 +24,9 @@ export declare class AccessDeniedException extends __BaseException {
24
24
  */
25
25
  export interface Address {
26
26
  /**
27
- * <p>The street of the address.</p>
27
+ * <p>The
28
+ * street
29
+ * of the address.</p>
28
30
  */
29
31
  StreetAddress?: string;
30
32
  /**
@@ -32,7 +34,9 @@ export interface Address {
32
34
  */
33
35
  Locality?: string;
34
36
  /**
35
- * <p>The region of the address.</p>
37
+ * <p>The
38
+ * region
39
+ * of the address.</p>
36
40
  */
37
41
  Region?: string;
38
42
  /**
@@ -52,7 +56,11 @@ export interface Address {
52
56
  */
53
57
  Type?: string;
54
58
  /**
55
- * <p>A boolean representing whether this is the primary address for the associated resource.</p>
59
+ * <p>A
60
+ * Boolean
61
+ * value
62
+ * representing whether this is the primary address for the associated
63
+ * resource.</p>
56
64
  */
57
65
  Primary?: boolean;
58
66
  }
@@ -79,12 +87,13 @@ export interface UniqueAttribute {
79
87
  */
80
88
  AttributePath: string | undefined;
81
89
  /**
82
- * <p>The value of the attribute.</p>
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>
83
92
  */
84
93
  AttributeValue: __DocumentType | undefined;
85
94
  }
86
95
  /**
87
- * <p>A unique identifier for the group value that is not the group's primary identifier. This value can be
96
+ * <p>A unique identifier for a user or group that is not the its primary identifier. This value can be
88
97
  * an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a
89
98
  * unique <code>GroupDisplayName</code>.</p>
90
99
  */
@@ -128,7 +137,8 @@ export interface AttributeOperation {
128
137
  */
129
138
  AttributePath: string | undefined;
130
139
  /**
131
- * <p>The value of the attribute.</p>
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>
132
142
  */
133
143
  AttributeValue?: __DocumentType;
134
144
  }
@@ -138,7 +148,7 @@ export interface GetGroupIdRequest {
138
148
  */
139
149
  IdentityStoreId: string | undefined;
140
150
  /**
141
- * <p>A unique identifier for the group value that is not the group's primary identifier. This value can be
151
+ * <p>A unique identifier for an identity resource that is not the primary identifier. This value can be
142
152
  * an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a
143
153
  * unique <code>GroupDisplayName</code>.</p>
144
154
  */
@@ -242,7 +252,7 @@ export interface GetGroupMembershipIdRequest {
242
252
  }
243
253
  export interface GetGroupMembershipIdResponse {
244
254
  /**
245
- * <p>The identifier for a <code>GroupMembership</code> in the identity store.</p>
255
+ * <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
246
256
  */
247
257
  MembershipId: string | undefined;
248
258
  /**
@@ -256,7 +266,7 @@ export interface GetUserIdRequest {
256
266
  */
257
267
  IdentityStoreId: string | undefined;
258
268
  /**
259
- * <p>Any unique attribute associated with a user that is not the <code>UserId</code>.</p>
269
+ * <p>A unique identifier for an identity resource that is not the primary identifier.</p>
260
270
  */
261
271
  AlternateIdentifier: AlternateIdentifier | undefined;
262
272
  }
@@ -326,7 +336,7 @@ export interface CreateGroupMembershipRequest {
326
336
  }
327
337
  export interface CreateGroupMembershipResponse {
328
338
  /**
329
- * <p>The identifier for a <code>GroupMembership</code> in the identity store.</p>
339
+ * <p>The identifier for a newly created <code>GroupMembership</code> in an identity store.</p>
330
340
  */
331
341
  MembershipId: string | undefined;
332
342
  /**
@@ -356,7 +366,7 @@ export interface DeleteGroupMembershipRequest {
356
366
  */
357
367
  IdentityStoreId: string | undefined;
358
368
  /**
359
- * <p>The identifier for a <code>GroupMembership</code> in the identity store.</p>
369
+ * <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
360
370
  */
361
371
  MembershipId: string | undefined;
362
372
  }
@@ -368,7 +378,7 @@ export interface DescribeGroupMembershipRequest {
368
378
  */
369
379
  IdentityStoreId: string | undefined;
370
380
  /**
371
- * <p>The identifier for a <code>GroupMembership</code> in the identity store.</p>
381
+ * <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
372
382
  */
373
383
  MembershipId: string | undefined;
374
384
  }
@@ -378,7 +388,7 @@ export interface DescribeGroupMembershipResponse {
378
388
  */
379
389
  IdentityStoreId: string | undefined;
380
390
  /**
381
- * <p>The identifier for a <code>GroupMembership</code> in the identity store.</p>
391
+ * <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
382
392
  */
383
393
  MembershipId: string | undefined;
384
394
  /**
@@ -400,9 +410,8 @@ export interface ListGroupMembershipsRequest {
400
410
  */
401
411
  GroupId: string | undefined;
402
412
  /**
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>
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>
406
415
  */
407
416
  MaxResults?: number;
408
417
  /**
@@ -420,7 +429,7 @@ export interface GroupMembership {
420
429
  */
421
430
  IdentityStoreId: string | undefined;
422
431
  /**
423
- * <p>The identifier for a <code>GroupMembership</code> object in the identity store.</p>
432
+ * <p>The identifier for a <code>GroupMembership</code> object in an identity store.</p>
424
433
  */
425
434
  MembershipId?: string;
426
435
  /**
@@ -438,7 +447,7 @@ export interface ListGroupMembershipsResponse {
438
447
  */
439
448
  GroupMemberships: GroupMembership[] | undefined;
440
449
  /**
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>
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>
442
451
  */
443
452
  NextToken?: string;
444
453
  }
@@ -458,7 +467,9 @@ export interface CreateGroupRequest {
458
467
  }
459
468
  export interface CreateGroupResponse {
460
469
  /**
461
- * <p>The identifier of the newly created group in the identity store.</p>
470
+ * <p>The
471
+ * identifier
472
+ * of the newly created group in the identity store.</p>
462
473
  */
463
474
  GroupId: string | undefined;
464
475
  /**
@@ -521,8 +532,8 @@ export interface DescribeGroupResponse {
521
532
  IdentityStoreId: string | undefined;
522
533
  }
523
534
  /**
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>
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>
526
537
  */
527
538
  export interface Filter {
528
539
  /**
@@ -533,7 +544,8 @@ export interface Filter {
533
544
  */
534
545
  AttributePath: string | undefined;
535
546
  /**
536
- * <p>Represents the data for an attribute. Each attribute value is described as a name-value pair. </p>
547
+ * <p>Represents the data for an attribute. Each attribute value is described as a name-value
548
+ * pair. </p>
537
549
  */
538
550
  AttributeValue: string | undefined;
539
551
  }
@@ -562,7 +574,7 @@ export interface ListGroupsRequest {
562
574
  /**
563
575
  * @deprecated
564
576
  *
565
- * <p>A list of <code>Filter</code> objects that is used in the <code>ListUsers</code> and
577
+ * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and
566
578
  * <code>ListGroups</code> requests.</p>
567
579
  */
568
580
  Filters?: Filter[];
@@ -579,8 +591,8 @@ export interface Group {
579
591
  * <p>The group’s display name value. The length limit is 1,024 characters. This
580
592
  * value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new
581
593
  * 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>
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>
584
596
  */
585
597
  DisplayName?: string;
586
598
  /**
@@ -683,7 +695,7 @@ export interface GroupMembershipExistenceResult {
683
695
  }
684
696
  export interface IsMemberInGroupsResponse {
685
697
  /**
686
- * <p>An object containing results of batch <code>IsMemberInGroups</code> call.</p>
698
+ * <p>A list containing the results of membership existence checks.</p>
687
699
  */
688
700
  Results: GroupMembershipExistenceResult[] | undefined;
689
701
  }
@@ -701,7 +713,7 @@ export interface ListGroupMembershipsForMemberRequest {
701
713
  */
702
714
  MaxResults?: number;
703
715
  /**
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>
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>
705
717
  */
706
718
  NextToken?: string;
707
719
  }
@@ -711,7 +723,7 @@ export interface ListGroupMembershipsForMemberResponse {
711
723
  */
712
724
  GroupMemberships: GroupMembership[] | undefined;
713
725
  /**
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.
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.
715
727
  * </p>
716
728
  */
717
729
  NextToken?: string;
@@ -755,12 +767,19 @@ export interface Email {
755
767
  */
756
768
  Type?: string;
757
769
  /**
758
- * <p>A boolean representing whether this is the primary email for the associated resource.</p>
770
+ * <p>A
771
+ * Boolean
772
+ * value
773
+ * representing whether this is the primary email
774
+ * address
775
+ * for the associated resource.</p>
759
776
  */
760
777
  Primary?: boolean;
761
778
  }
762
779
  /**
763
- * <p>The name of the user.</p>
780
+ * <p>The
781
+ * full name
782
+ * of the user.</p>
764
783
  */
765
784
  export interface Name {
766
785
  /**
@@ -793,7 +812,9 @@ export interface Name {
793
812
  */
794
813
  export interface PhoneNumber {
795
814
  /**
796
- * <p>A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".</p>
815
+ * <p>A string containing a phone number. For example,
816
+ * "8675309"
817
+ * or "+1 (800) 123-4567".</p>
797
818
  */
798
819
  Value?: string;
799
820
  /**
@@ -801,7 +822,11 @@ export interface PhoneNumber {
801
822
  */
802
823
  Type?: string;
803
824
  /**
804
- * <p>A boolean representing whether this is the primary phone number for the associated resource.</p>
825
+ * <p>A
826
+ * Boolean
827
+ * value
828
+ * representing whether this is the primary phone number for the associated
829
+ * resource.</p>
805
830
  */
806
831
  Primary?: boolean;
807
832
  }
@@ -812,7 +837,7 @@ export interface CreateUserRequest {
812
837
  IdentityStoreId: string | undefined;
813
838
  /**
814
839
  * <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.
840
+ * This value can consist of letters, accented characters, symbols, numbers, and punctuation.
816
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>
817
842
  */
818
843
  UserName?: string;
@@ -905,9 +930,8 @@ export interface DescribeUserRequest {
905
930
  }
906
931
  export interface DescribeUserResponse {
907
932
  /**
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
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
911
935
  * created and stored as an attribute of the user object in the identity store.</p>
912
936
  */
913
937
  UserName?: string;
@@ -998,8 +1022,8 @@ export interface ListUsersRequest {
998
1022
  /**
999
1023
  * @deprecated
1000
1024
  *
1001
- * <p>A list of <code>Filter</code> objects that is used in the <code>ListUsers</code> and
1002
- * <code>ListGroups</code> requests.</p>
1025
+ * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and
1026
+ * <code>ListGroups</code> requests. </p>
1003
1027
  */
1004
1028
  Filters?: Filter[];
1005
1029
  }
@@ -1008,9 +1032,8 @@ export interface ListUsersRequest {
1008
1032
  */
1009
1033
  export interface User {
1010
1034
  /**
1011
- * <p>The user’s user name value. The length limit is 128 characters. This value can
1012
- * consist of letters, accented characters, symbols, numbers, and punctuation. The characters
1013
- * <code>&lt;&gt;;:%</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
1014
1037
  * created and stored as an attribute of the user object in the identity store.</p>
1015
1038
  */
1016
1039
  UserName?: string;
@@ -1057,7 +1080,9 @@ export interface User {
1057
1080
  */
1058
1081
  UserType?: string;
1059
1082
  /**
1060
- * <p>A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified</p>
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>
1061
1086
  */
1062
1087
  Title?: string;
1063
1088
  /**
@@ -1070,7 +1095,9 @@ export interface User {
1070
1095
  */
1071
1096
  Locale?: string;
1072
1097
  /**
1073
- * <p>A string containing the user's time zone.</p>
1098
+ * <p>A string containing the
1099
+ * user's
1100
+ * time zone.</p>
1074
1101
  */
1075
1102
  Timezone?: string;
1076
1103
  /**
package/package.json CHANGED
@@ -1,12 +1,13 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-identitystore",
3
3
  "description": "AWS SDK for JavaScript Identitystore Client for Node.js, Browser and React Native",
4
- "version": "3.162.0",
4
+ "version": "3.168.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
8
8
  "build:docs": "typedoc",
9
9
  "build:es": "tsc -p tsconfig.es.json",
10
+ "build:include:deps": "lerna run --scope $npm_package_name --include-dependencies build",
10
11
  "build:types": "tsc -p tsconfig.types.json",
11
12
  "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
12
13
  "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo"
@@ -18,41 +19,41 @@
18
19
  "dependencies": {
19
20
  "@aws-crypto/sha256-browser": "2.0.0",
20
21
  "@aws-crypto/sha256-js": "2.0.0",
21
- "@aws-sdk/client-sts": "3.162.0",
22
- "@aws-sdk/config-resolver": "3.162.0",
23
- "@aws-sdk/credential-provider-node": "3.162.0",
24
- "@aws-sdk/fetch-http-handler": "3.162.0",
25
- "@aws-sdk/hash-node": "3.162.0",
26
- "@aws-sdk/invalid-dependency": "3.162.0",
27
- "@aws-sdk/middleware-content-length": "3.162.0",
28
- "@aws-sdk/middleware-host-header": "3.162.0",
29
- "@aws-sdk/middleware-logger": "3.162.0",
30
- "@aws-sdk/middleware-recursion-detection": "3.162.0",
31
- "@aws-sdk/middleware-retry": "3.162.0",
32
- "@aws-sdk/middleware-serde": "3.162.0",
33
- "@aws-sdk/middleware-signing": "3.162.0",
34
- "@aws-sdk/middleware-stack": "3.162.0",
35
- "@aws-sdk/middleware-user-agent": "3.162.0",
36
- "@aws-sdk/node-config-provider": "3.162.0",
37
- "@aws-sdk/node-http-handler": "3.162.0",
38
- "@aws-sdk/protocol-http": "3.162.0",
39
- "@aws-sdk/smithy-client": "3.162.0",
40
- "@aws-sdk/types": "3.162.0",
41
- "@aws-sdk/url-parser": "3.162.0",
42
- "@aws-sdk/util-base64-browser": "3.109.0",
43
- "@aws-sdk/util-base64-node": "3.55.0",
44
- "@aws-sdk/util-body-length-browser": "3.154.0",
45
- "@aws-sdk/util-body-length-node": "3.55.0",
46
- "@aws-sdk/util-defaults-mode-browser": "3.162.0",
47
- "@aws-sdk/util-defaults-mode-node": "3.162.0",
48
- "@aws-sdk/util-user-agent-browser": "3.162.0",
49
- "@aws-sdk/util-user-agent-node": "3.162.0",
50
- "@aws-sdk/util-utf8-browser": "3.109.0",
51
- "@aws-sdk/util-utf8-node": "3.109.0",
22
+ "@aws-sdk/client-sts": "3.168.0",
23
+ "@aws-sdk/config-resolver": "3.168.0",
24
+ "@aws-sdk/credential-provider-node": "3.168.0",
25
+ "@aws-sdk/fetch-http-handler": "3.168.0",
26
+ "@aws-sdk/hash-node": "3.168.0",
27
+ "@aws-sdk/invalid-dependency": "3.168.0",
28
+ "@aws-sdk/middleware-content-length": "3.168.0",
29
+ "@aws-sdk/middleware-host-header": "3.168.0",
30
+ "@aws-sdk/middleware-logger": "3.168.0",
31
+ "@aws-sdk/middleware-recursion-detection": "3.168.0",
32
+ "@aws-sdk/middleware-retry": "3.168.0",
33
+ "@aws-sdk/middleware-serde": "3.168.0",
34
+ "@aws-sdk/middleware-signing": "3.168.0",
35
+ "@aws-sdk/middleware-stack": "3.168.0",
36
+ "@aws-sdk/middleware-user-agent": "3.168.0",
37
+ "@aws-sdk/node-config-provider": "3.168.0",
38
+ "@aws-sdk/node-http-handler": "3.168.0",
39
+ "@aws-sdk/protocol-http": "3.168.0",
40
+ "@aws-sdk/smithy-client": "3.168.0",
41
+ "@aws-sdk/types": "3.168.0",
42
+ "@aws-sdk/url-parser": "3.168.0",
43
+ "@aws-sdk/util-base64-browser": "3.168.0",
44
+ "@aws-sdk/util-base64-node": "3.168.0",
45
+ "@aws-sdk/util-body-length-browser": "3.168.0",
46
+ "@aws-sdk/util-body-length-node": "3.168.0",
47
+ "@aws-sdk/util-defaults-mode-browser": "3.168.0",
48
+ "@aws-sdk/util-defaults-mode-node": "3.168.0",
49
+ "@aws-sdk/util-user-agent-browser": "3.168.0",
50
+ "@aws-sdk/util-user-agent-node": "3.168.0",
51
+ "@aws-sdk/util-utf8-browser": "3.168.0",
52
+ "@aws-sdk/util-utf8-node": "3.168.0",
52
53
  "tslib": "^2.3.1"
53
54
  },
54
55
  "devDependencies": {
55
- "@aws-sdk/service-client-documentation-generator": "3.58.0",
56
+ "@aws-sdk/service-client-documentation-generator": "3.168.0",
56
57
  "@tsconfig/recommended": "1.0.1",
57
58
  "@types/node": "^12.7.5",
58
59
  "concurrently": "7.0.0",