aws-elixir v0.4.0 AWS.Organizations
AWS Organizations API Reference
AWS Organizations is a web service that enables you to consolidate your multiple AWS accounts into an organization and centrally manage your accounts and their resources.
This guide provides descriptions of the Organizations API. For more information about using this service, see the AWS Organizations User Guide.
API Version
This version of the Organizations API Reference documents the Organizations API version 2016-11-28.
calls to Organizations. However, you also can use the Organizations Query API to make direct calls to the Organizations web service. To learn more about the Organizations Query API, see Making Query Requests in the AWS Organizations User Guide. Organizations supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.
Signing Requests
When you send HTTP requests to AWS, you must sign the requests so that AWS can identify who sent them. You sign requests with your AWS access key, which consists of an access key ID and a secret access key. We strongly recommend that you do not create an access key for your root account. Anyone who has the access key for your root account has unrestricted access to all the resources in your account. Instead, create an access key for an IAM user account that has administrative privileges. As another option, use AWS Security Token Service to generate temporary security credentials, and use those credentials to sign requests.
To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.
When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools.
In this release, each organization can have only one root. In a future release, a single organization will support multiple roots.
Support and Feedback for AWS Organizations
We welcome your feedback. Send your comments to aws-organizations-feedback@amazon.com or post your feedback and questions in our private AWS Organizations support forum. If you don’t have access to the forum, send a request for access to the email address, along with your forum user ID. For more information about the AWS support forums, see Forums Help.
Endpoint to Call When Using the CLI or the AWS API
For the current release of Organizations, you must specify the us-east-1
region for all AWS API and CLI calls. 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`
- Use the default endpoint, but configure your default region with this command: `aws configure set default.region us-east-1`
- Use the following parameter with each command to specify the endpoint: `--region us-east-1`
Summary
Functions
Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request
Attaches a policy to a root, an organizational unit, or an individual account. How the policy affects accounts depends on the type of policy
Cancels a handshake. Canceling a handshake sets the handshake state to
CANCELED
Creates an AWS account that is automatically a member of the organization
whose credentials made the request. This is an asynchronous request that
AWS performs in the background. If you want to check the status of the
request later, you need the OperationId
response element from this
operation to provide as a parameter to the DescribeCreateAccountStatus
operation
Creates an AWS organization. The account whose user is calling the CreateOrganization operation automatically becomes the master account of the new organization
Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five
Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account
Declines a handshake request. This sets the handshake state to DECLINED
and effectively deactivates the request
Deletes the organization. You can delete an organization only by using credentials from the master account. The organization must be empty of member accounts, OUs, and policies
Deletes an organizational unit from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete
Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all OUs, roots, and accounts
Retrieves Organizations-related information about the specified account
Retrieves the current status of an asynchronous request to create an account
Retrieves information about a previously requested handshake. The handshake
ID comes from the response to the original InviteAccountToOrganization
operation that generated the handshake
Retrieves information about the organization that the user’s account belongs to
Retrieves information about an organizational unit (OU)
Retrieves information about a policy
Detaches a policy from a target root, organizational unit, or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate
Disables an organizational control policy type in a root. A poicy of a
certain type can be attached to entities in a root only if that type is
enabled in the root. After you perform this operation, you no longer can
attach policies of the specified type to that root or to any OU or account
in that root. You can undo this by using the EnablePolicyType
operation
Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can’t use any of the advanced account administration features that AWS Organizations supports. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide
Enables a policy type in a root. After you enable a policy type in a root,
you can attach policies of that type to the root, any OU, or account in
that root. You can undo this by using the DisablePolicyType
operation
Sends an invitation to another account to join your organization as a
member account. Organizations sends email on your behalf to the email
address that is associated with the other account’s owner. The invitation
is implemented as a Handshake
whose details are in the response
Removes a member account from its parent organization. This version of the
operation is performed by the account that wants to leave. To remove a
member account as a user in the master account, use
RemoveAccountFromOrganization
instead
Lists all the accounts in the organization. To request only the accounts in
a root or OU, use the ListAccountsForParent
operation instead
Lists the accounts in an organization that are contained by the specified
target root or organizational unit (OU). If you specify the root, you get a
list of all the accounts that are not in any OU. If you specify an OU, you
get a list of all the accounts in only that OU, and not in any child OUs.
To get a list of all accounts in the organization, use the ListAccounts
operation
Lists all of the OUs or accounts that are contained in the specified parent
OU or root. This operation, along with ListParents
enables you to
traverse the tree structure that makes up this root
Lists the account creation requests that match the specified status that is currently being tracked for the organization
Lists the current handshakes that are associated with the account of the requesting user
Lists the handshakes that are associated with the organization that the
requesting user is part of. The ListHandshakesForOrganization
operation
returns a list of handshake structures. Each structure contains details and
status about a handshake
Lists the organizational units (OUs) in a parent organizational unit or root
Lists the root or organizational units (OUs) that serve as the immediate
parent of the specified child OU or account. This operation, along with
ListChildren
enables you to traverse the tree structure that makes up
this root
Retrieves the list of all policies in an organization of a specified type
Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list
Lists the roots that are defined in the current organization
Lists all the roots, OUs, and accounts to which the specified policy is attached
Moves an account from its current source parent root or OU to the specified destination parent root or OU
Removes the specified account from the organization
Renames the specified organizational unit (OU). The ID and ARN do not change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached
Updates an existing policy with a new name, description, or content. If any parameter is not supplied, that value remains unchanged. Note that you cannot change a policy’s type
Functions
Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.
This operation can be called only by the following principals when they also have the relevant IAM permissions:
- **Invitation to join** or **Approve all features request** handshakes: only a principal from the member account.
- **Enable all features final confirmation** handshake: only a principal from the master account. For more information about invitations, see [Inviting an AWS Account to Join Your Organization](http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_invites.html) in the *AWS Organizations User Guide*. For more information about requests to enable all features in the organization, see [Enabling All Features in Your Organization](http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) in the *AWS Organizations User Guide*.
Attaches a policy to a root, an organizational unit, or an individual account. How the policy affects accounts depends on the type of policy:
- **Service control policy (SCP)** - An SCP specifies what
permissions can be delegated to users in affected member accounts. The
scope of influence for a policy depends on what you attach the policy to:
- If you attach an SCP to a root, it affects all accounts in the organization.
- If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs.
- If you attach the policy directly to an account, then it affects only that account.
Cancels a handshake. Canceling a handshake sets the handshake state to
CANCELED
.
This operation can be called only from the account that originated the
handshake. The recipient of the handshake can’t cancel it, but can use
DeclineHandshake
instead. After a handshake is canceled, the recipient
can no longer respond to that handshake.
Creates an AWS account that is automatically a member of the organization
whose credentials made the request. This is an asynchronous request that
AWS performs in the background. If you want to check the status of the
request later, you need the OperationId
response element from this
operation to provide as a parameter to the DescribeCreateAccountStatus
operation.
AWS Organizations preconfigures the new member account with a role (named
OrganizationAccountAccessRole
by default) that grants administrator
permissions to the new account. Principals in the master account can assume
the role. AWS Organizations clones the company name and address information
for the new account from the organization’s master account.
For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.
the account is created with the IAM User and Role Access to Billing Information switch enabled. This allows IAM users and roles that are granted appropriate permissions to view billing information. If this is disabled, then only the account root user can access billing information. For information about how to disable this for an account, see Granting Access to Your Billing Information and Tools.
account.
Creates an AWS organization. The account whose user is calling the CreateOrganization operation automatically becomes the master account of the new organization.
This operation must be called using credentials from the account that is to become the new organization’s master account. The principal must also have the relevant IAM permissions.
By default (or if you set the FeatureSet
parameter to ALL
), the new
organization is created with all features enabled and service control
policies automatically enabled in the root. If you instead choose to create
the organization supporting only the consolidated billing features by
setting the FeatureSet
parameter to CONSOLIDATED_BILLING"
, then no
policy types are enabled by default and you cannot use organization
policies.
Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five.
For more information about OUs, see Managing Organizational Units in the AWS Organizations User Guide.
This operation can be called only from the organization’s master account.
Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account.
For more information about policies and their use, see Managing Organization Policies.
This operation can be called only from the organization’s master account.
Declines a handshake request. This sets the handshake state to DECLINED
and effectively deactivates the request.
This operation can be called only from the account that received the
handshake. The originator of the handshake can use CancelHandshake
instead. The originator can’t reactivate a declined request, but can
re-initiate the process with a new handshake request.
Deletes the organization. You can delete an organization only by using credentials from the master account. The organization must be empty of member accounts, OUs, and policies.
Deletes an organizational unit from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete.
This operation can be called only from the organization’s master account.
Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all OUs, roots, and accounts.
This operation can be called only from the organization’s master account.
Retrieves Organizations-related information about the specified account.
This operation can be called only from the organization’s master account.
Retrieves the current status of an asynchronous request to create an account.
This operation can be called only from the organization’s master account.
Retrieves information about a previously requested handshake. The handshake
ID comes from the response to the original InviteAccountToOrganization
operation that generated the handshake.
This operation can be called from any account in the organization.
Retrieves information about the organization that the user’s account belongs to.
This operation can be called from any account in the organization.
Retrieves information about an organizational unit (OU).
This operation can be called only from the organization’s master account.
Retrieves information about a policy.
This operation can be called only from the organization’s master account.
Detaches a policy from a target root, organizational unit, or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate.
Note: Every root, OU, and account must have at least one SCP attached.
If you want to replace the default FullAWSAccess
policy with one that
limits the permissions that can be delegated, then you must attach the
replacement policy before you can remove the default one. This is the
authorization strategy of
whitelisting.
If you instead attach a second SCP and leave the FullAWSAccess
SCP still
attached, and specify "Effect": "Deny"
in the second SCP to override the
"Effect": "Allow"
in the FullAWSAccess
policy (or any other attached
SCP), then you are using the authorization strategy of
blacklisting.
This operation can be called only from the organization’s master account.
Disables an organizational control policy type in a root. A poicy of a
certain type can be attached to entities in a root only if that type is
enabled in the root. After you perform this operation, you no longer can
attach policies of the specified type to that root or to any OU or account
in that root. You can undo this by using the EnablePolicyType
operation.
This operation can be called only from the organization’s master account.
Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can’t use any of the advanced account administration features that AWS Organizations supports. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.
finalize the feature set change by accepting the handshake that contains
"Action": "ENABLE_ALL_FEATURES"
. This completes the change.
After you enable all features in your organization, the master account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The master account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this.
This operation can be called only from the organization’s master account.
Enables a policy type in a root. After you enable a policy type in a root,
you can attach policies of that type to the root, any OU, or account in
that root. You can undo this by using the DisablePolicyType
operation.
This operation can be called only from the organization’s master account.
Sends an invitation to another account to join your organization as a
member account. Organizations sends email on your behalf to the email
address that is associated with the other account’s owner. The invitation
is implemented as a Handshake
whose details are in the response.
This operation can be called only from the organization’s master account.
Removes a member account from its parent organization. This version of the
operation is performed by the account that wants to leave. To remove a
member account as a user in the master account, use
RemoveAccountFromOrganization
instead.
This operation can be called only from a member account in the organization.
Lists all the accounts in the organization. To request only the accounts in
a root or OU, use the ListAccountsForParent
operation instead.
This operation can be called only from the organization’s master account.
Lists the accounts in an organization that are contained by the specified
target root or organizational unit (OU). If you specify the root, you get a
list of all the accounts that are not in any OU. If you specify an OU, you
get a list of all the accounts in only that OU, and not in any child OUs.
To get a list of all accounts in the organization, use the ListAccounts
operation.
Lists all of the OUs or accounts that are contained in the specified parent
OU or root. This operation, along with ListParents
enables you to
traverse the tree structure that makes up this root.
Lists the account creation requests that match the specified status that is currently being tracked for the organization.
This operation can be called only from the organization’s master account.
Lists the current handshakes that are associated with the account of the requesting user.
This operation can be called from any account in the organization.
Lists the handshakes that are associated with the organization that the
requesting user is part of. The ListHandshakesForOrganization
operation
returns a list of handshake structures. Each structure contains details and
status about a handshake.
This operation can be called only from the organization’s master account.
Lists the organizational units (OUs) in a parent organizational unit or root.
This operation can be called only from the organization’s master account.
Lists the root or organizational units (OUs) that serve as the immediate
parent of the specified child OU or account. This operation, along with
ListChildren
enables you to traverse the tree structure that makes up
this root.
This operation can be called only from the organization’s master account.
Retrieves the list of all policies in an organization of a specified type.
This operation can be called only from the organization’s master account.
Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list.
This operation can be called only from the organization’s master account.
Lists the roots that are defined in the current organization.
This operation can be called only from the organization’s master account.
Lists all the roots, OUs, and accounts to which the specified policy is attached.
This operation can be called only from the organization’s master account.
Moves an account from its current source parent root or OU to the specified destination parent root or OU.
This operation can be called only from the organization’s master account.
Removes the specified account from the organization.
The removed account becomes a stand-alone account that is not a member of any organization. It is no longer subject to any policies and is responsible for its own bill payments. The organization’s master account is no longer charged for any expenses accrued by the member account after it is removed from the organization.
This operation can be called only from the organization’s master account.
Member accounts can remove themselves with LeaveOrganization
instead.
Renames the specified organizational unit (OU). The ID and ARN do not change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached.
This operation can be called only from the organization’s master account.