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