@aws-sdk/client-organizations
Advanced tools
AWS SDK for JavaScript Organizations Client for Node.js, Browser and React Native
AWS SDK for JavaScript Organizations Client for Node.js, Browser and React Native.
Organizations is a web service that enables you to consolidate your multiple Amazon Web Services accounts into an organization and centrally manage your accounts and their resources.
This guide provides descriptions of the Organizations operations. For more information about using this service, see the Organizations User Guide.
Support and feedback for Organizations
We welcome your feedback. Send your comments to feedback-awsorganizations@amazon.com or post your feedback and questions in the Organizations support forum. For more information about the Amazon Web Services support forums, see Forums Help.
Endpoint to call When using the CLI or the Amazon Web Services SDK
For the current release of Organizations, specify the us-east-1 region
for all Amazon Web Services API and CLI calls made from the commercial Amazon Web Services Regions outside of
China. If calling from one of the Amazon Web Services Regions in China, then specify
cn-northwest-1. You can do this in the CLI by using these parameters
and commands:
Use the following parameter with each command to specify both the endpoint and its region:
--endpoint-url https://organizations.us-east-1.amazonaws.com
(from commercial Amazon Web Services Regions outside of China)
or
--endpoint-url
https://organizations.cn-northwest-1.amazonaws.com.cn
(from Amazon Web Services Regions in China)
Use the default endpoint, but configure your default region with this command:
aws configure set default.region us-east-1
(from commercial Amazon Web Services Regions outside of China)
or
aws configure set default.region cn-northwest-1
(from Amazon Web Services Regions in China)
Use the following parameter with each command to specify the endpoint:
--region us-east-1
(from commercial Amazon Web Services Regions outside of China)
or
--region cn-northwest-1
(from Amazon Web Services Regions in China)
Recording API Requests
Organizations supports CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Organizations service received, who made the request and when, and so on. For more about Organizations and its support for CloudTrail, see Logging Organizations API calls with CloudTrail in the Organizations User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the CloudTrail User Guide.
To install this package, simply type add or install @aws-sdk/client-organizations using your favorite package manager:
npm install @aws-sdk/client-organizationsyarn add @aws-sdk/client-organizationspnpm add @aws-sdk/client-organizationsThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the OrganizationsClient and
the commands you need, for example ListRootsCommand:
// ES5 example
const { OrganizationsClient, ListRootsCommand } = require("@aws-sdk/client-organizations");
// ES6+ example
import { OrganizationsClient, ListRootsCommand } from "@aws-sdk/client-organizations";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new OrganizationsClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListRootsCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-organizations";
const client = new AWS.Organizations({ region: "REGION" });
// async/await.
try {
const data = await client.listRoots(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listRoots(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listRoots(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-organizations package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
FAQs
AWS SDK for JavaScript Organizations Client for Node.js, Browser and React Native
We found that @aws-sdk/client-organizations demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.