@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 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.
Installing
To install the this package, simply type add or install @aws-sdk/client-organizations
using 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
:
const { OrganizationsClient, ListRootsCommand } = require("@aws-sdk/client-organizations");
import { OrganizationsClient, ListRootsCommand } from "@aws-sdk/client-organizations";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const client = new OrganizationsClient({ region: "REGION" });
const params = {
};
const command = new ListRootsCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining
to execute send operation.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, data) => {
});
v2 compatible style
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" });
try {
const data = await client.listRoots(params);
} catch (error) {
}
client
.listRoots(params)
.then((data) => {
})
.catch((error) => {
});
client.listRoots(params, (err, 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);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
Getting Help
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.
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)
AcceptHandshake
Command API Reference / Input / Output
AttachPolicy
Command API Reference / Input / Output
CancelHandshake
Command API Reference / Input / Output
CloseAccount
Command API Reference / Input / Output
CreateAccount
Command API Reference / Input / Output
CreateGovCloudAccount
Command API Reference / Input / Output
CreateOrganization
Command API Reference / Input / Output
CreateOrganizationalUnit
Command API Reference / Input / Output
CreatePolicy
Command API Reference / Input / Output
DeclineHandshake
Command API Reference / Input / Output
DeleteOrganization
Command API Reference / Input / Output
DeleteOrganizationalUnit
Command API Reference / Input / Output
DeletePolicy
Command API Reference / Input / Output
DeleteResourcePolicy
Command API Reference / Input / Output
DeregisterDelegatedAdministrator
Command API Reference / Input / Output
DescribeAccount
Command API Reference / Input / Output
DescribeCreateAccountStatus
Command API Reference / Input / Output
DescribeEffectivePolicy
Command API Reference / Input / Output
DescribeHandshake
Command API Reference / Input / Output
DescribeOrganization
Command API Reference / Input / Output
DescribeOrganizationalUnit
Command API Reference / Input / Output
DescribePolicy
Command API Reference / Input / Output
DescribeResourcePolicy
Command API Reference / Input / Output
DetachPolicy
Command API Reference / Input / Output
DisableAWSServiceAccess
Command API Reference / Input / Output
DisablePolicyType
Command API Reference / Input / Output
EnableAllFeatures
Command API Reference / Input / Output
EnableAWSServiceAccess
Command API Reference / Input / Output
EnablePolicyType
Command API Reference / Input / Output
InviteAccountToOrganization
Command API Reference / Input / Output
LeaveOrganization
Command API Reference / Input / Output
ListAccounts
Command API Reference / Input / Output
ListAccountsForParent
Command API Reference / Input / Output
ListAWSServiceAccessForOrganization
Command API Reference / Input / Output
ListChildren
Command API Reference / Input / Output
ListCreateAccountStatus
Command API Reference / Input / Output
ListDelegatedAdministrators
Command API Reference / Input / Output
ListDelegatedServicesForAccount
Command API Reference / Input / Output
ListHandshakesForAccount
Command API Reference / Input / Output
ListHandshakesForOrganization
Command API Reference / Input / Output
ListOrganizationalUnitsForParent
Command API Reference / Input / Output
ListParents
Command API Reference / Input / Output
ListPolicies
Command API Reference / Input / Output
ListPoliciesForTarget
Command API Reference / Input / Output
ListRoots
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
ListTargetsForPolicy
Command API Reference / Input / Output
MoveAccount
Command API Reference / Input / Output
PutResourcePolicy
Command API Reference / Input / Output
RegisterDelegatedAdministrator
Command API Reference / Input / Output
RemoveAccountFromOrganization
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateOrganizationalUnit
Command API Reference / Input / Output
UpdatePolicy
Command API Reference / Input / Output