com.amazonaws.services.organizations

Class AWSOrganizationsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.organizations.AWSOrganizationsClient

All Implemented Interfaces:

AWSOrganizations

Direct Known Subclasses:

AWSOrganizationsAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSOrganizationsClient
extends AmazonWebServiceClient
implements AWSOrganizations

Client for accessing Organizations. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Organizations

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.organizations.AWSOrganizations

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSOrganizationsClient() Deprecated. use AWSOrganizationsClientBuilder.defaultClient()
AWSOrganizationsClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSOrganizationsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSOrganizationsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSOrganizationsClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSOrganizationsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSOrganizationsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSOrganizationsClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

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 (OU), 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.
CreateGovCloudAccountResult	createGovCloudAccount(CreateGovCloudAccountRequest request) This action is available if all of the following are true:
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 (OU) from a root or another OU.
DeletePolicyResult	deletePolicy(DeletePolicyRequest request) Deletes the specified policy from your organization.
DescribeAccountResult	describeAccount(DescribeAccountRequest request) Retrieves AWS Organizations related information about the specified account.
DescribeCreateAccountStatusResult	describeCreateAccountStatus(DescribeCreateAccountStatusRequest request) Retrieves the current status of an asynchronous request to create an account.
DescribeEffectivePolicyResult	describeEffectivePolicy(DescribeEffectivePolicyRequest request) Returns the contents of the effective tag policy for the 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 (OU), or account.
DisableAWSServiceAccessResult	disableAWSServiceAccess(DisableAWSServiceAccessRequest request) Disables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations.
DisablePolicyTypeResult	disablePolicyType(DisablePolicyTypeRequest request) Disables an organizational control policy type in a root and detaches all policies of that type from the organization root, OUs, and accounts.
EnableAllFeaturesResult	enableAllFeatures(EnableAllFeaturesRequest request) Enables all features in an organization.
EnableAWSServiceAccessResult	enableAWSServiceAccess(EnableAWSServiceAccessRequest request) Enables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations.
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).
ListAWSServiceAccessForOrganizationResult	listAWSServiceAccessForOrganization(ListAWSServiceAccessForOrganizationRequest request) Returns a list of the AWS services that you enabled to integrate with your organization.
ListChildrenResult	listChildren(ListChildrenRequest request) Lists all of the organizational units (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.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists tags for the specified resource.
ListTargetsForPolicyResult	listTargetsForPolicy(ListTargetsForPolicyRequest request) Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.
MoveAccountResult	moveAccount(MoveAccountRequest request) Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU.
RemoveAccountFromOrganizationResult	removeAccountFromOrganization(RemoveAccountFromOrganizationRequest request) Removes the specified account from the organization.
TagResourceResult	tagResource(TagResourceRequest request) Adds one or more tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes a tag from the specified resource.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.organizations.AWSOrganizations

setEndpoint, setRegion, shutdown

Constructor Detail

AWSOrganizationsClient

@Deprecated
public AWSOrganizationsClient()

Deprecated. use AWSOrganizationsClientBuilder.defaultClient()

Constructs a new client to invoke service methods on Organizations. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSOrganizationsClient

@Deprecated
public AWSOrganizationsClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Organizations. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Organizations (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSOrganizationsClient

@Deprecated
public AWSOrganizationsClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSOrganizationsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on Organizations using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSOrganizationsClient

@Deprecated
public AWSOrganizationsClient(AWSCredentials awsCredentials,
                                          ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Organizations using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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.).

AWSOrganizationsClient

@Deprecated
public AWSOrganizationsClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on Organizations using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSOrganizationsClient

@Deprecated
public AWSOrganizationsClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Organizations using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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.).

AWSOrganizationsClient

@Deprecated
public AWSOrganizationsClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration,
                                          RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on Organizations using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 collector

Method Detail

builder

public static AWSOrganizationsClientBuilder builder()

acceptHandshake

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, the user must also have the iam:CreateServiceLinkedRole permission so that AWS Organizations can create the required service-linked role named AWSServiceRoleForOrganizations. 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's deleted.

Specified by:

acceptHandshake in interface AWSOrganizations

Parameters:

acceptHandshakeRequest -

Returns:

Result of the AcceptHandshake operation returned by the service.

Throws:

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 isn't 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.

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. Note that deleted and closed accounts still count toward your limit.

  If you get this exception immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.

• INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You can't issue new invitations to join an organization while it's 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.

• ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.

• 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.

• PAYMENT_INSTRUMENT_REQUIRED: You can't complete the operation with an account that doesn't have a payment instrument, such as a credit card, associated with it.

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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

AccessDeniedForDependencyException - The operation that you attempted requires you to have the iam:CreateServiceLinkedRole for organizations.amazonaws.com permission so that AWS Organizations can create the required service-linked role. You don't have that permission.

See Also:

AWS API Documentation

Samples:

• To accept a handshake from another account

  Bill is the owner of an organization, and he invites Juan's account (222222222222) to join his organization. The following example shows Juan's account accepting the handshake and thus agreeing to the invitation.
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  AcceptHandshakeRequest request = new AcceptHandshakeRequest().withHandshakeId("h-examplehandshakeid111");
  AcceptHandshakeResult response = client.acceptHandshake(request);

attachPolicy

public AttachPolicyResult attachPolicy(AttachPolicyRequest request)

Attaches a policy to a root, an organizational unit (OU), or an individual account.

How the policy affects accounts depends on the type of policy:

• For more information about attaching SCPs, see How SCPs Work in the AWS Organizations User Guide.

• For information about attaching tag policies, see How Policy Inheritance Works in the AWS Organizations User Guide.

This operation can be called only from the organization's master account.

Specified by:

attachPolicy in interface AWSOrganizations

Parameters:

attachPolicyRequest -

Returns:

Result of the AttachPolicy operation returned by the service.

Throws:

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 isn't 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. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.

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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 isn't currently enabled in this root. You can't 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

PolicyChangesInProgressException - Changes to the effective policy are in progress, and its contents can't be returned. Try the operation again later.

See Also:

AWS API Documentation

Samples:

• To attach a policy to an account

  The following example shows how to attach a service control policy (SCP) to an account:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  AttachPolicyRequest request = new AttachPolicyRequest().withPolicyId("p-examplepolicyid111").withTargetId("ou-examplerootid111-exampleouid111");
  AttachPolicyResult response = client.attachPolicy(request);AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  AttachPolicyRequest request = new AttachPolicyRequest().withPolicyId("p-examplepolicyid111").withTargetId("333333333333");
  AttachPolicyResult response = client.attachPolicy(request);

cancelHandshake

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's deleted.

Specified by:

cancelHandshake in interface AWSOrganizations

Parameters:

cancelHandshakeRequest -

Returns:

Result of the CancelHandshake operation returned by the service.

Throws:

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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To cancel a handshake sent to a member account

  Bill previously sent an invitation to Susan's account to join his organization. He changes his mind and decides to cancel the invitation before Susan accepts it. The following example shows Bill's cancellation:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  CancelHandshakeRequest request = new CancelHandshakeRequest().withHandshakeId("h-examplehandshakeid111");
  CancelHandshakeResult response = client.cancelHandshake(request);

createAccount

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. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:

• Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

• Check the AWS CloudTrail log for the CreateAccountResult event. For information on using AWS CloudTrail with AWS Organizations, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide.

The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.

AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) 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, the information required for the account to operate as a standalone account is not automatically collected. For example, information about the payment method and signing the end user license agreement (EULA) is not 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 as a member account in the AWS Organizations User Guide.

• If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support.

• If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support.

• Using CreateAccount to create multiple temporary accounts isn't recommended. You can only close an account from the Billing and Cost Management Console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an AWS Account 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 it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools.

Specified by:

createAccount in interface AWSOrganizations

Parameters:

createAccountRequest -

Returns:

Result of the CreateAccount operation returned by the service.

Throws:

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 isn't 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. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

FinalizingOrganizationException - AWS Organizations couldn't perform the operation because your organization hasn't finished initializing. This can take up to an hour. Try again later. If after one hour you continue to receive this error, contact AWS Support.

ServiceException - AWS Organizations can't complete your request because of an internal service error. Try again later.

TooManyRequestsException - You have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

See Also:

AWS API Documentation

Samples:

• To create a new account that is automatically part of the organization

  The owner of an organization creates a member account in the organization. The following example shows that when the organization owner creates the member account, the account is preconfigured with the name "Production Account" and an owner email address of [email protected]. An IAM role is automatically created using the default name because the roleName parameter is not used. AWS Organizations sends Susan a "Welcome to AWS" email:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  CreateAccountRequest request = new CreateAccountRequest().withEmail("[email protected]").withAccountName("Production Account");
  CreateAccountResult response = client.createAccount(request);

createGovCloudAccount

public CreateGovCloudAccountResult createGovCloudAccount(CreateGovCloudAccountRequest request)

This action is available if all of the following are true:

• You're authorized to create accounts in the AWS GovCloud (US) Region. For more information on the AWS GovCloud (US) Region, see the AWS GovCloud User Guide.

• You already have an account in the AWS GovCloud (US) Region that is associated with your master account in the commercial Region.

• You call this action from the master account of your organization in the commercial Region.

• You have the organizations:CreateGovCloudAccount permission. AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.

AWS automatically enables AWS CloudTrail for AWS GovCloud (US) accounts, but you should also do the following:

• Verify that AWS CloudTrail is enabled to store logs.

• Create an S3 bucket for AWS CloudTrail log storage.

  For more information, see Verifying AWS CloudTrail Is Enabled in the AWS GovCloud User Guide.

You call this action from the master account of your organization in the commercial Region to create a standalone AWS account in the AWS GovCloud (US) Region. After the account is created, the master account of an organization in the AWS GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the AWS GovCloud (US) to join an organization, see AWS Organizations in the AWS GovCloud User Guide.

Calling CreateGovCloudAccount is an asynchronous request that AWS performs in the background. Because CreateGovCloudAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:

• Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

• Check the AWS CloudTrail log for the CreateAccountResult event. For information on using AWS CloudTrail with Organizations, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide.

When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the AWS GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address.

A role is created in the new account in the commercial Region that allows the master account in the organization in the commercial Region to assume it. An AWS GovCloud (US) account is then created and associated with the commercial account that you just created. A role is created in the new AWS GovCloud (US) account. This role can be assumed by the AWS GovCloud (US) account that is associated with the master account of the commercial organization. For more information and to view a diagram that explains how account access works, see AWS Organizations in the AWS GovCloud User Guide.

For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.

• You can create an account in an organization using the AWS Organizations console, API, or CLI commands. When you do, the information required for the account to operate as a standalone account, such as a payment method, 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 as a member account in the AWS Organizations User Guide.

• If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support.

• If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support.

• Using CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the AWS Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an AWS Account 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 it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools.

Specified by:

createGovCloudAccount in interface AWSOrganizations

Parameters:

createGovCloudAccountRequest -

Returns:

Result of the CreateGovCloudAccount operation returned by the service.

Throws:

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 isn't 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. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

FinalizingOrganizationException - AWS Organizations couldn't perform the operation because your organization hasn't finished initializing. This can take up to an hour. Try again later. If after one hour you continue to receive this error, contact AWS Support.

ServiceException - AWS Organizations can't complete your request because of an internal service error. Try again later.

TooManyRequestsException - You have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

See Also:

AWS API Documentation

createOrganization

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. In addition, service control policies are automatically enabled in the root. If you instead create the organization supporting only the consolidated billing features, no policy types are enabled by default, and you can't use organization policies.

Specified by:

createOrganization in interface AWSOrganizations

Parameters:

createOrganizationRequest -

Returns:

Result of the CreateOrganization operation returned by the service.

Throws:

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. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

AccessDeniedForDependencyException - The operation that you attempted requires you to have the iam:CreateServiceLinkedRole for organizations.amazonaws.com permission so that AWS Organizations can create the required service-linked role. You don't have that permission.

See Also:

AWS API Documentation

Samples:

• To create a new organization with consolidated billing features only

  In the following example, Bill creates an organization using credentials from account 111111111111, and configures the organization to support only the consolidated billing feature set:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  CreateOrganizationRequest request = new CreateOrganizationRequest();
  CreateOrganizationResult response = client.createOrganization(request);AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  CreateOrganizationRequest request = new CreateOrganizationRequest().withFeatureSet("CONSOLIDATED_BILLING");
  CreateOrganizationResult response = client.createOrganization(request);

createOrganizationalUnit

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.

Specified by:

createOrganizationalUnit in interface AWSOrganizations

Parameters:

createOrganizationalUnitRequest -

Returns:

Result of the CreateOrganizationalUnit operation returned by the service.

Throws:

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 isn't 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. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.

DuplicateOrganizationalUnitException - An 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To create a new organization unit

  The following example shows how to create an OU that is named AccountingOU. The new OU is directly under the root.:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  CreateOrganizationalUnitRequest request = new CreateOrganizationalUnitRequest().withParentId("r-examplerootid111").withName("AccountingOU");
  CreateOrganizationalUnitResult response = client.createOrganizationalUnit(request);

createPolicy

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.

Specified by:

createPolicy in interface AWSOrganizations

Parameters:

createPolicyRequest -

Returns:

Result of the CreatePolicy operation returned by the service.

Throws:

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 isn't 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. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.

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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

MalformedPolicyDocumentException - The provided policy document doesn't 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 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

See Also:

AWS API Documentation

Samples:

• To create a service control policy

  The following example shows how to create a service control policy (SCP) that is named AllowAllS3Actions. The JSON string in the content parameter specifies the content in the policy. The parameter string is escaped with backslashes to ensure that the embedded double quotes in the JSON policy are treated as literals in the parameter, which itself is surrounded by double quotes:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  CreatePolicyRequest request = new CreatePolicyRequest()
          .withContent("{\\\"Version\\\":\\\"2012-10-17\\\",\\\"Statement\\\":{\\\"Effect\\\":\\\"Allow\\\",\\\"Action\\\":\\\"s3:*\\\"}}")
          .withDescription("Enables admins of attached accounts to delegate all S3 permissions").withName("AllowAllS3Actions")
          .withType("SERVICE_CONTROL_POLICY");
  CreatePolicyResult response = client.createPolicy(request);

declineHandshake

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 reinitiate the process with a new handshake request.

After you decline a handshake, it continues to appear in the results of relevant API operations for only 30 days. After that, it's deleted.

Specified by:

declineHandshake in interface AWSOrganizations

Parameters:

declineHandshakeRequest -

Returns:

Result of the DeclineHandshake operation returned by the service.

Throws:

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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To decline a handshake sent from the master account

  The following example shows Susan declining an invitation to join Bill's organization. The DeclineHandshake operation returns a handshake object, showing that the state is now DECLINED:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  DeclineHandshakeRequest request = new DeclineHandshakeRequest().withHandshakeId("h-examplehandshakeid111");
  DeclineHandshakeResult response = client.declineHandshake(request);

deleteOrganization

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.

Specified by:

deleteOrganization in interface AWSOrganizations

Parameters:

deleteOrganizationRequest -

Returns:

Result of the DeleteOrganization operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 OUs, and delete all policies.

ServiceException - AWS Organizations can't complete your request because of an internal service error. Try again later.

TooManyRequestsException - You have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

deleteOrganizationalUnit

public DeleteOrganizationalUnitResult deleteOrganizationalUnit(DeleteOrganizationalUnitRequest request)

Deletes an organizational unit (OU) 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.

Specified by:

deleteOrganizationalUnit in interface AWSOrganizations

Parameters:

deleteOrganizationalUnitRequest -

Returns:

Result of the DeleteOrganizationalUnit operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

OrganizationalUnitNotEmptyException - The specified OU is not empty. Move all accounts to another root or to other OUs, remove all child OUs, and try the operation again.

OrganizationalUnitNotFoundException - We can't find an 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To delete an organization unit

  The following example shows how to delete an OU. The example assumes that you previously removed all accounts and other OUs from the OU:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  DeleteOrganizationalUnitRequest request = new DeleteOrganizationalUnitRequest().withOrganizationalUnitId("ou-examplerootid111-exampleouid111");
  DeleteOrganizationalUnitResult response = client.deleteOrganizationalUnit(request);

deletePolicy

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 organizational units (OUs), roots, and accounts.

This operation can be called only from the organization's master account.

Specified by:

deletePolicy in interface AWSOrganizations

Parameters:

deletePolicyRequest -

Returns:

Result of the DeletePolicy operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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, 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

See Also:

AWS API Documentation

Samples:

• To delete a policy

  The following example shows how to delete a policy from an organization. The example assumes that you previously detached the policy from all entities:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  DeletePolicyRequest request = new DeletePolicyRequest().withPolicyId("p-examplepolicyid111");
  DeletePolicyResult response = client.deletePolicy(request);

describeAccount

public DescribeAccountResult describeAccount(DescribeAccountRequest request)

Retrieves AWS Organizations related information about the specified account.

This operation can be called only from the organization's master account.

Specified by:

describeAccount in interface AWSOrganizations

Parameters:

describeAccountRequest -

Returns:

Result of the DescribeAccount operation returned by the service.

Throws:

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 isn't a member of an organization.

AWSOrganizationsNotInUseException - Your account isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To get the details about an account

  The following example shows a user in the master account (111111111111) asking for details about account 555555555555:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  DescribeAccountRequest request = new DescribeAccountRequest().withAccountId("555555555555");
  DescribeAccountResult response = client.describeAccount(request);

describeCreateAccountStatus

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.

Specified by:

describeCreateAccountStatus in interface AWSOrganizations

Parameters:

describeCreateAccountStatusRequest -

Returns:

Result of the DescribeCreateAccountStatus operation returned by the service.

Throws:

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 isn't 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 a 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

See Also:

AWS API Documentation

Samples:

• To get information about a request to create an account

  The following example shows how to request the status about a previous request to create an account in an organization. This operation can be called only by a principal from the organization's master account. In the example, the specified "createAccountRequestId" comes from the response of the original call to "CreateAccount":
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  DescribeCreateAccountStatusRequest request = new DescribeCreateAccountStatusRequest().withCreateAccountRequestId("car-exampleaccountcreationrequestid");
  DescribeCreateAccountStatusResult response = client.describeCreateAccountStatus(request);

describeEffectivePolicy

public DescribeEffectivePolicyResult describeEffectivePolicy(DescribeEffectivePolicyRequest request)

Returns the contents of the effective tag policy for the account. The effective tag policy is the aggregation of any tag policies the account inherits, plus any policy directly that is attached to the account.

This action returns information on tag policies only.

For more information on policy inheritance, see How Policy Inheritance Works in the AWS Organizations User Guide.

This operation can be called from any account in the organization.

Specified by:

describeEffectivePolicy in interface AWSOrganizations

Parameters:

describeEffectivePolicyRequest -

Returns:

Result of the DescribeEffectivePolicy operation returned by the service.

Throws:

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 isn't a member of an organization. To make this request, you must use the credentials of an account that belongs to an organization.

ConstraintViolationException - Performing this operation violates a minimum or maximum value limit. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.

ServiceException - AWS Organizations can't complete your request because of an internal service error. Try again later.

TooManyRequestsException - You have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

TargetNotFoundException - We can't find a root, OU, or account with the TargetId that you specified.

EffectivePolicyNotFoundException - If you ran this action on the master account, this policy type is not enabled. If you ran the action on a member account, the account doesn't have an effective policy of this type. Contact the administrator of your organization about attaching a policy of this type to the account.

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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

See Also:

AWS API Documentation

describeHandshake

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're then deleted and no longer accessible.

This operation can be called from any account in the organization.

Specified by:

describeHandshake in interface AWSOrganizations

Parameters:

describeHandshakeRequest -

Returns:

Result of the DescribeHandshake operation returned by the service.

Throws:

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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To get information about a handshake

  The following example shows you how to request details about a handshake. The handshake ID comes either from the original call to "InviteAccountToOrganization", or from a call to "ListHandshakesForAccount" or "ListHandshakesForOrganization":
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  DescribeHandshakeRequest request = new DescribeHandshakeRequest().withHandshakeId("h-examplehandshakeid111");
  DescribeHandshakeResult response = client.describeHandshake(request);

describeOrganization

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.

Even if a policy type is shown as available in the organization, you can disable it separately at the root level with DisablePolicyType. Use ListRoots to see the status of policy types for a specified root.

Specified by:

describeOrganization in interface AWSOrganizations

Parameters:

describeOrganizationRequest -

Returns:

Result of the DescribeOrganization operation returned by the service.

Throws:

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 isn't 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To get information about an organization

  The following example shows how to request information about the current user's organization:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  DescribeOrganizationRequest request = new DescribeOrganizationRequest();
  DescribeOrganizationResult response = client.describeOrganization(request);

describeOrganizationalUnit

public DescribeOrganizationalUnitResult describeOrganizationalUnit(DescribeOrganizationalUnitRequest request)

Retrieves information about an organizational unit (OU).

This operation can be called only from the organization's master account.

Specified by:

describeOrganizationalUnit in interface AWSOrganizations

Parameters:

describeOrganizationalUnitRequest -

Returns:

Result of the DescribeOrganizationalUnit operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

OrganizationalUnitNotFoundException - We can't find an 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To get information about an organizational unit

  The following example shows how to request details about an OU:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  DescribeOrganizationalUnitRequest request = new DescribeOrganizationalUnitRequest().withOrganizationalUnitId("ou-examplerootid111-exampleouid111");
  DescribeOrganizationalUnitResult response = client.describeOrganizationalUnit(request);

describePolicy

public DescribePolicyResult describePolicy(DescribePolicyRequest request)

Retrieves information about a policy.

This operation can be called only from the organization's master account.

Specified by:

describePolicy in interface AWSOrganizations

Parameters:

describePolicyRequest -

Returns:

Result of the DescribePolicy operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

See Also:

AWS API Documentation

Samples:

• To get information about a policy

  The following example shows how to request information about a policy:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  DescribePolicyRequest request = new DescribePolicyRequest().withPolicyId("p-examplepolicyid111");
  DescribePolicyResult response = client.describePolicy(request);

detachPolicy

public DetachPolicyResult detachPolicy(DetachPolicyRequest request)

Detaches a policy from a target root, organizational unit (OU), 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. You can replace the default FullAWSAccess policy with one that limits the permissions that can be delegated. To do that, you must attach the replacement policy before you can remove the default one. This is the authorization strategy of using an allow list. You could instead attach a second SCP and leave the FullAWSAccess SCP still attached. You could then specify "Effect": "Deny" in the second SCP to override the "Effect": "Allow" in the FullAWSAccess policy (or any other attached SCP). If you take these steps, you're using the authorization strategy of a deny list.

This operation can be called only from the organization's master account.

Specified by:

detachPolicy in interface AWSOrganizations

Parameters:

detachPolicyRequest -

Returns:

Result of the DetachPolicy operation returned by the service.

Throws:

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 isn't 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. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

PolicyChangesInProgressException - Changes to the effective policy are in progress, and its contents can't be returned. Try the operation again later.

See Also:

AWS API Documentation

Samples:

• To detach a policy from a root, OU, or account

  The following example shows how to detach a policy from an OU:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  DetachPolicyRequest request = new DetachPolicyRequest().withPolicyId("p-examplepolicyid111").withTargetId("ou-examplerootid111-exampleouid111");
  DetachPolicyResult response = client.detachPolicy(request);

disableAWSServiceAccess

public DisableAWSServiceAccessResult disableAWSServiceAccess(DisableAWSServiceAccessRequest request)

Disables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you disable integration, the specified service no longer can create a service-linked role in new accounts in your organization. This means the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from AWS Organizations.

We recommend that you disable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service.

After you perform the DisableAWSServiceAccess operation, the specified service can no longer perform operations in your organization's accounts. The only exception is when the operations are explicitly permitted by IAM policies that are attached to your roles.

For more information about integrating other services with AWS Organizations, including the list of services that work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.

This operation can be called only from the organization's master account.

Specified by:

disableAWSServiceAccess in interface AWSOrganizations

Parameters:

disableAWSServiceAccessRequest -

Returns:

Result of the DisableAWSServiceAccess operation returned by the service.

Throws:

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 isn't 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. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

disablePolicyType

public DisablePolicyTypeResult disablePolicyType(DisablePolicyTypeRequest request)

Disables an organizational control policy type in a root and detaches all policies of that type from the organization root, OUs, and accounts. 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 organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation.

This is an asynchronous request that AWS performs in the background. If you disable a policy for a root, it still appears enabled for the organization if all features are enabled for the organization. AWS recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.

This operation can be called only from the organization's master account.

To view the status of available policy types in the organization, use DescribeOrganization.

Specified by:

disablePolicyType in interface AWSOrganizations

Parameters:

disablePolicyTypeRequest -

Returns:

Result of the DisablePolicyType operation returned by the service.

Throws:

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 isn't 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. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

PolicyTypeNotEnabledException - The specified policy type isn't currently enabled in this root. You can't 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

PolicyChangesInProgressException - Changes to the effective policy are in progress, and its contents can't be returned. Try the operation again later.

See Also:

AWS API Documentation

Samples:

• To disable a policy type in a root

  The following example shows how to disable the service control policy (SCP) policy type in a root. The response shows that the PolicyTypes response element no longer includes SERVICE_CONTROL_POLICY:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  DisablePolicyTypeRequest request = new DisablePolicyTypeRequest().withRootId("r-examplerootid111").withPolicyType("SERVICE_CONTROL_POLICY");
  DisablePolicyTypeResult response = client.disablePolicyType(request);

enableAWSServiceAccess

public EnableAWSServiceAccessResult enableAWSServiceAccess(EnableAWSServiceAccessRequest request)

Enables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you enable integration, you allow the specified service to create a service-linked role in all the accounts in your organization. This allows the service to perform operations on your behalf in your organization and its accounts.

We recommend that you enable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the service is aware that it can create the resources that are required for the integration. How the service creates those resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service.

For more information about enabling services to integrate with AWS Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.

This operation can be called only from the organization's master account and only if the organization has enabled all features.

Specified by:

enableAWSServiceAccess in interface AWSOrganizations

Parameters:

enableAWSServiceAccessRequest -

Returns:

Result of the EnableAWSServiceAccess operation returned by the service.

Throws:

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 isn't 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. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

enableAllFeatures

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. 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. 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. Accepting the handshake approves the change.

After you enable all features, you can separately enable or disable individual policy types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use ListRoots.

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.

Specified by:

enableAllFeatures in interface AWSOrganizations

Parameters:

enableAllFeaturesRequest -

Returns:

Result of the EnableAllFeatures operation returned by the service.

Throws:

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 isn't 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.

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. Note that deleted and closed accounts still count toward your limit.

  If you get this exception immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.

• INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You can't issue new invitations to join an organization while it's 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.

• ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.

• 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.

• PAYMENT_INSTRUMENT_REQUIRED: You can't complete the operation with an account that doesn't have a payment instrument, such as a credit card, associated with it.

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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To enable all features in an organization

  This example shows the administrator asking all the invited accounts in the organization to approve enabling all features in the organization. AWS Organizations sends an email to the address that is registered with every invited member account asking the owner to approve the change by accepting the handshake that is sent. After all invited member accounts accept the handshake, the organization administrator can finalize the change to enable all features, and those with appropriate permissions can create policies and apply them to roots, OUs, and accounts:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  EnableAllFeaturesRequest request = new EnableAllFeaturesRequest();
  EnableAllFeaturesResult response = client.enableAllFeatures(request);

enablePolicyType

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 organizational unit (OU), or account in that root. You can undo this by using the DisablePolicyType operation.

This is an asynchronous request that AWS performs in the background. AWS recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.

This operation can be called only from the organization's master account.

You can enable a policy type in a root only if that policy type is available in the organization. To view the status of available policy types in the organization, use DescribeOrganization.

Specified by:

enablePolicyType in interface AWSOrganizations

Parameters:

enablePolicyTypeRequest -

Returns:

Result of the EnablePolicyType operation returned by the service.

Throws:

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 isn't 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. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations 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 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.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

PolicyChangesInProgressException - Changes to the effective policy are in progress, and its contents can't be returned. Try the operation again later.

See Also:

AWS API Documentation

Samples:

• To enable a policy type in a root

  The following example shows how to enable the service control policy (SCP) policy type in a root. The output shows a root object with a PolicyTypes response element showing that SCPs are now enabled:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  EnablePolicyTypeRequest request = new EnablePolicyTypeRequest().withRootId("r-examplerootid111").withPolicyType("SERVICE_CONTROL_POLICY");
  EnablePolicyTypeResult response = client.enablePolicyType(request);

inviteAccountToOrganization

public InviteAccountToOrganizationResult inviteAccountToOrganization(InviteAccountToOrganizationRequest request)

Sends an invitation to another account to join your organization as a member account. AWS 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, assume that your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India. You can invite only other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS or from any other AWS seller. For more information, see Consolidated Billing in India.

• You might receive an exception that indicates that you exceeded your account limits for the organization or that the operation failed because your organization is still initializing. If so, wait one hour and then try again. If the error persists after an hour, contact AWS Support.

This operation can be called only from the organization's master account.

Specified by:

inviteAccountToOrganization in interface AWSOrganizations

Parameters:

inviteAccountToOrganizationRequest -

Returns:

Result of the InviteAccountToOrganization operation returned by the service.

Throws:

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 isn't a member of an organization. To make this request, you must use the credentials of an account that belongs to an organization.

AccountOwnerNotVerifiedException - You can't invite an existing account to your organization until you verify that you own the email address associated with the master account. For more information, see Email Address Verification in the AWS Organizations User Guide.

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.

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. Note that deleted and closed accounts still count toward your limit.

  If you get this exception immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.

• INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You can't issue new invitations to join an organization while it's 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.

• ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.

• 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.

• PAYMENT_INSTRUMENT_REQUIRED: You can't complete the operation with an account that doesn't have a payment instrument, such as a credit card, associated with it.

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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

FinalizingOrganizationException - AWS Organizations couldn't perform the operation because your organization hasn't finished initializing. This can take up to an hour. Try again later. If after one hour you continue to receive this error, contact AWS Support.

ServiceException - AWS Organizations can't complete your request because of an internal service error. Try again later.

TooManyRequestsException - You have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To invite an account to join an organization

  The following example shows the admin of the master account owned by [email protected] inviting the account owned by [email protected] to join an organization.
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  InviteAccountToOrganizationRequest request = new InviteAccountToOrganizationRequest().withTarget(
          new HandshakeParty().withId("[email protected]").withType("EMAIL"))
          .withNotes("This is a request for Juan's account to join Bill's organization");
  InviteAccountToOrganizationResult response = client.inviteAccountToOrganization(request);

leaveOrganization

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. These restrictions can include preventing member accounts from successfully calling LeaveOrganization.

• 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, 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). You must also 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 isn't 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.

Specified by:

leaveOrganization in interface AWSOrganizations

Parameters:

leaveOrganizationRequest -

Returns:

Result of the LeaveOrganization operation returned by the service.

Throws:

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 isn't a member of an organization.

AWSOrganizationsNotInUseException - Your account isn't 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. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To leave an organization as a member account

  TThe following example shows how to remove your member account from an organization:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  LeaveOrganizationRequest request = new LeaveOrganizationRequest();
  LeaveOrganizationResult response = client.leaveOrganization(request);

listAWSServiceAccessForOrganization

public ListAWSServiceAccessForOrganizationResult listAWSServiceAccessForOrganization(ListAWSServiceAccessForOrganizationRequest request)

Returns a list of the AWS services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts.

For more information about integrating other services with AWS Organizations, including the list of services that currently work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.

This operation can be called only from the organization's master account.

Specified by:

listAWSServiceAccessForOrganization in interface AWSOrganizations

Parameters:

listAWSServiceAccessForOrganizationRequest -

Returns:

Result of the ListAWSServiceAccessForOrganization operation returned by the service.

Throws:

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 isn't a member of an organization. To make this request, you must use the credentials of an account that belongs to an organization.

ConstraintViolationException - Performing this operation violates a minimum or maximum value limit. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

listAccounts

public ListAccountsResult listAccounts(ListAccountsRequest request)

Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the ListAccountsForParent operation instead.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

Specified by:

listAccounts in interface AWSOrganizations

Parameters:

listAccountsRequest -

Returns:

Result of the ListAccounts operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To retrieve a list of all of the accounts in an organization

  The following example shows you how to request a list of the accounts in an organization:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  ListAccountsRequest request = new ListAccountsRequest();
  ListAccountsResult response = client.listAccounts(request);

listAccountsForParent

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 aren't 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.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

Specified by:

listAccountsForParent in interface AWSOrganizations

Parameters:

listAccountsForParentRequest -

Returns:

Result of the ListAccountsForParent operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To retrieve a list of all of the accounts in a root or OU

  The following example shows how to request a list of the accounts in an OU:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  ListAccountsForParentRequest request = new ListAccountsForParentRequest().withParentId("ou-examplerootid111-exampleouid111");
  ListAccountsForParentResult response = client.listAccountsForParent(request);

listChildren

public ListChildrenResult listChildren(ListChildrenRequest request)

Lists all of the organizational units (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.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

Specified by:

listChildren in interface AWSOrganizations

Parameters:

listChildrenRequest -

Returns:

Result of the ListChildren operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To retrieve a list of all of the child accounts and OUs in a parent root or OU

  The following example shows how to request a list of the child OUs in a parent root or OU:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  ListChildrenRequest request = new ListChildrenRequest().withParentId("ou-examplerootid111-exampleouid111").withChildType("ORGANIZATIONAL_UNIT");
  ListChildrenResult response = client.listChildren(request);

listCreateAccountStatus

public ListCreateAccountStatusResult listCreateAccountStatus(ListCreateAccountStatusRequest request)

Lists the account creation requests that match the specified status that is currently being tracked for the organization.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

Specified by:

listCreateAccountStatus in interface AWSOrganizations

Parameters:

listCreateAccountStatusRequest -

Returns:

Result of the ListCreateAccountStatus operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

See Also:

AWS API Documentation

Samples:

• To get a list of all account creation requests made in the organization

  The following example shows a user requesting a list of only the in-progress account creation requests made for the current organization:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  ListCreateAccountStatusRequest request = new ListCreateAccountStatusRequest().withStates("SUCCEEDED");
  ListCreateAccountStatusResult response = client.listCreateAccountStatus(request);AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  ListCreateAccountStatusRequest request = new ListCreateAccountStatusRequest().withStates("IN_PROGRESS");
  ListCreateAccountStatusResult response = client.listCreateAccountStatus(request);

listHandshakesForAccount

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're deleted and no longer accessible.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called from any account in the organization.

Specified by:

listHandshakesForAccount in interface AWSOrganizations

Parameters:

listHandshakesForAccountRequest -

Returns:

Result of the ListHandshakesForAccount operation returned by the service.

Throws:

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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To retrieve a list of the handshakes sent to an account

  The following example shows you how to get a list of handshakes that are associated with the account of the credentials used to call the operation:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  ListHandshakesForAccountRequest request = new ListHandshakesForAccountRequest();
  ListHandshakesForAccountResult response = client.listHandshakesForAccount(request);

listHandshakesForOrganization

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're deleted and no longer accessible.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

Specified by:

listHandshakesForOrganization in interface AWSOrganizations

Parameters:

listHandshakesForOrganizationRequest -

Returns:

Result of the ListHandshakesForOrganization operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To retrieve a list of the handshakes associated with an organization

  The following example shows you how to get a list of handshakes associated with the current organization:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  ListHandshakesForOrganizationRequest request = new ListHandshakesForOrganizationRequest();
  ListHandshakesForOrganizationResult response = client.listHandshakesForOrganization(request);

listOrganizationalUnitsForParent

public ListOrganizationalUnitsForParentResult listOrganizationalUnitsForParent(ListOrganizationalUnitsForParentRequest request)

Lists the organizational units (OUs) in a parent organizational unit or root.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

Specified by:

listOrganizationalUnitsForParent in interface AWSOrganizations

Parameters:

listOrganizationalUnitsForParentRequest -

Returns:

Result of the ListOrganizationalUnitsForParent operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To retrieve a list of all of the child OUs in a parent root or OU

  The following example shows how to get a list of OUs in a specified root:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  ListOrganizationalUnitsForParentRequest request = new ListOrganizationalUnitsForParentRequest().withParentId("r-examplerootid111");
  ListOrganizationalUnitsForParentResult response = client.listOrganizationalUnitsForParent(request);

listParents

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.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

In the current release, a child can have only a single parent.

Specified by:

listParents in interface AWSOrganizations

Parameters:

listParentsRequest -

Returns:

Result of the ListParents operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To retrieve a list of all of the parents of a child OU or account

  The following example shows how to list the root or OUs that contain account 444444444444:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  ListParentsRequest request = new ListParentsRequest().withChildId("444444444444");
  ListParentsResult response = client.listParents(request);

listPolicies

public ListPoliciesResult listPolicies(ListPoliciesRequest request)

Retrieves the list of all policies in an organization of a specified type.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

Specified by:

listPolicies in interface AWSOrganizations

Parameters:

listPoliciesRequest -

Returns:

Result of the ListPolicies operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

See Also:

AWS API Documentation

Samples:

• To retrieve a list policies in the organization

  The following example shows how to get a list of service control policies (SCPs):/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  ListPoliciesRequest request = new ListPoliciesRequest().withFilter("SERVICE_CONTROL_POLICY");
  ListPoliciesResult response = client.listPolicies(request);

listPoliciesForTarget

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.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

Specified by:

listPoliciesForTarget in interface AWSOrganizations

Parameters:

listPoliciesForTargetRequest -

Returns:

Result of the ListPoliciesForTarget operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

See Also:

AWS API Documentation

Samples:

• To retrieve a list policies attached to a root, OU, or account

  The following example shows how to get a list of all service control policies (SCPs) of the type specified by the Filter parameter, that are directly attached to an account. The returned list does not include policies that apply to the account because of inheritance from its location in an OU hierarchy:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  ListPoliciesForTargetRequest request = new ListPoliciesForTargetRequest().withTargetId("444444444444").withFilter("SERVICE_CONTROL_POLICY");
  ListPoliciesForTargetResult response = client.listPoliciesForTarget(request);

listRoots

public ListRootsResult listRoots(ListRootsRequest request)

Lists the roots that are defined in the current organization.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

Policy types can be enabled and disabled in roots. This is distinct from whether they're available in the organization. When you enable all features, you make policy types available for use in that organization. Individual policy types can then be enabled and disabled in a root. To see the availability of a policy type in an organization, use DescribeOrganization.

Specified by:

listRoots in interface AWSOrganizations

Parameters:

listRootsRequest -

Returns:

Result of the ListRoots operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To retrieve a list of roots in the organization

  The following example shows how to get the list of the roots in the current organization:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  ListRootsRequest request = new ListRootsRequest();
  ListRootsResult response = client.listRoots(request);

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists tags for the specified resource.

Currently, you can list tags on an account in AWS Organizations.

This operation can be called only from the organization's master account.

Specified by:

listTagsForResource in interface AWSOrganizations

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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 isn't a member of an organization. To make this request, you must use the credentials of an account that belongs to an organization.

TargetNotFoundException - We can't find a root, OU, or account with the TargetId 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

listTargetsForPolicy

public ListTargetsForPolicyResult listTargetsForPolicy(ListTargetsForPolicyRequest request)

Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

Specified by:

listTargetsForPolicy in interface AWSOrganizations

Parameters:

listTargetsForPolicyRequest -

Returns:

Result of the ListTargetsForPolicy operation returned by the service.

Throws:

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 isn't 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

See Also:

AWS API Documentation

Samples:

• To retrieve a list of roots, OUs, and accounts to which a policy is attached

  The following example shows how to get the list of roots, OUs, and accounts to which the specified policy is attached:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  ListTargetsForPolicyRequest request = new ListTargetsForPolicyRequest().withPolicyId("p-FullAWSAccess");
  ListTargetsForPolicyResult response = client.listTargetsForPolicy(request);

moveAccount

public MoveAccountResult moveAccount(MoveAccountRequest request)

Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU.

This operation can be called only from the organization's master account.

Specified by:

moveAccount in interface AWSOrganizations

Parameters:

moveAccountRequest -

Returns:

Result of the MoveAccount operation returned by the service.

Throws:

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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 isn't a member of an organization.

TooManyRequestsException - You have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

ConcurrentModificationException - The target of the operation is currently being modified by a different request. Try again later.

AWSOrganizationsNotInUseException - Your account isn't 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.

See Also:

AWS API Documentation

Samples:

• To move an OU or account to another OU or the root

  The following example shows how to move a member account from the root to an OU:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  MoveAccountRequest request = new MoveAccountRequest().withAccountId("333333333333").withSourceParentId("r-examplerootid111")
          .withDestinationParentId("ou-examplerootid111-exampleouid111");
  MoveAccountResult response = client.moveAccount(request);

removeAccountFromOrganization

public RemoveAccountFromOrganizationResult removeAccountFromOrganization(RemoveAccountFromOrganizationRequest request)

Removes the specified account from the organization.

The removed account becomes a standalone account that isn't a member of any organization. It's 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's 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, 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). You must also 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 isn't attached to an organization. To remove an account that doesn't yet have this information, you must sign in as the member account. Then follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

Specified by:

removeAccountFromOrganization in interface AWSOrganizations

Parameters:

removeAccountFromOrganizationRequest -

Returns:

Result of the RemoveAccountFromOrganization operation returned by the service.

Throws:

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 isn't a member of an organization.

AWSOrganizationsNotInUseException - Your account isn't 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. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To remove an account from an organization as the master account

  The following example shows you how to remove an account from an organization:
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  RemoveAccountFromOrganizationRequest request = new RemoveAccountFromOrganizationRequest().withAccountId("333333333333");
  RemoveAccountFromOrganizationResult response = client.removeAccountFromOrganization(request);

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds one or more tags to the specified resource.

Currently, you can tag and untag accounts in AWS Organizations.

This operation can be called only from the organization's master account.

Specified by:

tagResource in interface AWSOrganizations

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

AWSOrganizationsNotInUseException - Your account isn't a member of an organization. To make this request, you must use the credentials of an account that belongs to an organization.

TargetNotFoundException - We can't find a root, OU, or account with the TargetId that you specified.

ConstraintViolationException - Performing this operation violates a minimum or maximum value limit. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes a tag from the specified resource.

Currently, you can tag and untag accounts in AWS Organizations.

This operation can be called only from the organization's master account.

Specified by:

untagResource in interface AWSOrganizations

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

AWSOrganizationsNotInUseException - Your account isn't a member of an organization. To make this request, you must use the credentials of an account that belongs to an organization.

TargetNotFoundException - We can't find a root, OU, or account with the TargetId that you specified.

ConstraintViolationException - Performing this operation violates a minimum or maximum value limit. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

updateOrganizationalUnit

public UpdateOrganizationalUnitResult updateOrganizationalUnit(UpdateOrganizationalUnitRequest request)

Renames the specified organizational unit (OU). The ID and ARN don't 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.

Specified by:

updateOrganizationalUnit in interface AWSOrganizations

Parameters:

updateOrganizationalUnitRequest -

Returns:

Result of the UpdateOrganizationalUnit operation returned by the service.

Throws:

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 isn't 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 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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

OrganizationalUnitNotFoundException - We can't find an 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

See Also:

AWS API Documentation

Samples:

• To rename an organizational unit

  The following example shows how to rename an OU. The output confirms the new name:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  UpdateOrganizationalUnitRequest request = new UpdateOrganizationalUnitRequest().withOrganizationalUnitId("ou-examplerootid111-exampleouid111")
          .withName("AccountingOU");
  UpdateOrganizationalUnitResult response = client.updateOrganizationalUnit(request);

updatePolicy

public UpdatePolicyResult updatePolicy(UpdatePolicyRequest request)

Updates an existing policy with a new name, description, or content. If you don't supply any parameter, that value remains unchanged. You can't change a policy's type.

This operation can be called only from the organization's master account.

Specified by:

updatePolicy in interface AWSOrganizations

Parameters:

updatePolicyRequest -

Returns:

Result of the UpdatePolicy operation returned by the service.

Throws:

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 isn't 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. Examples include attempting to remove the last service control policy (SCP) from an OU or root, 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_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone 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 doesn't yet have enough information to exist as a standalone 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.

• ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

• 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.

  Deleted and closed accounts still count toward your limit.

  If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

• HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send 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.

• MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid 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.

• 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.

• MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

• MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid 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.

• MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity, which would cause the entity to have fewer than the minimum number of policies of the required type.

• OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

• ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

• OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

• POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.

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:

Some of the reasons in the following list might not be applicable to this specific API or operation:

• IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

• INPUT_REQUIRED: You must include a value for all required parameters.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type.

• 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.

• INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

• INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

• 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.

• INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

• INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

• INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

• MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

• 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.

• MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

MalformedPolicyDocumentException - The provided policy document doesn't 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 have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

UnsupportedAPIEndpointException - This action isn't available in the current Region.

PolicyChangesInProgressException - Changes to the effective policy are in progress, and its contents can't be returned. Try the operation again later.

See Also:

AWS API Documentation

Samples:

• To update the content of a policy

  The following example shows how to replace the JSON text of the SCP from the preceding example with a new JSON policy text string that allows S3 actions instead of EC2 actions:/n/n
  

  AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  UpdatePolicyRequest request = new UpdatePolicyRequest().withPolicyId("p-examplepolicyid111").withName("Renamed-Policy")
          .withDescription("This description replaces the original.");
  UpdatePolicyResult response = client.updatePolicy(request);AWSOrganizations client = AWSOrganizationsClientBuilder.standard().build();
  UpdatePolicyRequest request = new UpdatePolicyRequest()
          .withPolicyId("p-examplepolicyid111")
          .withContent(
                  "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": {\\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }");
  UpdatePolicyResult response = client.updatePolicy(request);

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:

getCachedResponseMetadata in interface AWSOrganizations

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.