Organizations is a web service that enables you to consolidate your multiple\nAmazon Web Services accounts into an organization and centrally manage your\naccounts and their resources.
\nThis guide provides descriptions of the Organizations API. For more\ninformation about using this service, see the Organizations User Guide.
\n\nAPI version\n
\nThis version of the Organizations API Reference documents the Organizations API version\n2016-11-28.
\nAs an alternative to using the API directly, you can use one of the Amazon Web Services SDKs,\nwhich consist of libraries and sample code for various programming languages and\nplatforms (Java, Ruby, .NET, iOS, Android, and more). The SDKs provide a convenient\nway to create programmatic access to Organizations. For example, the SDKs take care of\ncryptographically signing requests, managing errors, and retrying requests\nautomatically. For more information about the Amazon Web Services SDKs, including how to download\nand install them, see Tools for Amazon Web\nServices.
\nWe recommend that you use the Amazon Web Services SDKs to make programmatic API calls to Organizations.\nHowever, you also can use the Organizations Query API to make direct calls to the Organizations web\nservice. To learn more about the Organizations Query API, see Calling the API by making HTTP Query\nrequests in the Organizations User Guide. Organizations supports GET and\nPOST requests for all actions. That is, the API doesn't require you to use GET for some\nactions and POST for others. However, GET requests are subject to the limitation size of\na URL. Therefore, for operations that require larger sizes, use a POST request.
\n\nSigning requests\n
\nWhen you send HTTP requests to Amazon Web Services, sign the requests so that Amazon Web Services can identify\nwho sent them. You sign requests with your Amazon Web Services access key, which consists of an access\nkey ID and a secret access key. We strongly recommend that you don't create an access\nkey for your root account. Anyone who has the access key for your root account has\nunrestricted access to all the resources in your account. Instead, create an access key\nfor an IAM user that has administrative permissions. As another option, use Amazon Web Services\nSecurity Token Service (Amazon Web Services STS) to generate temporary security credentials, and use\nthose credentials to sign requests.
\nTo sign requests, we recommend that you use Signature Version 4. If you\nhave an existing application that uses Signature Version 2, you don't have to update it\nto use Signature Version 4. However, some operations now require Signature Version 4.\nThe documentation for operations that require version 4 indicate this\nrequirement.
\nWhen you use the Command Line Interface (CLI) or one of the Amazon Web Services SDKs to make requests to\nAmazon Web Services, these tools automatically sign the requests for you with the access key that you\nspecify when you configure the tools.
\nIn this release, each organization can have only one root.
\n\nSupport and feedback for Organizations\n
\nWe welcome your feedback. You can post your feedback and questions in the Organizations support\nforum. For more information about the Amazon Web Services Support forums, see Forums Help.
\n\nEndpoint to call When using the CLI or the Amazon Web Services\nSDK\n
\nFor the current release of Organizations, specify the us-east-1 region\nfor all Amazon Web Services API and CLI calls made from the commercial Amazon Web Services Regions outside of\nChina. If calling from one of the Amazon Web Services Regions in China, then specify\ncn-northwest-1. You can do this in the CLI by using these parameters\nand commands:
Use the following parameter with each command to specify both the endpoint and\nits region:
\n\n--endpoint-url https://organizations.us-east-1.amazonaws.com\n(from commercial Amazon Web Services Regions outside of China)\n
or
\n\n--endpoint-url\nhttps://organizations.cn-northwest-1.amazonaws.com.cn\n(from Amazon Web Services Regions in China)\n
Use the default endpoint, but configure your default region with this\ncommand:
\n\naws configure set default.region us-east-1\n(from commercial Amazon Web Services Regions outside of China)\n
or
\n\naws configure set default.region cn-northwest-1\n(from Amazon Web Services Regions in China)\n
Use the following parameter with each command to specify the endpoint:
\n\n--region us-east-1\n(from commercial Amazon Web Services Regions outside of China)\n
or
\n\n--region cn-northwest-1\n(from Amazon Web Services Regions in China)\n
\nHow examples are presented\n
\nThe JSON returned by the Organizations service as response to your requests arrives as a\nsingle long string without line breaks or formatting whitespace. The examples in this\nguide include both line breaks and whitespace to improve readability. When example input\nparameters also would result in long strings that would extend beyond the screen, we\ninsert line breaks to enhance readability. Always submit the input as a single JSON text\nstring.
\n\nRecording API Requests\n
\nOrganizations supports CloudTrail, a service that records Amazon Web Services API calls for your\nAmazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected\nby CloudTrail, you can determine which requests the Organizations service received, who made the\nrequest and when, and so on. For more about Organizations and its support for CloudTrail, see\nLogging\nOrganizations API calls with CloudTrail in the\nOrganizations User Guide. To learn more about CloudTrail, including how to turn it\non and find your log files, see the CloudTrail User Guide.
\n\n## Installing\n\nTo install this package, use the CLI of your favorite package manager:\n\n- `npm install @aws-sdk/client-organizations`\n- `yarn add @aws-sdk/client-organizations`\n- `pnpm add @aws-sdk/client-organizations`\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands.\nTo send a request, you only need to import the `OrganizationsClient` and\nthe commands you need, for example `ListRootsCommand`:\n\n```js\n// ES5 example\nconst { OrganizationsClient, ListRootsCommand } = require(\"@aws-sdk/client-organizations\");\n```\n\n```ts\n// ES6+ example\nimport { OrganizationsClient, ListRootsCommand } from \"@aws-sdk/client-organizations\";\n```\n\n### Usage\n\nTo send a request:\n\n- Instantiate a client with configuration (e.g. credentials, region).\n - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.\n - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.\n- Instantiate a command with input parameters.\n- Call the `send` operation on the client, providing the command object as input.\n\n```js\nconst client = new OrganizationsClient({ region: \"REGION\" });\n\nconst params = { /** input parameters */ };\nconst command = new ListRootsCommand(params);\n```\n\n#### Async/await\n\nWe recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)\noperator to wait for the promise returned by send operation as follows:\n\n```js\n// async/await.\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n // error handling.\n} finally {\n // finally.\n}\n```\n\n#### Promises\n\nYou can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).\n\n```js\nclient\n .send(command)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n })\n .finally(() => {\n // finally.\n });\n```\n\n#### Aggregated client\n\nThe aggregated client class is exported from the same package, but without the \"Client\" suffix.\n\n`Organizations` extends `OrganizationsClient` and additionally supports all operations, waiters, and paginators as methods.\nThis style may be familiar to you from the AWS SDK for JavaScript v2.\n\nIf you are bundling the AWS SDK, we recommend using only the bare-bones client (`OrganizationsClient`).\nMore details are in the blog post on\n[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).\n\n```ts\nimport { Organizations } from \"@aws-sdk/client-organizations\";\n\nconst client = new Organizations({ region: \"REGION\" });\n\n// async/await.\ntry {\n const data = await client.listRoots(params);\n // process data.\n} catch (error) {\n // error handling.\n}\n\n// Promises.\nclient\n .listRoots(params)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n });\n\n// callbacks (not recommended).\nclient.listRoots(params, (err, data) => {\n // process err and data.\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information,\nas well as response metadata (e.g. request id).\n\n```js\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n const { requestId, cfId, extendedRequestId } = error.$metadata;\n console.log({ requestId, cfId, extendedRequestId });\n /**\n * The keys within exceptions are also parsed.\n * You can access them by specifying exception names:\n * if (error.name === 'SomeServiceException') {\n * const value = error.specialKeyInException;\n * }\n */\n}\n```\n\nSee also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).\n\n## Getting Help\n\nPlease use these community resources for getting help.\nWe use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.\n\n- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)\n or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).\n- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)\n on AWS Developer Blog.\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.\n- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).\n\nTo test your universal JavaScript code in Node.js, browser and react-native environments,\nvisit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-organizations` package is updated.\nTo contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n## Client Commands (Operations List)\n\n