@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSOrganizationsClient extends AmazonWebServiceClient implements AWSOrganizations
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.
As an alternative to using the API directly, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to AWS Organizations. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the AWS SDKs to make programmatic API 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 feedback-awsorganizations@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
For the various SDKs used to call the APIs, see the documentation for the SDK of interest to learn how to direct the requests to a specific endpoint. For more information, see Regions and Endpoints in the AWS General Reference.
How examples are presented
The JSON returned by the AWS Organizations service as response to your requests is returned as a single long string without line breaks or formatting whitespace. Both line breaks and whitespace are included in the examples in this guide to improve readability. When example input parameters also would result in long strings that would extend beyond the screen, we insert line breaks to enhance readability. You should always submit the input as a single JSON text string.
Recording API Requests
AWS Organizations supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by AWS CloudTrail, you can determine which requests were successfully made to Organizations, who made the request, when it was made, and so on. For more about AWS Organizations and its support for AWS CloudTrail, see Logging AWS Organizations Events with AWS CloudTrail in the AWS Organizations User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSOrganizationsClient()
Deprecated.
|
AWSOrganizationsClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSOrganizationsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSOrganizationsClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSOrganizationsClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSOrganizationsClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSOrganizationsClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSOrganizationsClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AcceptHandshakeResult |
acceptHandshake(AcceptHandshakeRequest request)
Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.
|
AttachPolicyResult |
attachPolicy(AttachPolicyRequest request)
Attaches a policy to a root, an organizational unit, or an individual account.
|
static AWSOrganizationsClientBuilder |
builder() |
CancelHandshakeResult |
cancelHandshake(CancelHandshakeRequest request)
Cancels a handshake.
|
CreateAccountResult |
createAccount(CreateAccountRequest request)
Creates an AWS account that is automatically a member of the organization whose credentials made the request.
|
CreateOrganizationResult |
createOrganization(CreateOrganizationRequest request)
Creates an AWS organization.
|
CreateOrganizationalUnitResult |
createOrganizationalUnit(CreateOrganizationalUnitRequest request)
Creates an organizational unit (OU) within a root or parent OU.
|
CreatePolicyResult |
createPolicy(CreatePolicyRequest request)
Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual
AWS account.
|
DeclineHandshakeResult |
declineHandshake(DeclineHandshakeRequest request)
Declines a handshake request.
|
DeleteOrganizationResult |
deleteOrganization(DeleteOrganizationRequest request)
Deletes the organization.
|
DeleteOrganizationalUnitResult |
deleteOrganizationalUnit(DeleteOrganizationalUnitRequest request)
Deletes an organizational unit from a root or another OU.
|
DeletePolicyResult |
deletePolicy(DeletePolicyRequest request)
Deletes the specified policy from your organization.
|
DescribeAccountResult |
describeAccount(DescribeAccountRequest request)
Retrieves Organizations-related information about the specified account.
|
DescribeCreateAccountStatusResult |
describeCreateAccountStatus(DescribeCreateAccountStatusRequest request)
Retrieves the current status of an asynchronous request to create an account.
|
DescribeHandshakeResult |
describeHandshake(DescribeHandshakeRequest request)
Retrieves information about a previously requested handshake.
|
DescribeOrganizationResult |
describeOrganization(DescribeOrganizationRequest request)
Retrieves information about the organization that the user's account belongs to.
|
DescribeOrganizationalUnitResult |
describeOrganizationalUnit(DescribeOrganizationalUnitRequest request)
Retrieves information about an organizational unit (OU).
|
DescribePolicyResult |
describePolicy(DescribePolicyRequest request)
Retrieves information about a policy.
|
DetachPolicyResult |
detachPolicy(DetachPolicyRequest request)
Detaches a policy from a target root, organizational unit, or account.
|
DisablePolicyTypeResult |
disablePolicyType(DisablePolicyTypeRequest request)
Disables an organizational control policy type in a root.
|
EnableAllFeaturesResult |
enableAllFeatures(EnableAllFeaturesRequest request)
Enables all features in an organization.
|
EnablePolicyTypeResult |
enablePolicyType(EnablePolicyTypeRequest request)
Enables a policy type in a root.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
InviteAccountToOrganizationResult |
inviteAccountToOrganization(InviteAccountToOrganizationRequest request)
Sends an invitation to another account to join your organization as a member account.
|
LeaveOrganizationResult |
leaveOrganization(LeaveOrganizationRequest request)
Removes a member account from its parent organization.
|
ListAccountsResult |
listAccounts(ListAccountsRequest request)
Lists all the accounts in the organization.
|
ListAccountsForParentResult |
listAccountsForParent(ListAccountsForParentRequest request)
Lists the accounts in an organization that are contained by the specified target root or organizational unit
(OU).
|
ListChildrenResult |
listChildren(ListChildrenRequest request)
Lists all of the OUs or accounts that are contained in the specified parent OU or root.
|
ListCreateAccountStatusResult |
listCreateAccountStatus(ListCreateAccountStatusRequest request)
Lists the account creation requests that match the specified status that is currently being tracked for the
organization.
|
ListHandshakesForAccountResult |
listHandshakesForAccount(ListHandshakesForAccountRequest request)
Lists the current handshakes that are associated with the account of the requesting user.
|
ListHandshakesForOrganizationResult |
listHandshakesForOrganization(ListHandshakesForOrganizationRequest request)
Lists the handshakes that are associated with the organization that the requesting user is part of.
|
ListOrganizationalUnitsForParentResult |
listOrganizationalUnitsForParent(ListOrganizationalUnitsForParentRequest request)
Lists the organizational units (OUs) in a parent organizational unit or root.
|
ListParentsResult |
listParents(ListParentsRequest request)
Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or
account.
|
ListPoliciesResult |
listPolicies(ListPoliciesRequest request)
Retrieves the list of all policies in an organization of a specified type.
|
ListPoliciesForTargetResult |
listPoliciesForTarget(ListPoliciesForTargetRequest request)
Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account.
|
ListRootsResult |
listRoots(ListRootsRequest request)
Lists the roots that are defined in the current organization.
|
ListTargetsForPolicyResult |
listTargetsForPolicy(ListTargetsForPolicyRequest request)
Lists all the roots, OUs, and accounts to which the specified policy is attached.
|
MoveAccountResult |
moveAccount(MoveAccountRequest request)
Moves an account from its current source parent root or OU to the specified destination parent root or OU.
|
RemoveAccountFromOrganizationResult |
removeAccountFromOrganization(RemoveAccountFromOrganizationRequest request)
Removes the specified account from the organization.
|
UpdateOrganizationalUnitResult |
updateOrganizationalUnit(UpdateOrganizationalUnitRequest request)
Renames the specified organizational unit (OU).
|
UpdatePolicyResult |
updatePolicy(UpdatePolicyRequest request)
Updates an existing policy with a new name, description, or content.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
@Deprecated public AWSOrganizationsClient()
AWSOrganizationsClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AWSOrganizationsClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to Organizations (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AWSOrganizationsClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AWSOrganizationsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSOrganizationsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Organizations (ex: proxy
settings, retry counts, etc.).@Deprecated public AWSOrganizationsClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSOrganizationsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Organizations (ex: proxy
settings, retry counts, etc.).@Deprecated public AWSOrganizationsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Organizations (ex: proxy
settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AWSOrganizationsClientBuilder builder()
public AcceptHandshakeResult acceptHandshake(AcceptHandshakeRequest request)
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.
The user who calls the API for an invitation to join must have the organizations:AcceptHandshake
permission. If you enabled all features in the organization, then the user must also have the
iam:CreateServiceLinkedRole
permission so that Organizations can create the required service-linked
role named OrgsServiceLinkedRoleName. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.
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 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 in the AWS Organizations User Guide.
After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.
acceptHandshake
in interface AWSOrganizations
acceptHandshakeRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.HandshakeConstraintViolationException
- The requested operation would violate the constraint identified in the reason code.
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. Note: deleted and closed accounts still count toward your limit.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.
ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.
ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.
INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You cannot issue new invitations to join an organization while it is in the process of enabling all features. You can resume inviting accounts after you finalize the process when all accounts have agreed to the change.
PAYMENT_INSTRUMENT_REQUIRED: You cannot complete the operation with an account that does not have a payment instrument, such as a credit card, associated with it.
ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be from the same marketplace.
ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change the membership of an account too quickly after its previous change.
HandshakeNotFoundException
- We can't find a handshake with the HandshakeId that you specified.InvalidHandshakeTransitionException
- You can't perform the operation on the handshake in its current state. For example, you can't cancel a
handshake that was already accepted, or accept a handshake that was already declined.HandshakeAlreadyInStateException
- The specified handshake is already in the requested state. For example, you can't accept a handshake that
was already accepted.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.AccessDeniedForDependencyException
- The operation you attempted requires you to have the iam:CreateServiceLinkedRole
so that
Organizations can create the required service-linked role. You do not have that permission.public AttachPolicyResult attachPolicy(AttachPolicyRequest 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:
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.
SCPs essentially are permission "filters". When you attach one SCP to a higher level root or OU, and you also attach a different SCP to a child OU or to an account, the child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child cannot grant a permission that is not already granted by the parent. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They cannot use A or B because they were filtered out by the child OU. They also cannot use F and G because they were filtered out by the parent OU. They cannot be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP.
AWS Organizations attaches a default SCP named "FullAWSAccess
to every root, OU, and account. This
default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of
the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the
permissions that you want to allow in that OU or account.
For more information about how Organizations policies permissions work, see Using Service Control Policies in the AWS Organizations User Guide.
This operation can be called only from the organization's master account.
attachPolicy
in interface AWSOrganizations
attachPolicyRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ConstraintViolationException
- Performing this operation violates a minimum or maximum value limit. For example, attempting to removing
the last SCP from an OU or root, inviting or creating too many accounts to the organization, or attaching
too many policies to an account, OU, or root. This exception includes a reason that contains additional
information about the violated limit. Some of the reasons in the following list might not be applicable to this specific API or operation:
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.
Or, The number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations, or contact AWS Support to request an increase in the number of accounts.
Note: deleted and closed accounts still count toward your limit.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of organizational units you can have in an organization.
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an organizational unit tree that is too many levels deep.
POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.
DuplicatePolicyAttachmentException
- The selected policy is already attached to the specified target.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
PolicyNotFoundException
- We can't find a policy with the PolicyId that you specified.PolicyTypeNotEnabledException
- The specified policy type is not currently enabled in this root. You cannot attach policies of the
specified type to entities in a root until you enable that type in the root. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TargetNotFoundException
- We can't find a root, OU, or account with the TargetId that you specified.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public CancelHandshakeResult cancelHandshake(CancelHandshakeRequest request)
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.
After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.
cancelHandshake
in interface AWSOrganizations
cancelHandshakeRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.HandshakeNotFoundException
- We can't find a handshake with the HandshakeId that you specified.InvalidHandshakeTransitionException
- You can't perform the operation on the handshake in its current state. For example, you can't cancel a
handshake that was already accepted, or accept a handshake that was already declined.HandshakeAlreadyInStateException
- The specified handshake is already in the requested state. For example, you can't accept a handshake that
was already accepted.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public CreateAccountResult createAccount(CreateAccountRequest request)
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.
The user who calls the API for an invitation to join must have the organizations:CreateAccount
permission. If you enabled all features in the organization, then the user must also have the
iam:CreateServiceLinkedRole
permission so that Organizations can create the required service-linked
role named OrgsServiceLinkedRoleName. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.
The user in the master account who calls this API must also have the iam:CreateRole
permission
because AWS Organizations preconfigures the new member account with a role (named
OrganizationAccountAccessRole
) that grants users in the master account administrator permissions in
the new member 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.
This operation can be called only 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.
When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the End User Licence Agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable this, 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.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
createAccount
in interface AWSOrganizations
createAccountRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ConstraintViolationException
- Performing this operation violates a minimum or maximum value limit. For example, attempting to removing
the last SCP from an OU or root, inviting or creating too many accounts to the organization, or attaching
too many policies to an account, OU, or root. This exception includes a reason that contains additional
information about the violated limit. Some of the reasons in the following list might not be applicable to this specific API or operation:
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.
Or, The number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations, or contact AWS Support to request an increase in the number of accounts.
Note: deleted and closed accounts still count toward your limit.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of organizational units you can have in an organization.
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an organizational unit tree that is too many levels deep.
POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.
InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
FinalizingOrganizationException
- AWS Organizations could not finalize the creation of your organization. Try again later. If this
persists, contact AWS customer support.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public CreateOrganizationResult createOrganization(CreateOrganizationRequest request)
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.
createOrganization
in interface AWSOrganizations
createOrganizationRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AlreadyInOrganizationException
- This account is already a member of an organization. An account can belong to only one organization at a
time.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ConstraintViolationException
- Performing this operation violates a minimum or maximum value limit. For example, attempting to removing
the last SCP from an OU or root, inviting or creating too many accounts to the organization, or attaching
too many policies to an account, OU, or root. This exception includes a reason that contains additional
information about the violated limit. Some of the reasons in the following list might not be applicable to this specific API or operation:
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.
Or, The number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations, or contact AWS Support to request an increase in the number of accounts.
Note: deleted and closed accounts still count toward your limit.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of organizational units you can have in an organization.
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an organizational unit tree that is too many levels deep.
POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.
InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.AccessDeniedForDependencyException
- The operation you attempted requires you to have the iam:CreateServiceLinkedRole
so that
Organizations can create the required service-linked role. You do not have that permission.public CreateOrganizationalUnitResult createOrganizationalUnit(CreateOrganizationalUnitRequest request)
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.
createOrganizationalUnit
in interface AWSOrganizations
createOrganizationalUnitRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ConstraintViolationException
- Performing this operation violates a minimum or maximum value limit. For example, attempting to removing
the last SCP from an OU or root, inviting or creating too many accounts to the organization, or attaching
too many policies to an account, OU, or root. This exception includes a reason that contains additional
information about the violated limit. Some of the reasons in the following list might not be applicable to this specific API or operation:
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.
Or, The number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations, or contact AWS Support to request an increase in the number of accounts.
Note: deleted and closed accounts still count toward your limit.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of organizational units you can have in an organization.
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an organizational unit tree that is too many levels deep.
POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.
DuplicateOrganizationalUnitException
- An organizational unit (OU) with the same name already exists.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ParentNotFoundException
- We can't find a root or organizational unit (OU) with the ParentId that you specified.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public CreatePolicyResult createPolicy(CreatePolicyRequest request)
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.
createPolicy
in interface AWSOrganizations
createPolicyRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ConstraintViolationException
- Performing this operation violates a minimum or maximum value limit. For example, attempting to removing
the last SCP from an OU or root, inviting or creating too many accounts to the organization, or attaching
too many policies to an account, OU, or root. This exception includes a reason that contains additional
information about the violated limit. Some of the reasons in the following list might not be applicable to this specific API or operation:
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.
Or, The number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations, or contact AWS Support to request an increase in the number of accounts.
Note: deleted and closed accounts still count toward your limit.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of organizational units you can have in an organization.
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an organizational unit tree that is too many levels deep.
POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.
DuplicatePolicyException
- A policy with the same name already exists.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
MalformedPolicyDocumentException
- The provided policy document does not meet the requirements of the specified policy type. For example,
the syntax might be incorrect. For details about service control policy syntax, see Service
Control Policy Syntax in the AWS Organizations User Guide.PolicyTypeNotAvailableForOrganizationException
- You can't use the specified policy type with the feature set currently enabled for this organization. For
example, you can enable service control policies (SCPs) only after you enable all features in the
organization. For more information, see Enabling and Disabling a Policy Type on a Root in the AWS Organizations User Guide.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public DeclineHandshakeResult declineHandshake(DeclineHandshakeRequest request)
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.
After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.
declineHandshake
in interface AWSOrganizations
declineHandshakeRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.HandshakeNotFoundException
- We can't find a handshake with the HandshakeId that you specified.InvalidHandshakeTransitionException
- You can't perform the operation on the handshake in its current state. For example, you can't cancel a
handshake that was already accepted, or accept a handshake that was already declined.HandshakeAlreadyInStateException
- The specified handshake is already in the requested state. For example, you can't accept a handshake that
was already accepted.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public DeleteOrganizationResult deleteOrganization(DeleteOrganizationRequest 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.
deleteOrganization
in interface AWSOrganizations
deleteOrganizationRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
OrganizationNotEmptyException
- The organization isn't empty. To delete an organization, you must first remove all accounts except the
master account, delete all organizational units (OUs), and delete all policies.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public DeleteOrganizationalUnitResult deleteOrganizationalUnit(DeleteOrganizationalUnitRequest request)
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.
deleteOrganizationalUnit
in interface AWSOrganizations
deleteOrganizationalUnitRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
OrganizationalUnitNotEmptyException
- The specified organizational unit (OU) is not empty. Move all accounts to another root or to other OUs,
remove all child OUs, and then try the operation again.OrganizationalUnitNotFoundException
- We can't find an organizational unit (OU) with the OrganizationalUnitId that you specified.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public DeletePolicyResult deletePolicy(DeletePolicyRequest request)
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.
deletePolicy
in interface AWSOrganizations
deletePolicyRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
PolicyInUseException
- The policy is attached to one or more entities. You must detach it from all roots, organizational units
(OUs), and accounts before performing this operation.PolicyNotFoundException
- We can't find a policy with the PolicyId that you specified.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public DescribeAccountResult describeAccount(DescribeAccountRequest request)
Retrieves Organizations-related information about the specified account.
This operation can be called only from the organization's master account.
describeAccount
in interface AWSOrganizations
describeAccountRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AccountNotFoundException
- We can't find an AWS account with the AccountId that you specified, or the account whose credentials you
used to make this request is not a member of an organization.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public DescribeCreateAccountStatusResult describeCreateAccountStatus(DescribeCreateAccountStatusRequest request)
Retrieves the current status of an asynchronous request to create an account.
This operation can be called only from the organization's master account.
describeCreateAccountStatus
in interface AWSOrganizations
describeCreateAccountStatusRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.CreateAccountStatusNotFoundException
- We can't find an create account request with the CreateAccountRequestId that you specified.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public DescribeHandshakeResult describeHandshake(DescribeHandshakeRequest request)
Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake.
You can access handshakes that are ACCEPTED, DECLINED, or CANCELED for only 30 days after they change to that state. They are then deleted and no longer accessible.
This operation can be called from any account in the organization.
describeHandshake
in interface AWSOrganizations
describeHandshakeRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.HandshakeNotFoundException
- We can't find a handshake with the HandshakeId that you specified.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public DescribeOrganizationResult describeOrganization(DescribeOrganizationRequest request)
Retrieves information about the organization that the user's account belongs to.
This operation can be called from any account in the organization.
describeOrganization
in interface AWSOrganizations
describeOrganizationRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public DescribeOrganizationalUnitResult describeOrganizationalUnit(DescribeOrganizationalUnitRequest request)
Retrieves information about an organizational unit (OU).
This operation can be called only from the organization's master account.
describeOrganizationalUnit
in interface AWSOrganizations
describeOrganizationalUnitRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
OrganizationalUnitNotFoundException
- We can't find an organizational unit (OU) with the OrganizationalUnitId that you specified.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public DescribePolicyResult describePolicy(DescribePolicyRequest request)
Retrieves information about a policy.
This operation can be called only from the organization's master account.
describePolicy
in interface AWSOrganizations
describePolicyRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
PolicyNotFoundException
- We can't find a policy with the PolicyId that you specified.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public DetachPolicyResult detachPolicy(DetachPolicyRequest request)
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.
detachPolicy
in interface AWSOrganizations
detachPolicyRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ConstraintViolationException
- Performing this operation violates a minimum or maximum value limit. For example, attempting to removing
the last SCP from an OU or root, inviting or creating too many accounts to the organization, or attaching
too many policies to an account, OU, or root. This exception includes a reason that contains additional
information about the violated limit. Some of the reasons in the following list might not be applicable to this specific API or operation:
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.
Or, The number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations, or contact AWS Support to request an increase in the number of accounts.
Note: deleted and closed accounts still count toward your limit.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of organizational units you can have in an organization.
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an organizational unit tree that is too many levels deep.
POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.
InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
PolicyNotAttachedException
- The policy isn't attached to the specified target in the specified root.PolicyNotFoundException
- We can't find a policy with the PolicyId that you specified.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TargetNotFoundException
- We can't find a root, OU, or account with the TargetId that you specified.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public DisablePolicyTypeResult disablePolicyType(DisablePolicyTypeRequest request)
Disables an organizational control policy type in a root. A policy 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.
disablePolicyType
in interface AWSOrganizations
disablePolicyTypeRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ConstraintViolationException
- Performing this operation violates a minimum or maximum value limit. For example, attempting to removing
the last SCP from an OU or root, inviting or creating too many accounts to the organization, or attaching
too many policies to an account, OU, or root. This exception includes a reason that contains additional
information about the violated limit. Some of the reasons in the following list might not be applicable to this specific API or operation:
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.
Or, The number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations, or contact AWS Support to request an increase in the number of accounts.
Note: deleted and closed accounts still count toward your limit.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of organizational units you can have in an organization.
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an organizational unit tree that is too many levels deep.
POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.
InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
PolicyTypeNotEnabledException
- The specified policy type is not currently enabled in this root. You cannot attach policies of the
specified type to entities in a root until you enable that type in the root. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.RootNotFoundException
- We can't find a root with the RootId that you specified.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public EnableAllFeaturesResult enableAllFeatures(EnableAllFeaturesRequest request)
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.
This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled, or that were migrated from a Consolidated Billing account family to Organizations. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake.
After all invited member accounts accept the handshake, you 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.
enableAllFeatures
in interface AWSOrganizations
enableAllFeaturesRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.HandshakeConstraintViolationException
- The requested operation would violate the constraint identified in the reason code.
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. Note: deleted and closed accounts still count toward your limit.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.
ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.
ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.
INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You cannot issue new invitations to join an organization while it is in the process of enabling all features. You can resume inviting accounts after you finalize the process when all accounts have agreed to the change.
PAYMENT_INSTRUMENT_REQUIRED: You cannot complete the operation with an account that does not have a payment instrument, such as a credit card, associated with it.
ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be from the same marketplace.
ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change the membership of an account too quickly after its previous change.
InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public EnablePolicyTypeResult enablePolicyType(EnablePolicyTypeRequest request)
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.
enablePolicyType
in interface AWSOrganizations
enablePolicyTypeRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ConstraintViolationException
- Performing this operation violates a minimum or maximum value limit. For example, attempting to removing
the last SCP from an OU or root, inviting or creating too many accounts to the organization, or attaching
too many policies to an account, OU, or root. This exception includes a reason that contains additional
information about the violated limit. Some of the reasons in the following list might not be applicable to this specific API or operation:
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.
Or, The number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations, or contact AWS Support to request an increase in the number of accounts.
Note: deleted and closed accounts still count toward your limit.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of organizational units you can have in an organization.
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an organizational unit tree that is too many levels deep.
POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.
InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
PolicyTypeAlreadyEnabledException
- The specified policy type is already enabled in the specified root.RootNotFoundException
- We can't find a root with the RootId that you specified.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.PolicyTypeNotAvailableForOrganizationException
- You can't use the specified policy type with the feature set currently enabled for this organization. For
example, you can enable service control policies (SCPs) only after you enable all features in the
organization. For more information, see Enabling and Disabling a Policy Type on a Root in the AWS Organizations User Guide.public InviteAccountToOrganizationResult inviteAccountToOrganization(InviteAccountToOrganizationRequest request)
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.
You can invite AWS accounts only from the same seller as the master account. For example, if your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India, then you can only invite other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS, or any other AWS seller. For more information, see Consolidated Billing in India.
This operation can be called only from the organization's master account.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
inviteAccountToOrganization
in interface AWSOrganizations
inviteAccountToOrganizationRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.HandshakeConstraintViolationException
- The requested operation would violate the constraint identified in the reason code.
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. Note: deleted and closed accounts still count toward your limit.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.
ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.
ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.
INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You cannot issue new invitations to join an organization while it is in the process of enabling all features. You can resume inviting accounts after you finalize the process when all accounts have agreed to the change.
PAYMENT_INSTRUMENT_REQUIRED: You cannot complete the operation with an account that does not have a payment instrument, such as a credit card, associated with it.
ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be from the same marketplace.
ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change the membership of an account too quickly after its previous change.
DuplicateHandshakeException
- A handshake with the same action and target already exists. For example, if you invited an account to
join your organization, the invited account might already have a pending invitation from this
organization. If you intend to resend an invitation to an account, ensure that existing handshakes that
might be considered duplicates are canceled or declined.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
FinalizingOrganizationException
- AWS Organizations could not finalize the creation of your organization. Try again later. If this
persists, contact AWS customer support.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public LeaveOrganizationResult leaveOrganization(LeaveOrganizationRequest request)
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.
The master account in an organization with all features enabled can set service control policies (SCPs) that can
restrict what administrators of member accounts can do, including preventing them from successfully calling
LeaveOrganization
and leaving the organization.
You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For each account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
You can leave an organization only after you enable IAM user access to billing in your account. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.
leaveOrganization
in interface AWSOrganizations
leaveOrganizationRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AccountNotFoundException
- We can't find an AWS account with the AccountId that you specified, or the account whose credentials you
used to make this request is not a member of an organization.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ConstraintViolationException
- Performing this operation violates a minimum or maximum value limit. For example, attempting to removing
the last SCP from an OU or root, inviting or creating too many accounts to the organization, or attaching
too many policies to an account, OU, or root. This exception includes a reason that contains additional
information about the violated limit. Some of the reasons in the following list might not be applicable to this specific API or operation:
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.
Or, The number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations, or contact AWS Support to request an increase in the number of accounts.
Note: deleted and closed accounts still count toward your limit.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of organizational units you can have in an organization.
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an organizational unit tree that is too many levels deep.
POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.
InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
MasterCannotLeaveOrganizationException
- You can't remove a master account from an organization. If you want the master account to become a member
account in another organization, you must first delete the current organization of the master account.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public ListAccountsResult listAccounts(ListAccountsRequest request)
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.
listAccounts
in interface AWSOrganizations
listAccountsRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public ListAccountsForParentResult listAccountsForParent(ListAccountsForParentRequest request)
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.
This operation can be called only from the organization's master account.
listAccountsForParent
in interface AWSOrganizations
listAccountsForParentRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ParentNotFoundException
- We can't find a root or organizational unit (OU) with the ParentId that you specified.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public ListChildrenResult listChildren(ListChildrenRequest request)
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.
This operation can be called only from the organization's master account.
listChildren
in interface AWSOrganizations
listChildrenRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ParentNotFoundException
- We can't find a root or organizational unit (OU) with the ParentId that you specified.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public ListCreateAccountStatusResult listCreateAccountStatus(ListCreateAccountStatusRequest request)
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.
listCreateAccountStatus
in interface AWSOrganizations
listCreateAccountStatusRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public ListHandshakesForAccountResult listHandshakesForAccount(ListHandshakesForAccountRequest request)
Lists the current handshakes that are associated with the account of the requesting user.
Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible.
This operation can be called from any account in the organization.
listHandshakesForAccount
in interface AWSOrganizations
listHandshakesForAccountRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public ListHandshakesForOrganizationResult listHandshakesForOrganization(ListHandshakesForOrganizationRequest request)
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.
Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible.
This operation can be called only from the organization's master account.
listHandshakesForOrganization
in interface AWSOrganizations
listHandshakesForOrganizationRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public ListOrganizationalUnitsForParentResult listOrganizationalUnitsForParent(ListOrganizationalUnitsForParentRequest request)
Lists the organizational units (OUs) in a parent organizational unit or root.
This operation can be called only from the organization's master account.
listOrganizationalUnitsForParent
in interface AWSOrganizations
listOrganizationalUnitsForParentRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ParentNotFoundException
- We can't find a root or organizational unit (OU) with the ParentId that you specified.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public ListParentsResult listParents(ListParentsRequest request)
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.
In the current release, a child can have only a single parent.
listParents
in interface AWSOrganizations
listParentsRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ChildNotFoundException
- We can't find an organizational unit (OU) or AWS account with the ChildId that you specified.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public ListPoliciesResult listPolicies(ListPoliciesRequest request)
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.
listPolicies
in interface AWSOrganizations
listPoliciesRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public ListPoliciesForTargetResult listPoliciesForTarget(ListPoliciesForTargetRequest request)
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.
listPoliciesForTarget
in interface AWSOrganizations
listPoliciesForTargetRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TargetNotFoundException
- We can't find a root, OU, or account with the TargetId that you specified.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public ListRootsResult listRoots(ListRootsRequest request)
Lists the roots that are defined in the current organization.
This operation can be called only from the organization's master account.
listRoots
in interface AWSOrganizations
listRootsRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public ListTargetsForPolicyResult listTargetsForPolicy(ListTargetsForPolicyRequest request)
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.
listTargetsForPolicy
in interface AWSOrganizations
listTargetsForPolicyRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
PolicyNotFoundException
- We can't find a policy with the PolicyId that you specified.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public MoveAccountResult moveAccount(MoveAccountRequest request)
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.
moveAccount
in interface AWSOrganizations
moveAccountRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
SourceParentNotFoundException
- We can't find a source root or OU with the ParentId that you specified.DestinationParentNotFoundException
- We can't find the destination container (a root or OU) with the ParentId that you specified.DuplicateAccountException
- That account is already present in the specified destination.AccountNotFoundException
- We can't find an AWS account with the AccountId that you specified, or the account whose credentials you
used to make this request is not a member of an organization.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.public RemoveAccountFromOrganizationResult removeAccountFromOrganization(RemoveAccountFromOrganizationRequest request)
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.
You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For an account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. To remove an account that does not yet have this information, you must sign in as the member account and follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
You can remove a member account only after you enable IAM user access to billing in the member account. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.
removeAccountFromOrganization
in interface AWSOrganizations
removeAccountFromOrganizationRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AccountNotFoundException
- We can't find an AWS account with the AccountId that you specified, or the account whose credentials you
used to make this request is not a member of an organization.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ConstraintViolationException
- Performing this operation violates a minimum or maximum value limit. For example, attempting to removing
the last SCP from an OU or root, inviting or creating too many accounts to the organization, or attaching
too many policies to an account, OU, or root. This exception includes a reason that contains additional
information about the violated limit. Some of the reasons in the following list might not be applicable to this specific API or operation:
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.
Or, The number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations, or contact AWS Support to request an increase in the number of accounts.
Note: deleted and closed accounts still count toward your limit.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of organizational units you can have in an organization.
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an organizational unit tree that is too many levels deep.
POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.
InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
MasterCannotLeaveOrganizationException
- You can't remove a master account from an organization. If you want the master account to become a member
account in another organization, you must first delete the current organization of the master account.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public UpdateOrganizationalUnitResult updateOrganizationalUnit(UpdateOrganizationalUnitRequest request)
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.
updateOrganizationalUnit
in interface AWSOrganizations
updateOrganizationalUnitRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.DuplicateOrganizationalUnitException
- An organizational unit (OU) with the same name already exists.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
OrganizationalUnitNotFoundException
- We can't find an organizational unit (OU) with the OrganizationalUnitId that you specified.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public UpdatePolicyResult updatePolicy(UpdatePolicyRequest request)
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.
This operation can be called only from the organization's master account.
updatePolicy
in interface AWSOrganizations
updatePolicyRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.AWSOrganizationsNotInUseException
- Your account is not a member of an organization. To make this request, you must use the credentials of an
account that belongs to an organization.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ConstraintViolationException
- Performing this operation violates a minimum or maximum value limit. For example, attempting to removing
the last SCP from an OU or root, inviting or creating too many accounts to the organization, or attaching
too many policies to an account, OU, or root. This exception includes a reason that contains additional
information about the violated limit. Some of the reasons in the following list might not be applicable to this specific API or operation:
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.
Or, The number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations, or contact AWS Support to request an increase in the number of accounts.
Note: deleted and closed accounts still count toward your limit.
If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of organizational units you can have in an organization.
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an organizational unit tree that is too many levels deep.
POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.
DuplicatePolicyException
- A policy with the same name already exists.InvalidInputException
- The requested operation failed because you provided invalid values for one or more of the request
parameters. This exception includes a reason that contains additional information about the violated
limit:
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
INVALID_ENUM: You specified a value that is not valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
MalformedPolicyDocumentException
- The provided policy document does not meet the requirements of the specified policy type. For example,
the syntax might be incorrect. For details about service control policy syntax, see Service
Control Policy Syntax in the AWS Organizations User Guide.PolicyNotFoundException
- We can't find a policy with the PolicyId that you specified.ServiceException
- AWS Organizations can't complete your request because of an internal service error. Try again later.TooManyRequestsException
- You've sent too many requests in too short a period of time. The limit helps protect against
denial-of-service attacks. Try again later.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSOrganizations
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.