@aws-sdk/client-identitystore 3.142.0 → 3.154.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.154.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.153.0...v3.154.0) (2022-08-19)
7
+
8
+ **Note:** Version bump only for package @aws-sdk/client-identitystore
9
+
10
+
11
+
12
+
13
+
14
+ # [3.150.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.149.0...v3.150.0) (2022-08-15)
15
+
16
+ **Note:** Version bump only for package @aws-sdk/client-identitystore
17
+
18
+
19
+
20
+
21
+
22
+ # [3.145.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.144.0...v3.145.0) (2022-08-08)
23
+
24
+ **Note:** Version bump only for package @aws-sdk/client-identitystore
25
+
26
+
27
+
28
+
29
+
6
30
  # [3.142.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.141.0...v3.142.0) (2022-08-02)
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 Amazon Web Services 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">Amazon Web Services SSO User
14
14
  Guide</a>.</p>
15
15
 
16
+ <note>
17
+ <p>Although Amazon Web Services 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">Amazon Web Services SSO 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
@@ -5,35 +5,48 @@ import { ListGroupsCommandInput, ListGroupsCommandOutput } from "./commands/List
5
5
  import { ListUsersCommandInput, ListUsersCommandOutput } from "./commands/ListUsersCommand";
6
6
  import { IdentitystoreClient } from "./IdentitystoreClient";
7
7
  /**
8
- * <p>The AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your
9
- * 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
8
+ * <p>The Identity Store service used by Amazon Web Services Single Sign On provides a single place to retrieve all of
9
+ * your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">Amazon Web Services SSO User
10
10
  * Guide</a>.</p>
11
+ *
12
+ * <note>
13
+ * <p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and
14
+ * <code>identitystore</code> API namespaces will continue to retain their original name for
15
+ * backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">Amazon Web Services SSO rename</a>.</p>
16
+ * </note>
17
+ *
18
+ * <p>This reference guide describes the identity store operations that you can call
19
+ * programatically and includes detailed information on data types and errors.</p>
11
20
  */
12
21
  export declare class Identitystore extends IdentitystoreClient {
13
22
  /**
14
- * <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity store.</p>
23
+ * <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity
24
+ * store.</p>
15
25
  */
16
26
  describeGroup(args: DescribeGroupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGroupCommandOutput>;
17
27
  describeGroup(args: DescribeGroupCommandInput, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
18
28
  describeGroup(args: DescribeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
19
29
  /**
20
- * <p>Retrieves the user metadata and attributes from <code>UserId</code> in an identity store.</p>
30
+ * <p>Retrieves the user metadata and attributes from <code>UserId</code> in an identity
31
+ * store.</p>
21
32
  */
22
33
  describeUser(args: DescribeUserCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUserCommandOutput>;
23
34
  describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void;
24
35
  describeUser(args: DescribeUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserCommandOutput) => void): void;
25
36
  /**
26
- * <p>Lists the attribute name and value of the group that you specified in the search. We only support <code>DisplayName</code> as a valid filter
27
- * attribute path currently, and filter is required. This API returns minimum attributes, including <code>GroupId</code> and group
28
- * <code>DisplayName</code> in the response.</p>
37
+ * <p>Lists the attribute name and value of the group that you specified in the search. We
38
+ * only support <code>DisplayName</code> as a valid filter attribute path currently, and
39
+ * filter is required. This API returns minimum attributes, including <code>GroupId</code> and
40
+ * group <code>DisplayName</code> in the response.</p>
29
41
  */
30
42
  listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupsCommandOutput>;
31
43
  listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
32
44
  listGroups(args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
33
45
  /**
34
- * <p>Lists the attribute name and value of the user that you specified in the search. We only support <code>UserName</code> as a valid filter attribute
35
- * path currently, and filter is required. This API returns minimum attributes, including <code>UserId</code> and <code>UserName</code> in the
36
- * response.</p>
46
+ * <p>Lists the attribute name and value of the user that you specified in the search. We only
47
+ * support <code>UserName</code> as a valid filter attribute path currently, and filter is
48
+ * required. This API returns minimum attributes, including <code>UserId</code> and
49
+ * <code>UserName</code> in the response.</p>
37
50
  */
38
51
  listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise<ListUsersCommandOutput>;
39
52
  listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
@@ -130,9 +130,18 @@ declare type IdentitystoreClientResolvedConfigType = __SmithyResolvedConfigurati
130
130
  export interface IdentitystoreClientResolvedConfig extends IdentitystoreClientResolvedConfigType {
131
131
  }
132
132
  /**
133
- * <p>The AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your
134
- * 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
133
+ * <p>The Identity Store service used by Amazon Web Services Single Sign On provides a single place to retrieve all of
134
+ * your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">Amazon Web Services SSO User
135
135
  * Guide</a>.</p>
136
+ *
137
+ * <note>
138
+ * <p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and
139
+ * <code>identitystore</code> API namespaces will continue to retain their original name for
140
+ * backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">Amazon Web Services SSO rename</a>.</p>
141
+ * </note>
142
+ *
143
+ * <p>This reference guide describes the identity store operations that you can call
144
+ * programatically and includes detailed information on data types and errors.</p>
136
145
  */
137
146
  export declare class IdentitystoreClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IdentitystoreClientResolvedConfig> {
138
147
  /**
@@ -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,8 @@ export interface DescribeUserCommandInput extends DescribeUserRequest {
7
7
  export interface DescribeUserCommandOutput extends DescribeUserResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Retrieves the user metadata and attributes from <code>UserId</code> in an identity store.</p>
10
+ * <p>Retrieves the user metadata and attributes from <code>UserId</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,9 +7,10 @@ export interface ListGroupsCommandInput extends ListGroupsRequest {
7
7
  export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists the attribute name and value of the group that you specified in the search. We only support <code>DisplayName</code> as a valid filter
11
- * attribute path currently, and filter is required. This API returns minimum attributes, including <code>GroupId</code> and group
12
- * <code>DisplayName</code> in the response.</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>
13
14
  * @example
14
15
  * Use a bare-bones client and the command you need to make an API call.
15
16
  * ```javascript
@@ -7,9 +7,10 @@ export interface ListUsersCommandInput extends ListUsersRequest {
7
7
  export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists the attribute name and value of the user that you specified in the search. We only support <code>UserName</code> as a valid filter attribute
11
- * path currently, and filter is required. This API returns minimum attributes, including <code>UserId</code> and <code>UserName</code> in the
12
- * response.</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>
13
14
  * @example
14
15
  * Use a bare-bones client and the command you need to make an API call.
15
16
  * ```javascript
@@ -8,7 +8,9 @@ export declare class AccessDeniedException extends __BaseException {
8
8
  readonly $fault: "client";
9
9
  Message?: string;
10
10
  /**
11
- * <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>
11
+ * <p>The identifier for each request. This value is a globally unique ID that is generated by
12
+ * the identity store service for each sent request, and is then returned inside the exception
13
+ * if the request fails.</p>
12
14
  */
13
15
  RequestId?: string;
14
16
  /**
@@ -46,14 +48,17 @@ export interface DescribeGroupResponse {
46
48
  DisplayName: string | undefined;
47
49
  }
48
50
  /**
49
- * <p>The request processing has failed because of an unknown error, exception or failure with an internal server.</p>
51
+ * <p>The request processing has failed because of an unknown error, exception or failure with
52
+ * an internal server.</p>
50
53
  */
51
54
  export declare class InternalServerException extends __BaseException {
52
55
  readonly name: "InternalServerException";
53
56
  readonly $fault: "server";
54
57
  Message?: string;
55
58
  /**
56
- * <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>
59
+ * <p>The identifier for each request. This value is a globally unique ID that is generated by
60
+ * the identity store service for each sent request, and is then returned inside the exception
61
+ * if the request fails.</p>
57
62
  */
58
63
  RequestId?: string;
59
64
  /**
@@ -73,16 +78,26 @@ export declare class ResourceNotFoundException extends __BaseException {
73
78
  readonly name: "ResourceNotFoundException";
74
79
  readonly $fault: "client";
75
80
  /**
76
- * <p>The type of resource in the Identity Store service, which is an enum object. Valid values include USER, GROUP, and IDENTITY_STORE.</p>
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>
77
83
  */
78
84
  ResourceType?: ResourceType | string;
79
85
  /**
80
- * <p>The identifier for a resource in the identity store, which 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>
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>
81
94
  */
82
95
  ResourceId?: string;
83
96
  Message?: string;
84
97
  /**
85
- * <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>
98
+ * <p>The identifier for each request. This value is a globally unique ID that is generated by
99
+ * the identity store service for each sent request, and is then returned inside the exception
100
+ * if the request fails.</p>
86
101
  */
87
102
  RequestId?: string;
88
103
  /**
@@ -91,14 +106,17 @@ export declare class ResourceNotFoundException extends __BaseException {
91
106
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
92
107
  }
93
108
  /**
94
- * <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
109
+ * <p>Indicates that the principal has crossed the throttling limits of the API
110
+ * operations.</p>
95
111
  */
96
112
  export declare class ThrottlingException extends __BaseException {
97
113
  readonly name: "ThrottlingException";
98
114
  readonly $fault: "client";
99
115
  Message?: string;
100
116
  /**
101
- * <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>
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>
102
120
  */
103
121
  RequestId?: string;
104
122
  /**
@@ -114,7 +132,9 @@ export declare class ValidationException extends __BaseException {
114
132
  readonly $fault: "client";
115
133
  Message?: string;
116
134
  /**
117
- * <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>
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>
118
138
  */
119
139
  RequestId?: string;
120
140
  /**
@@ -150,8 +170,8 @@ export interface DescribeUserResponse {
150
170
  UserId: string | undefined;
151
171
  }
152
172
  /**
153
- * <p>A query filter used by <code>ListUsers</code> and <code>ListGroup</code>. This filter object provides the attribute name and attribute value to
154
- * search users or groups.</p>
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>
155
175
  */
156
176
  export interface Filter {
157
177
  /**
@@ -162,7 +182,8 @@ export interface Filter {
162
182
  */
163
183
  AttributePath: string | undefined;
164
184
  /**
165
- * <p>Represents the data for an attribute. Each attribute value is described as a name-value pair. </p>
185
+ * <p>Represents the data for an attribute. Each attribute value is described as a name-value
186
+ * pair. </p>
166
187
  */
167
188
  AttributeValue: string | undefined;
168
189
  }
@@ -189,7 +210,8 @@ export interface ListGroupsRequest {
189
210
  */
190
211
  NextToken?: string;
191
212
  /**
192
- * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and <code>ListGroups</code> request. </p>
213
+ * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and
214
+ * <code>ListGroups</code> request. </p>
193
215
  */
194
216
  Filters?: Filter[];
195
217
  }
@@ -205,8 +227,8 @@ export interface Group {
205
227
  * <p>Contains the group’s display name value. The length limit is 1,024 characters. This
206
228
  * value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new
207
229
  * line, carriage return, space, and nonbreaking space in this attribute. The characters
208
- * <code><>;:%</code> are excluded. This value is specified at the time the group
209
- * is created and stored as an attribute of the group object in the identity store.</p>
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>
210
232
  */
211
233
  DisplayName: string | undefined;
212
234
  }
@@ -246,7 +268,8 @@ export interface ListUsersRequest {
246
268
  */
247
269
  NextToken?: string;
248
270
  /**
249
- * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and <code>ListGroups</code> request. </p>
271
+ * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and
272
+ * <code>ListGroups</code> request. </p>
250
273
  */
251
274
  Filters?: Filter[];
252
275
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
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.142.0",
4
+ "version": "3.154.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",
@@ -18,9 +18,9 @@
18
18
  "dependencies": {
19
19
  "@aws-crypto/sha256-browser": "2.0.0",
20
20
  "@aws-crypto/sha256-js": "2.0.0",
21
- "@aws-sdk/client-sts": "3.142.0",
21
+ "@aws-sdk/client-sts": "3.154.0",
22
22
  "@aws-sdk/config-resolver": "3.130.0",
23
- "@aws-sdk/credential-provider-node": "3.142.0",
23
+ "@aws-sdk/credential-provider-node": "3.154.0",
24
24
  "@aws-sdk/fetch-http-handler": "3.131.0",
25
25
  "@aws-sdk/hash-node": "3.127.0",
26
26
  "@aws-sdk/invalid-dependency": "3.127.0",
@@ -41,7 +41,7 @@
41
41
  "@aws-sdk/url-parser": "3.127.0",
42
42
  "@aws-sdk/util-base64-browser": "3.109.0",
43
43
  "@aws-sdk/util-base64-node": "3.55.0",
44
- "@aws-sdk/util-body-length-browser": "3.55.0",
44
+ "@aws-sdk/util-body-length-browser": "3.154.0",
45
45
  "@aws-sdk/util-body-length-node": "3.55.0",
46
46
  "@aws-sdk/util-defaults-mode-browser": "3.142.0",
47
47
  "@aws-sdk/util-defaults-mode-node": "3.142.0",
@@ -61,6 +61,11 @@
61
61
  "typedoc": "0.19.2",
62
62
  "typescript": "~4.6.2"
63
63
  },
64
+ "overrides": {
65
+ "typedoc": {
66
+ "typescript": "~4.6.2"
67
+ }
68
+ },
64
69
  "engines": {
65
70
  "node": ">=12.0.0"
66
71
  },