@aws-sdk/client-cognito-identity-provider 3.1008.0 → 3.1010.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 (2) hide show
  1. package/README.md +26 -46
  2. package/package.json +33 -33
package/README.md CHANGED
@@ -39,8 +39,9 @@ with the <code>CognitoIdentityProvider</code> client in supported Amazon Web Ser
39
39
  SDKs</a>.</p>
40
40
 
41
41
  ## Installing
42
- To install this package, simply type add or install @aws-sdk/client-cognito-identity-provider
43
- using your favorite package manager:
42
+
43
+ To install this package, use the CLI of your favorite package manager:
44
+
44
45
  - `npm install @aws-sdk/client-cognito-identity-provider`
45
46
  - `yarn add @aws-sdk/client-cognito-identity-provider`
46
47
  - `pnpm add @aws-sdk/client-cognito-identity-provider`
@@ -65,15 +66,15 @@ import { CognitoIdentityProviderClient, ListDevicesCommand } from "@aws-sdk/clie
65
66
 
66
67
  ### Usage
67
68
 
68
- To send a request, you:
69
+ To send a request:
69
70
 
70
- - Initiate client with configuration (e.g. credentials, region).
71
- - Initiate command with input parameters.
72
- - Call `send` operation on client with command object as input.
73
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
71
+ - Instantiate a client with configuration (e.g. credentials, region).
72
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
73
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
74
+ - Instantiate a command with input parameters.
75
+ - Call the `send` operation on the client, providing the command object as input.
74
76
 
75
77
  ```js
76
- // a client can be shared by different commands.
77
78
  const client = new CognitoIdentityProviderClient({ region: "REGION" });
78
79
 
79
80
  const params = { /** input parameters */ };
@@ -82,7 +83,7 @@ const command = new ListDevicesCommand(params);
82
83
 
83
84
  #### Async/await
84
85
 
85
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
86
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
86
87
  operator to wait for the promise returned by send operation as follows:
87
88
 
88
89
  ```js
@@ -97,26 +98,9 @@ try {
97
98
  }
98
99
  ```
99
100
 
100
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
101
- as compared to using Promise chains or callbacks.
102
-
103
101
  #### Promises
104
102
 
105
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
106
- to execute send operation.
107
-
108
- ```js
109
- client.send(command).then(
110
- (data) => {
111
- // process data.
112
- },
113
- (error) => {
114
- // error handling.
115
- }
116
- );
117
- ```
118
-
119
- Promises can also be called using `.catch()` and `.finally()` as follows:
103
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
120
104
 
121
105
  ```js
122
106
  client
@@ -132,27 +116,21 @@ client
132
116
  });
133
117
  ```
134
118
 
135
- #### Callbacks
136
-
137
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
138
- but they are supported by the send operation.
119
+ #### Aggregated client
139
120
 
140
- ```js
141
- // callbacks.
142
- client.send(command, (err, data) => {
143
- // process err and data.
144
- });
145
- ```
121
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
146
122
 
147
- #### v2 compatible style
123
+ `CognitoIdentityProvider` extends `CognitoIdentityProviderClient` and additionally supports all operations, waiters, and paginators as methods.
124
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
148
125
 
149
- The client can also send requests using v2 compatible style.
150
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
151
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
126
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`CognitoIdentityProviderClient`).
127
+ More details are in the blog post on
128
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
152
129
 
153
130
  ```ts
154
- import * as AWS from "@aws-sdk/client-cognito-identity-provider";
155
- const client = new AWS.CognitoIdentityProvider({ region: "REGION" });
131
+ import { CognitoIdentityProvider } from "@aws-sdk/client-cognito-identity-provider";
132
+
133
+ const client = new CognitoIdentityProvider({ region: "REGION" });
156
134
 
157
135
  // async/await.
158
136
  try {
@@ -172,7 +150,7 @@ client
172
150
  // error handling.
173
151
  });
174
152
 
175
- // callbacks.
153
+ // callbacks (not recommended).
176
154
  client.listDevices(params, (err, data) => {
177
155
  // process err and data.
178
156
  });
@@ -200,12 +178,14 @@ try {
200
178
  }
201
179
  ```
202
180
 
181
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
182
+
203
183
  ## Getting Help
204
184
 
205
185
  Please use these community resources for getting help.
206
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
186
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
207
187
 
208
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
188
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
209
189
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
210
190
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
211
191
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cognito-identity-provider",
3
3
  "description": "AWS SDK for JavaScript Cognito Identity Provider Client for Node.js, Browser and React Native",
4
- "version": "3.1008.0",
4
+ "version": "3.1010.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-cognito-identity-provider",
@@ -21,41 +21,41 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "5.2.0",
23
23
  "@aws-crypto/sha256-js": "5.2.0",
24
- "@aws-sdk/core": "^3.973.19",
25
- "@aws-sdk/credential-provider-node": "^3.972.20",
26
- "@aws-sdk/middleware-host-header": "^3.972.7",
27
- "@aws-sdk/middleware-logger": "^3.972.7",
28
- "@aws-sdk/middleware-recursion-detection": "^3.972.7",
29
- "@aws-sdk/middleware-user-agent": "^3.972.20",
30
- "@aws-sdk/region-config-resolver": "^3.972.7",
31
- "@aws-sdk/types": "^3.973.5",
32
- "@aws-sdk/util-endpoints": "^3.996.4",
33
- "@aws-sdk/util-user-agent-browser": "^3.972.7",
34
- "@aws-sdk/util-user-agent-node": "^3.973.6",
35
- "@smithy/config-resolver": "^4.4.10",
36
- "@smithy/core": "^3.23.9",
37
- "@smithy/fetch-http-handler": "^5.3.13",
38
- "@smithy/hash-node": "^4.2.11",
39
- "@smithy/invalid-dependency": "^4.2.11",
40
- "@smithy/middleware-content-length": "^4.2.11",
41
- "@smithy/middleware-endpoint": "^4.4.23",
42
- "@smithy/middleware-retry": "^4.4.40",
43
- "@smithy/middleware-serde": "^4.2.12",
44
- "@smithy/middleware-stack": "^4.2.11",
45
- "@smithy/node-config-provider": "^4.3.11",
46
- "@smithy/node-http-handler": "^4.4.14",
47
- "@smithy/protocol-http": "^5.3.11",
48
- "@smithy/smithy-client": "^4.12.3",
49
- "@smithy/types": "^4.13.0",
50
- "@smithy/url-parser": "^4.2.11",
24
+ "@aws-sdk/core": "^3.973.20",
25
+ "@aws-sdk/credential-provider-node": "^3.972.21",
26
+ "@aws-sdk/middleware-host-header": "^3.972.8",
27
+ "@aws-sdk/middleware-logger": "^3.972.8",
28
+ "@aws-sdk/middleware-recursion-detection": "^3.972.8",
29
+ "@aws-sdk/middleware-user-agent": "^3.972.21",
30
+ "@aws-sdk/region-config-resolver": "^3.972.8",
31
+ "@aws-sdk/types": "^3.973.6",
32
+ "@aws-sdk/util-endpoints": "^3.996.5",
33
+ "@aws-sdk/util-user-agent-browser": "^3.972.8",
34
+ "@aws-sdk/util-user-agent-node": "^3.973.7",
35
+ "@smithy/config-resolver": "^4.4.11",
36
+ "@smithy/core": "^3.23.11",
37
+ "@smithy/fetch-http-handler": "^5.3.15",
38
+ "@smithy/hash-node": "^4.2.12",
39
+ "@smithy/invalid-dependency": "^4.2.12",
40
+ "@smithy/middleware-content-length": "^4.2.12",
41
+ "@smithy/middleware-endpoint": "^4.4.25",
42
+ "@smithy/middleware-retry": "^4.4.42",
43
+ "@smithy/middleware-serde": "^4.2.14",
44
+ "@smithy/middleware-stack": "^4.2.12",
45
+ "@smithy/node-config-provider": "^4.3.12",
46
+ "@smithy/node-http-handler": "^4.4.16",
47
+ "@smithy/protocol-http": "^5.3.12",
48
+ "@smithy/smithy-client": "^4.12.5",
49
+ "@smithy/types": "^4.13.1",
50
+ "@smithy/url-parser": "^4.2.12",
51
51
  "@smithy/util-base64": "^4.3.2",
52
52
  "@smithy/util-body-length-browser": "^4.2.2",
53
53
  "@smithy/util-body-length-node": "^4.2.3",
54
- "@smithy/util-defaults-mode-browser": "^4.3.39",
55
- "@smithy/util-defaults-mode-node": "^4.2.42",
56
- "@smithy/util-endpoints": "^3.3.2",
57
- "@smithy/util-middleware": "^4.2.11",
58
- "@smithy/util-retry": "^4.2.11",
54
+ "@smithy/util-defaults-mode-browser": "^4.3.41",
55
+ "@smithy/util-defaults-mode-node": "^4.2.44",
56
+ "@smithy/util-endpoints": "^3.3.3",
57
+ "@smithy/util-middleware": "^4.2.12",
58
+ "@smithy/util-retry": "^4.2.12",
59
59
  "@smithy/util-utf8": "^4.2.2",
60
60
  "tslib": "^2.6.2"
61
61
  },