@aws-sdk/client-organizations 3.1007.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.
- package/README.md +26 -46
- package/package.json +33 -33
package/README.md
CHANGED
|
@@ -79,8 +79,9 @@ Organizations API calls with CloudTrail</a> in the
|
|
|
79
79
|
on and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">CloudTrail User Guide</a>.</p>
|
|
80
80
|
|
|
81
81
|
## Installing
|
|
82
|
-
|
|
83
|
-
|
|
82
|
+
|
|
83
|
+
To install this package, use the CLI of your favorite package manager:
|
|
84
|
+
|
|
84
85
|
- `npm install @aws-sdk/client-organizations`
|
|
85
86
|
- `yarn add @aws-sdk/client-organizations`
|
|
86
87
|
- `pnpm add @aws-sdk/client-organizations`
|
|
@@ -105,15 +106,15 @@ import { OrganizationsClient, ListRootsCommand } from "@aws-sdk/client-organizat
|
|
|
105
106
|
|
|
106
107
|
### Usage
|
|
107
108
|
|
|
108
|
-
To send a request
|
|
109
|
+
To send a request:
|
|
109
110
|
|
|
110
|
-
-
|
|
111
|
-
-
|
|
112
|
-
-
|
|
113
|
-
-
|
|
111
|
+
- Instantiate a client with configuration (e.g. credentials, region).
|
|
112
|
+
- See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
|
|
113
|
+
- See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
|
|
114
|
+
- Instantiate a command with input parameters.
|
|
115
|
+
- Call the `send` operation on the client, providing the command object as input.
|
|
114
116
|
|
|
115
117
|
```js
|
|
116
|
-
// a client can be shared by different commands.
|
|
117
118
|
const client = new OrganizationsClient({ region: "REGION" });
|
|
118
119
|
|
|
119
120
|
const params = { /** input parameters */ };
|
|
@@ -122,7 +123,7 @@ const command = new ListRootsCommand(params);
|
|
|
122
123
|
|
|
123
124
|
#### Async/await
|
|
124
125
|
|
|
125
|
-
We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
126
|
+
We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
126
127
|
operator to wait for the promise returned by send operation as follows:
|
|
127
128
|
|
|
128
129
|
```js
|
|
@@ -137,26 +138,9 @@ try {
|
|
|
137
138
|
}
|
|
138
139
|
```
|
|
139
140
|
|
|
140
|
-
Async-await is clean, concise, intuitive, easy to debug and has better error handling
|
|
141
|
-
as compared to using Promise chains or callbacks.
|
|
142
|
-
|
|
143
141
|
#### Promises
|
|
144
142
|
|
|
145
|
-
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
|
|
146
|
-
to execute send operation.
|
|
147
|
-
|
|
148
|
-
```js
|
|
149
|
-
client.send(command).then(
|
|
150
|
-
(data) => {
|
|
151
|
-
// process data.
|
|
152
|
-
},
|
|
153
|
-
(error) => {
|
|
154
|
-
// error handling.
|
|
155
|
-
}
|
|
156
|
-
);
|
|
157
|
-
```
|
|
158
|
-
|
|
159
|
-
Promises can also be called using `.catch()` and `.finally()` as follows:
|
|
143
|
+
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
|
|
160
144
|
|
|
161
145
|
```js
|
|
162
146
|
client
|
|
@@ -172,27 +156,21 @@ client
|
|
|
172
156
|
});
|
|
173
157
|
```
|
|
174
158
|
|
|
175
|
-
####
|
|
176
|
-
|
|
177
|
-
We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
|
|
178
|
-
but they are supported by the send operation.
|
|
159
|
+
#### Aggregated client
|
|
179
160
|
|
|
180
|
-
|
|
181
|
-
// callbacks.
|
|
182
|
-
client.send(command, (err, data) => {
|
|
183
|
-
// process err and data.
|
|
184
|
-
});
|
|
185
|
-
```
|
|
161
|
+
The aggregated client class is exported from the same package, but without the "Client" suffix.
|
|
186
162
|
|
|
187
|
-
|
|
163
|
+
`Organizations` extends `OrganizationsClient` and additionally supports all operations, waiters, and paginators as methods.
|
|
164
|
+
This style may be familiar to you from the AWS SDK for JavaScript v2.
|
|
188
165
|
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
166
|
+
If you are bundling the AWS SDK, we recommend using only the bare-bones client (`OrganizationsClient`).
|
|
167
|
+
More details are in the blog post on
|
|
168
|
+
[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
|
|
192
169
|
|
|
193
170
|
```ts
|
|
194
|
-
import
|
|
195
|
-
|
|
171
|
+
import { Organizations } from "@aws-sdk/client-organizations";
|
|
172
|
+
|
|
173
|
+
const client = new Organizations({ region: "REGION" });
|
|
196
174
|
|
|
197
175
|
// async/await.
|
|
198
176
|
try {
|
|
@@ -212,7 +190,7 @@ client
|
|
|
212
190
|
// error handling.
|
|
213
191
|
});
|
|
214
192
|
|
|
215
|
-
// callbacks.
|
|
193
|
+
// callbacks (not recommended).
|
|
216
194
|
client.listRoots(params, (err, data) => {
|
|
217
195
|
// process err and data.
|
|
218
196
|
});
|
|
@@ -240,12 +218,14 @@ try {
|
|
|
240
218
|
}
|
|
241
219
|
```
|
|
242
220
|
|
|
221
|
+
See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
|
|
222
|
+
|
|
243
223
|
## Getting Help
|
|
244
224
|
|
|
245
225
|
Please use these community resources for getting help.
|
|
246
|
-
We use
|
|
226
|
+
We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
|
|
247
227
|
|
|
248
|
-
- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
228
|
+
- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
249
229
|
or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
|
|
250
230
|
- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
|
|
251
231
|
on AWS Developer Blog.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-organizations",
|
|
3
3
|
"description": "AWS SDK for JavaScript Organizations Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
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-organizations",
|
|
@@ -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.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "^3.972.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "^3.972.
|
|
27
|
-
"@aws-sdk/middleware-logger": "^3.972.
|
|
28
|
-
"@aws-sdk/middleware-recursion-detection": "^3.972.
|
|
29
|
-
"@aws-sdk/middleware-user-agent": "^3.972.
|
|
30
|
-
"@aws-sdk/region-config-resolver": "^3.972.
|
|
31
|
-
"@aws-sdk/types": "^3.973.
|
|
32
|
-
"@aws-sdk/util-endpoints": "^3.996.
|
|
33
|
-
"@aws-sdk/util-user-agent-browser": "^3.972.
|
|
34
|
-
"@aws-sdk/util-user-agent-node": "^3.973.
|
|
35
|
-
"@smithy/config-resolver": "^4.4.
|
|
36
|
-
"@smithy/core": "^3.23.
|
|
37
|
-
"@smithy/fetch-http-handler": "^5.3.
|
|
38
|
-
"@smithy/hash-node": "^4.2.
|
|
39
|
-
"@smithy/invalid-dependency": "^4.2.
|
|
40
|
-
"@smithy/middleware-content-length": "^4.2.
|
|
41
|
-
"@smithy/middleware-endpoint": "^4.4.
|
|
42
|
-
"@smithy/middleware-retry": "^4.4.
|
|
43
|
-
"@smithy/middleware-serde": "^4.2.
|
|
44
|
-
"@smithy/middleware-stack": "^4.2.
|
|
45
|
-
"@smithy/node-config-provider": "^4.3.
|
|
46
|
-
"@smithy/node-http-handler": "^4.4.
|
|
47
|
-
"@smithy/protocol-http": "^5.3.
|
|
48
|
-
"@smithy/smithy-client": "^4.12.
|
|
49
|
-
"@smithy/types": "^4.13.
|
|
50
|
-
"@smithy/url-parser": "^4.2.
|
|
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.
|
|
55
|
-
"@smithy/util-defaults-mode-node": "^4.2.
|
|
56
|
-
"@smithy/util-endpoints": "^3.3.
|
|
57
|
-
"@smithy/util-middleware": "^4.2.
|
|
58
|
-
"@smithy/util-retry": "^4.2.
|
|
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
|
},
|