Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

@aws-sdk/client-organizations

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.

Index

Enumerations

Classes

AWSOrganizationsNotInUseException AcceptHandshakeCommand AccessDeniedException AccessDeniedForDependencyException AccountAlreadyClosedException AccountAlreadyRegisteredException AccountNotFoundException AccountNotRegisteredException AccountOwnerNotVerifiedException AlreadyInOrganizationException AttachPolicyCommand CancelHandshakeCommand ChildNotFoundException CloseAccountCommand ConcurrentModificationException ConflictException ConstraintViolationException CreateAccountCommand CreateAccountStatusNotFoundException CreateGovCloudAccountCommand CreateOrganizationCommand CreateOrganizationalUnitCommand CreatePolicyCommand DeclineHandshakeCommand DeleteOrganizationCommand DeleteOrganizationalUnitCommand DeletePolicyCommand DeleteResourcePolicyCommand DeregisterDelegatedAdministratorCommand DescribeAccountCommand DescribeCreateAccountStatusCommand DescribeEffectivePolicyCommand DescribeHandshakeCommand DescribeOrganizationCommand DescribeOrganizationalUnitCommand DescribePolicyCommand DescribeResourcePolicyCommand DestinationParentNotFoundException DetachPolicyCommand DisableAWSServiceAccessCommand DisablePolicyTypeCommand DuplicateAccountException DuplicateHandshakeException DuplicateOrganizationalUnitException DuplicatePolicyAttachmentException DuplicatePolicyException EffectivePolicyNotFoundException EnableAWSServiceAccessCommand EnableAllFeaturesCommand EnablePolicyTypeCommand FinalizingOrganizationException HandshakeAlreadyInStateException HandshakeConstraintViolationException HandshakeNotFoundException InvalidHandshakeTransitionException InvalidInputException InviteAccountToOrganizationCommand LeaveOrganizationCommand ListAWSServiceAccessForOrganizationCommand ListAccountsCommand ListAccountsForParentCommand ListChildrenCommand ListCreateAccountStatusCommand ListDelegatedAdministratorsCommand ListDelegatedServicesForAccountCommand ListHandshakesForAccountCommand ListHandshakesForOrganizationCommand ListOrganizationalUnitsForParentCommand ListParentsCommand ListPoliciesCommand ListPoliciesForTargetCommand ListRootsCommand ListTagsForResourceCommand ListTargetsForPolicyCommand MalformedPolicyDocumentException MasterCannotLeaveOrganizationException MoveAccountCommand OrganizationNotEmptyException OrganizationalUnitNotEmptyException OrganizationalUnitNotFoundException Organizations OrganizationsClient OrganizationsServiceException ParentNotFoundException PolicyChangesInProgressException PolicyInUseException PolicyNotAttachedException PolicyNotFoundException PolicyTypeAlreadyEnabledException PolicyTypeNotAvailableForOrganizationException PolicyTypeNotEnabledException PutResourcePolicyCommand RegisterDelegatedAdministratorCommand RemoveAccountFromOrganizationCommand ResourcePolicyNotFoundException RootNotFoundException ServiceException SourceParentNotFoundException TagResourceCommand TargetNotFoundException TooManyRequestsException UnsupportedAPIEndpointException UntagResourceCommand UpdateOrganizationalUnitCommand UpdatePolicyCommand

Interfaces

AcceptHandshakeCommandInput AcceptHandshakeCommandOutput AcceptHandshakeRequest AcceptHandshakeResponse Account AttachPolicyCommandInput AttachPolicyCommandOutput AttachPolicyRequest CancelHandshakeCommandInput CancelHandshakeCommandOutput CancelHandshakeRequest CancelHandshakeResponse Child ClientDefaults ClientInputEndpointParameters CloseAccountCommandInput CloseAccountCommandOutput CloseAccountRequest CreateAccountCommandInput CreateAccountCommandOutput CreateAccountRequest CreateAccountResponse CreateAccountStatus CreateGovCloudAccountCommandInput CreateGovCloudAccountCommandOutput CreateGovCloudAccountRequest CreateGovCloudAccountResponse CreateOrganizationCommandInput CreateOrganizationCommandOutput CreateOrganizationRequest CreateOrganizationResponse CreateOrganizationalUnitCommandInput CreateOrganizationalUnitCommandOutput CreateOrganizationalUnitRequest CreateOrganizationalUnitResponse CreatePolicyCommandInput CreatePolicyCommandOutput CreatePolicyRequest CreatePolicyResponse DeclineHandshakeCommandInput DeclineHandshakeCommandOutput DeclineHandshakeRequest DeclineHandshakeResponse DelegatedAdministrator DelegatedService DeleteOrganizationCommandInput DeleteOrganizationCommandOutput DeleteOrganizationalUnitCommandInput DeleteOrganizationalUnitCommandOutput DeleteOrganizationalUnitRequest DeletePolicyCommandInput DeletePolicyCommandOutput DeletePolicyRequest DeleteResourcePolicyCommandInput DeleteResourcePolicyCommandOutput DeregisterDelegatedAdministratorCommandInput DeregisterDelegatedAdministratorCommandOutput DeregisterDelegatedAdministratorRequest DescribeAccountCommandInput DescribeAccountCommandOutput DescribeAccountRequest DescribeAccountResponse DescribeCreateAccountStatusCommandInput DescribeCreateAccountStatusCommandOutput DescribeCreateAccountStatusRequest DescribeCreateAccountStatusResponse DescribeEffectivePolicyCommandInput DescribeEffectivePolicyCommandOutput DescribeEffectivePolicyRequest DescribeEffectivePolicyResponse DescribeHandshakeCommandInput DescribeHandshakeCommandOutput DescribeHandshakeRequest DescribeHandshakeResponse DescribeOrganizationCommandInput DescribeOrganizationCommandOutput DescribeOrganizationResponse DescribeOrganizationalUnitCommandInput DescribeOrganizationalUnitCommandOutput DescribeOrganizationalUnitRequest DescribeOrganizationalUnitResponse DescribePolicyCommandInput DescribePolicyCommandOutput DescribePolicyRequest DescribePolicyResponse DescribeResourcePolicyCommandInput DescribeResourcePolicyCommandOutput DescribeResourcePolicyResponse DetachPolicyCommandInput DetachPolicyCommandOutput DetachPolicyRequest DisableAWSServiceAccessCommandInput DisableAWSServiceAccessCommandOutput DisableAWSServiceAccessRequest DisablePolicyTypeCommandInput DisablePolicyTypeCommandOutput DisablePolicyTypeRequest DisablePolicyTypeResponse EffectivePolicy EnableAWSServiceAccessCommandInput EnableAWSServiceAccessCommandOutput EnableAWSServiceAccessRequest EnableAllFeaturesCommandInput EnableAllFeaturesCommandOutput EnableAllFeaturesRequest EnableAllFeaturesResponse EnablePolicyTypeCommandInput EnablePolicyTypeCommandOutput EnablePolicyTypeRequest EnablePolicyTypeResponse EnabledServicePrincipal Handshake HandshakeFilter HandshakeParty HandshakeResource InviteAccountToOrganizationCommandInput InviteAccountToOrganizationCommandOutput InviteAccountToOrganizationRequest InviteAccountToOrganizationResponse LeaveOrganizationCommandInput LeaveOrganizationCommandOutput ListAWSServiceAccessForOrganizationCommandInput ListAWSServiceAccessForOrganizationCommandOutput ListAWSServiceAccessForOrganizationRequest ListAWSServiceAccessForOrganizationResponse ListAccountsCommandInput ListAccountsCommandOutput ListAccountsForParentCommandInput ListAccountsForParentCommandOutput ListAccountsForParentRequest ListAccountsForParentResponse ListAccountsRequest ListAccountsResponse ListChildrenCommandInput ListChildrenCommandOutput ListChildrenRequest ListChildrenResponse ListCreateAccountStatusCommandInput ListCreateAccountStatusCommandOutput ListCreateAccountStatusRequest ListCreateAccountStatusResponse ListDelegatedAdministratorsCommandInput ListDelegatedAdministratorsCommandOutput ListDelegatedAdministratorsRequest ListDelegatedAdministratorsResponse ListDelegatedServicesForAccountCommandInput ListDelegatedServicesForAccountCommandOutput ListDelegatedServicesForAccountRequest ListDelegatedServicesForAccountResponse ListHandshakesForAccountCommandInput ListHandshakesForAccountCommandOutput ListHandshakesForAccountRequest ListHandshakesForAccountResponse ListHandshakesForOrganizationCommandInput ListHandshakesForOrganizationCommandOutput ListHandshakesForOrganizationRequest ListHandshakesForOrganizationResponse ListOrganizationalUnitsForParentCommandInput ListOrganizationalUnitsForParentCommandOutput ListOrganizationalUnitsForParentRequest ListOrganizationalUnitsForParentResponse ListParentsCommandInput ListParentsCommandOutput ListParentsRequest ListParentsResponse ListPoliciesCommandInput ListPoliciesCommandOutput ListPoliciesForTargetCommandInput ListPoliciesForTargetCommandOutput ListPoliciesForTargetRequest ListPoliciesForTargetResponse ListPoliciesRequest ListPoliciesResponse ListRootsCommandInput ListRootsCommandOutput ListRootsRequest ListRootsResponse ListTagsForResourceCommandInput ListTagsForResourceCommandOutput ListTagsForResourceRequest ListTagsForResourceResponse ListTargetsForPolicyCommandInput ListTargetsForPolicyCommandOutput ListTargetsForPolicyRequest ListTargetsForPolicyResponse MoveAccountCommandInput MoveAccountCommandOutput MoveAccountRequest Organization OrganizationalUnit OrganizationsClientConfig OrganizationsClientResolvedConfig OrganizationsPaginationConfiguration Parent Policy PolicySummary PolicyTargetSummary PolicyTypeSummary PutResourcePolicyCommandInput PutResourcePolicyCommandOutput PutResourcePolicyRequest PutResourcePolicyResponse RegisterDelegatedAdministratorCommandInput RegisterDelegatedAdministratorCommandOutput RegisterDelegatedAdministratorRequest RemoveAccountFromOrganizationCommandInput RemoveAccountFromOrganizationCommandOutput RemoveAccountFromOrganizationRequest ResourcePolicy ResourcePolicySummary Root RuntimeExtension Tag TagResourceCommandInput TagResourceCommandOutput TagResourceRequest UntagResourceCommandInput UntagResourceCommandOutput UntagResourceRequest UpdateOrganizationalUnitCommandInput UpdateOrganizationalUnitCommandOutput UpdateOrganizationalUnitRequest UpdateOrganizationalUnitResponse UpdatePolicyCommandInput UpdatePolicyCommandOutput UpdatePolicyRequest UpdatePolicyResponse

Type Aliases

Functions

SDK - Clients

SDK - Commands

AcceptHandshakeCommand AcceptHandshakeCommandInput AcceptHandshakeCommandOutput AttachPolicyCommand AttachPolicyCommandInput AttachPolicyCommandOutput CancelHandshakeCommand CancelHandshakeCommandInput CancelHandshakeCommandOutput CloseAccountCommand CloseAccountCommandInput CloseAccountCommandOutput CreateAccountCommand CreateAccountCommandInput CreateAccountCommandOutput CreateGovCloudAccountCommand CreateGovCloudAccountCommandInput CreateGovCloudAccountCommandOutput CreateOrganizationalUnitCommand CreateOrganizationalUnitCommandInput CreateOrganizationalUnitCommandOutput CreateOrganizationCommand CreateOrganizationCommandInput CreateOrganizationCommandOutput CreatePolicyCommand CreatePolicyCommandInput CreatePolicyCommandOutput DeclineHandshakeCommand DeclineHandshakeCommandInput DeclineHandshakeCommandOutput DeleteOrganizationalUnitCommand DeleteOrganizationalUnitCommandInput DeleteOrganizationalUnitCommandOutput DeleteOrganizationCommand DeleteOrganizationCommandInput DeleteOrganizationCommandOutput DeletePolicyCommand DeletePolicyCommandInput DeletePolicyCommandOutput DeleteResourcePolicyCommand DeleteResourcePolicyCommandInput DeleteResourcePolicyCommandOutput DeregisterDelegatedAdministratorCommand DeregisterDelegatedAdministratorCommandInput DeregisterDelegatedAdministratorCommandOutput DescribeAccountCommand DescribeAccountCommandInput DescribeAccountCommandOutput DescribeCreateAccountStatusCommand DescribeCreateAccountStatusCommandInput DescribeCreateAccountStatusCommandOutput DescribeEffectivePolicyCommand DescribeEffectivePolicyCommandInput DescribeEffectivePolicyCommandOutput DescribeHandshakeCommand DescribeHandshakeCommandInput DescribeHandshakeCommandOutput DescribeOrganizationalUnitCommand DescribeOrganizationalUnitCommandInput DescribeOrganizationalUnitCommandOutput DescribeOrganizationCommand DescribeOrganizationCommandInput DescribeOrganizationCommandOutput DescribePolicyCommand DescribePolicyCommandInput DescribePolicyCommandOutput DescribeResourcePolicyCommand DescribeResourcePolicyCommandInput DescribeResourcePolicyCommandOutput DetachPolicyCommand DetachPolicyCommandInput DetachPolicyCommandOutput DisableAWSServiceAccessCommand DisableAWSServiceAccessCommandInput DisableAWSServiceAccessCommandOutput DisablePolicyTypeCommand DisablePolicyTypeCommandInput DisablePolicyTypeCommandOutput EnableAllFeaturesCommand EnableAllFeaturesCommandInput EnableAllFeaturesCommandOutput EnableAWSServiceAccessCommand EnableAWSServiceAccessCommandInput EnableAWSServiceAccessCommandOutput EnablePolicyTypeCommand EnablePolicyTypeCommandInput EnablePolicyTypeCommandOutput InviteAccountToOrganizationCommand InviteAccountToOrganizationCommandInput InviteAccountToOrganizationCommandOutput LeaveOrganizationCommand LeaveOrganizationCommandInput LeaveOrganizationCommandOutput ListAccountsCommand ListAccountsCommandInput ListAccountsCommandOutput ListAccountsForParentCommand ListAccountsForParentCommandInput ListAccountsForParentCommandOutput ListAWSServiceAccessForOrganizationCommand ListAWSServiceAccessForOrganizationCommandInput ListAWSServiceAccessForOrganizationCommandOutput ListChildrenCommand ListChildrenCommandInput ListChildrenCommandOutput ListCreateAccountStatusCommand ListCreateAccountStatusCommandInput ListCreateAccountStatusCommandOutput ListDelegatedAdministratorsCommand ListDelegatedAdministratorsCommandInput ListDelegatedAdministratorsCommandOutput ListDelegatedServicesForAccountCommand ListDelegatedServicesForAccountCommandInput ListDelegatedServicesForAccountCommandOutput ListHandshakesForAccountCommand ListHandshakesForAccountCommandInput ListHandshakesForAccountCommandOutput ListHandshakesForOrganizationCommand ListHandshakesForOrganizationCommandInput ListHandshakesForOrganizationCommandOutput ListOrganizationalUnitsForParentCommand ListOrganizationalUnitsForParentCommandInput ListOrganizationalUnitsForParentCommandOutput ListParentsCommand ListParentsCommandInput ListParentsCommandOutput ListPoliciesCommand ListPoliciesCommandInput ListPoliciesCommandOutput ListPoliciesForTargetCommand ListPoliciesForTargetCommandInput ListPoliciesForTargetCommandOutput ListRootsCommand ListRootsCommandInput ListRootsCommandOutput ListTagsForResourceCommand ListTagsForResourceCommandInput ListTagsForResourceCommandOutput ListTargetsForPolicyCommand ListTargetsForPolicyCommandInput ListTargetsForPolicyCommandOutput MoveAccountCommand MoveAccountCommandInput MoveAccountCommandOutput PutResourcePolicyCommand PutResourcePolicyCommandInput PutResourcePolicyCommandOutput RegisterDelegatedAdministratorCommand RegisterDelegatedAdministratorCommandInput RegisterDelegatedAdministratorCommandOutput RemoveAccountFromOrganizationCommand RemoveAccountFromOrganizationCommandInput RemoveAccountFromOrganizationCommandOutput TagResourceCommand TagResourceCommandInput TagResourceCommandOutput UntagResourceCommand UntagResourceCommandInput UntagResourceCommandOutput UpdateOrganizationalUnitCommand UpdateOrganizationalUnitCommandInput UpdateOrganizationalUnitCommandOutput UpdatePolicyCommand UpdatePolicyCommandInput UpdatePolicyCommandOutput

SDK - Paginators

SDK - Waiters