@aws-sdk/client-organizations

Description

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 <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">Organizations User Guide</a>. Support and feedback for Organizations We welcome your feedback. You can post your feedback and questions in the <a href="https://forums.aws.amazon.com/forum.jspa?forumID=219">Organizations support forum</a>. For more information about the Amazon Web Services Support forums, see <a href="https://forums.aws.amazon.com/help.jspa">Forums Help</a>. Endpoint to call When using the CLI or the Amazon Web Services SDK For the current release of Organizations, specify the <code>us-east-1</code> 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 <code>cn-northwest-1</code>. You can do this in the CLI by using these parameters and commands: <ul> <li> Use the following parameter with each command to specify both the endpoint and its region: <code>--endpoint-url https://organizations.us-east-1.amazonaws.com</code> (from commercial Amazon Web Services Regions outside of China) or <code>--endpoint-url https://organizations.cn-northwest-1.amazonaws.com.cn</code> (from Amazon Web Services Regions in China) </li> <li> Use the default endpoint, but configure your default region with this command: <code>aws configure set default.region us-east-1</code> (from commercial Amazon Web Services Regions outside of China) or <code>aws configure set default.region cn-northwest-1</code> (from Amazon Web Services Regions in China) </li> <li> Use the following parameter with each command to specify the endpoint: <code>--region us-east-1</code> (from commercial Amazon Web Services Regions outside of China) or <code>--region cn-northwest-1</code> (from Amazon Web Services Regions in China) </li> </ul> 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 <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_incident-response.html#orgs_cloudtrail-integration">Logging Organizations API calls with CloudTrail</a> in the Organizations User Guide. To learn more about CloudTrail, including how to turn it 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>.

Installing

To install this package, use the CLI of your favorite package manager:

npm install @aws-sdk/client-organizations
yarn add @aws-sdk/client-organizations
pnpm add @aws-sdk/client-organizations

Getting Started

Import

The 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";

Usage

To send a request:

Instantiate a client with configuration (e.g. credentials, region).
- See docs/CLIENTS for configuration details.
- See @aws-sdk/config for additional options.
Instantiate a command with input parameters.
Call the send operation on the client, providing the command object as input.

const client = new OrganizationsClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListRootsCommand(params);

Async/await

We recommend using the 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.
}

Promises

You can also use Promise chaining.

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

Organizations extends OrganizationsClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (OrganizationsClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { Organizations } from "@aws-sdk/client-organizations";

const client = new 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 (not recommended).
client.listRoots(params, (err, data) => {
  // process err and data.
});

Troubleshooting

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;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

Visit the Developer Guide or API Reference.
Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
Ask a question on StackOverflow and tag it with aws-sdk-js.
Join the AWS JavaScript community on gitter.
If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

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.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

<details> <summary> AcceptHandshake </summary>