AcceptHandshake

$result = $client->acceptHandshake([/* ... */]);
$promise = $client->acceptHandshakeAsync([/* ... */]);

Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.

You can only call this operation 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 Organizations can create the required service-linked role named AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the Organizations User Guide.

• Enable all features final confirmation handshake: only a principal from the management account.

  For more information about invitations, see Inviting an Amazon Web Services account to join your organization in the Organizations User Guide. For more information about requests to enable all features in the organization, see Enabling all features in your organization in the 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.

Parameter Syntax

$result = $client->acceptHandshake([
    'HandshakeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Handshake' => [
        'Action' => 'INVITE|ENABLE_ALL_FEATURES|APPROVE_ALL_FEATURES|ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
        'Arn' => '<string>',
        'ExpirationTimestamp' => <DateTime>,
        'Id' => '<string>',
        'Parties' => [
            [
                'Id' => '<string>',
                'Type' => 'ACCOUNT|ORGANIZATION|EMAIL',
            ],
            // ...
        ],
        'RequestedTimestamp' => <DateTime>,
        'Resources' => [
            [
                'Resources' => [...], // RECURSIVE
                'Type' => 'ACCOUNT|ORGANIZATION|ORGANIZATION_FEATURE_SET|EMAIL|MASTER_EMAIL|MASTER_NAME|NOTES|PARENT_HANDSHAKE',
                'Value' => '<string>',
            ],
            // ...
        ],
        'State' => 'REQUESTED|OPEN|CANCELED|ACCEPTED|DECLINED|EXPIRED',
    ],
]

Result Details

Errors

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 Amazon Web Services 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_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION: The handshake request is invalid because the organization has already started the process to enable 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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

ConcurrentModificationException:

The target of the operation is currently being modified by a different request. Try again later.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

AccessDeniedForDependencyException:

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

Examples

Example 1: 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.

$result = $client->acceptHandshake([
    'HandshakeId' => 'h-examplehandshakeid111',
]);

Result syntax:

[
    'Handshake' => [
        'Action' => 'INVITE',
        'Arn' => 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
        'ExpirationTimestamp' => ,
        'Id' => 'h-examplehandshakeid111',
        'Parties' => [
            [
                'Id' => 'o-exampleorgid',
                'Type' => 'ORGANIZATION',
            ],
            [
                'Id' => 'juan@example.com',
                'Type' => 'EMAIL',
            ],
        ],
        'RequestedTimestamp' => ,
        'Resources' => [
            [
                'Resources' => [
                    [
                        'Type' => 'MASTER_EMAIL',
                        'Value' => 'bill@amazon.com',
                    ],
                    [
                        'Type' => 'MASTER_NAME',
                        'Value' => 'Org Master Account',
                    ],
                    [
                        'Type' => 'ORGANIZATION_FEATURE_SET',
                        'Value' => 'ALL',
                    ],
                ],
                'Type' => 'ORGANIZATION',
                'Value' => 'o-exampleorgid',
            ],
            [
                'Type' => 'ACCOUNT',
                'Value' => '222222222222',
            ],
        ],
        'State' => 'ACCEPTED',
    ],
]

AttachPolicy

$result = $client->attachPolicy([/* ... */]);
$promise = $client->attachPolicyAsync([/* ... */]);

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. Refer to the Organizations User Guide for information about each policy type:

• SERVICE_CONTROL_POLICY

• BACKUP_POLICY

• TAG_POLICY

• CHATBOT_POLICY

• AISERVICES_OPT_OUT_POLICY

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Parameter Syntax

$result = $client->attachPolicy([
    'PolicyId' => '<string>', // REQUIRED
    'TargetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

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 Organizations User Guide.

ServiceException:

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

TargetNotFoundException:

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

TooManyRequestsException:

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

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

PolicyChangesInProgressException:

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

Examples

Example 1: To attach a policy to an OU

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

$result = $client->attachPolicy([
    'PolicyId' => 'p-examplepolicyid111',
    'TargetId' => 'ou-examplerootid111-exampleouid111',
]);

Example 2: To attach a policy to an account

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

$result = $client->attachPolicy([
    'PolicyId' => 'p-examplepolicyid111',
    'TargetId' => '333333333333',
]);

CancelHandshake

$result = $client->cancelHandshake([/* ... */]);
$promise = $client->cancelHandshakeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->cancelHandshake([
    'HandshakeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Handshake' => [
        'Action' => 'INVITE|ENABLE_ALL_FEATURES|APPROVE_ALL_FEATURES|ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
        'Arn' => '<string>',
        'ExpirationTimestamp' => <DateTime>,
        'Id' => '<string>',
        'Parties' => [
            [
                'Id' => '<string>',
                'Type' => 'ACCOUNT|ORGANIZATION|EMAIL',
            ],
            // ...
        ],
        'RequestedTimestamp' => <DateTime>,
        'Resources' => [
            [
                'Resources' => [...], // RECURSIVE
                'Type' => 'ACCOUNT|ORGANIZATION|ORGANIZATION_FEATURE_SET|EMAIL|MASTER_EMAIL|MASTER_NAME|NOTES|PARENT_HANDSHAKE',
                'Value' => '<string>',
            ],
            // ...
        ],
        'State' => 'REQUESTED|OPEN|CANCELED|ACCEPTED|DECLINED|EXPIRED',
    ],
]

Result Details

Errors

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

Examples

Example 1: 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:

$result = $client->cancelHandshake([
    'HandshakeId' => 'h-examplehandshakeid111',
]);

Result syntax:

[
    'Handshake' => [
        'Action' => 'INVITE',
        'Arn' => 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
        'ExpirationTimestamp' => ,
        'Id' => 'h-examplehandshakeid111',
        'Parties' => [
            [
                'Id' => 'o-exampleorgid',
                'Type' => 'ORGANIZATION',
            ],
            [
                'Id' => 'susan@example.com',
                'Type' => 'EMAIL',
            ],
        ],
        'RequestedTimestamp' => ,
        'Resources' => [
            [
                'Resources' => [
                    [
                        'Type' => 'MASTER_EMAIL',
                        'Value' => 'bill@example.com',
                    ],
                    [
                        'Type' => 'MASTER_NAME',
                        'Value' => 'Master Account',
                    ],
                    [
                        'Type' => 'ORGANIZATION_FEATURE_SET',
                        'Value' => 'CONSOLIDATED_BILLING',
                    ],
                ],
                'Type' => 'ORGANIZATION',
                'Value' => 'o-exampleorgid',
            ],
            [
                'Type' => 'ACCOUNT',
                'Value' => '222222222222',
            ],
            [
                'Type' => 'NOTES',
                'Value' => 'This is a request for Susan's account to join Bob's organization.',
            ],
        ],
        'State' => 'CANCELED',
    ],
]

CloseAccount

$result = $client->closeAccount([/* ... */]);
$promise = $client->closeAccountAsync([/* ... */]);

Closes an Amazon Web Services member account within an organization. You can close an account when all features are enabled . You can't close the management account with this API. This is an asynchronous request that Amazon Web Services performs in the background. Because CloseAccount operates asynchronously, it can return a successful completion message even though account closure might still be in progress. You need to wait a few minutes before the account is fully closed. To check the status of the request, do one of the following:

• Use the AccountId that you sent in the CloseAccount request to provide as a parameter to the DescribeAccount operation.

  While the close account request is in progress, Account status will indicate PENDING_CLOSURE. When the close account request completes, the status will change to SUSPENDED.

• Check the CloudTrail log for the CloseAccountResult event that gets published after the account closes successfully. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide.

Parameter Syntax

$result = $client->closeAccount([
    'AccountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

AccountAlreadyClosedException:

You attempted to close an account that is already closed.

AccountNotFoundException:

We can't find an Amazon Web Services 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.

ConflictException:

The request failed because it conflicts with the current state of the specified resource.

ConstraintViolationException:

Performing this operation violates a minimum or maximum value limit. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

CreateAccount

$result = $client->createAccount([/* ... */]);
$promise = $client->createAccountAsync([/* ... */]);

Creates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that Amazon Web Services 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 Id value of the CreateAccountStatus response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

• Check the CloudTrail log for the CreateAccountResult event. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the 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, Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the Organizations User Guide.

If the request includes tags, then the requester must have the organizations:TagResource permission.

Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. Organizations clones the company name and address information for the new account from the organization's management account.

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

For more information about creating accounts, see Creating a member account in your organization in the Organizations User Guide.

Parameter Syntax

$result = $client->createAccount([
    'AccountName' => '<string>', // REQUIRED
    'Email' => '<string>', // REQUIRED
    'IamUserAccessToBilling' => 'ALLOW|DENY',
    'RoleName' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'CreateAccountStatus' => [
        'AccountId' => '<string>',
        'AccountName' => '<string>',
        'CompletedTimestamp' => <DateTime>,
        'FailureReason' => 'ACCOUNT_LIMIT_EXCEEDED|EMAIL_ALREADY_EXISTS|INVALID_ADDRESS|INVALID_EMAIL|CONCURRENT_ACCOUNT_MODIFICATION|INTERNAL_FAILURE|GOVCLOUD_ACCOUNT_ALREADY_EXISTS|MISSING_BUSINESS_VALIDATION|FAILED_BUSINESS_VALIDATION|PENDING_BUSINESS_VALIDATION|INVALID_IDENTITY_FOR_BUSINESS_VALIDATION|UNKNOWN_BUSINESS_VALIDATION|MISSING_PAYMENT_INSTRUMENT|INVALID_PAYMENT_INSTRUMENT|UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED',
        'GovCloudAccountId' => '<string>',
        'Id' => '<string>',
        'RequestedTimestamp' => <DateTime>,
        'State' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    ],
]

Result Details

Errors

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. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

FinalizingOrganizationException:

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 Amazon Web Services Support.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

Examples

Example 1: 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 susan@example.com. 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:

$result = $client->createAccount([
    'AccountName' => 'Production Account',
    'Email' => 'susan@example.com',
]);

Result syntax:

[
    'CreateAccountStatus' => [
        'Id' => 'car-examplecreateaccountrequestid111',
        'State' => 'IN_PROGRESS',
    ],
]

CreateGovCloudAccount

$result = $client->createGovCloudAccount([/* ... */]);
$promise = $client->createGovCloudAccountAsync([/* ... */]);

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

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

• You already have an account in the Amazon Web Services GovCloud (US) Region that is paired with a management account of an organization in the commercial Region.

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

• You have the organizations:CreateGovCloudAccount permission.

Organizations automatically creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the Organizations User Guide.

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

• Verify that CloudTrail is enabled to store logs.

• Create an Amazon S3 bucket for CloudTrail log storage.

  For more information, see Verifying CloudTrail Is Enabled in the Amazon Web Services GovCloud User Guide.

If the request includes tags, then the requester must have the organizations:TagResource permission. The tags are attached to the commercial account associated with the GovCloud account, rather than the GovCloud account itself. To add tags to the GovCloud account, call the TagResource operation in the GovCloud Region after the new GovCloud account exists.

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

Calling CreateGovCloudAccount is an asynchronous request that Amazon Web Services 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 CloudTrail log for the CreateAccountResult event. For information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the Organizations User Guide.

When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the Amazon Web Services 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 management account in the organization in the commercial Region to assume it. An Amazon Web Services GovCloud (US) account is then created and associated with the commercial account that you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can be assumed by the Amazon Web Services GovCloud (US) account that is associated with the management account of the commercial organization. For more information and to view a diagram that explains how account access works, see Organizations in the Amazon Web Services GovCloud User Guide.

For more information about creating accounts, see Creating a member account in your organization in the Organizations User Guide.

Parameter Syntax

$result = $client->createGovCloudAccount([
    'AccountName' => '<string>', // REQUIRED
    'Email' => '<string>', // REQUIRED
    'IamUserAccessToBilling' => 'ALLOW|DENY',
    'RoleName' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'CreateAccountStatus' => [
        'AccountId' => '<string>',
        'AccountName' => '<string>',
        'CompletedTimestamp' => <DateTime>,
        'FailureReason' => 'ACCOUNT_LIMIT_EXCEEDED|EMAIL_ALREADY_EXISTS|INVALID_ADDRESS|INVALID_EMAIL|CONCURRENT_ACCOUNT_MODIFICATION|INTERNAL_FAILURE|GOVCLOUD_ACCOUNT_ALREADY_EXISTS|MISSING_BUSINESS_VALIDATION|FAILED_BUSINESS_VALIDATION|PENDING_BUSINESS_VALIDATION|INVALID_IDENTITY_FOR_BUSINESS_VALIDATION|UNKNOWN_BUSINESS_VALIDATION|MISSING_PAYMENT_INSTRUMENT|INVALID_PAYMENT_INSTRUMENT|UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED',
        'GovCloudAccountId' => '<string>',
        'Id' => '<string>',
        'RequestedTimestamp' => <DateTime>,
        'State' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    ],
]

Result Details

Errors

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. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

FinalizingOrganizationException:

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 Amazon Web Services Support.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

CreateOrganization

$result = $client->createOrganization([/* ... */]);
$promise = $client->createOrganizationAsync([/* ... */]);

Creates an Amazon Web Services organization. The account whose user is calling the CreateOrganization operation automatically becomes the management account of the new organization.

This operation must be called using credentials from the account that is to become the new organization's management account. The principal must also have the relevant IAM permissions.

By default (or if you set the FeatureSet parameter to ALL), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the FeatureSet parameter to CONSOLIDATED_BILLING, no policy types are enabled by default and you can't use organization policies.

Parameter Syntax

$result = $client->createOrganization([
    'FeatureSet' => 'ALL|CONSOLIDATED_BILLING',
]);

Parameter Details

Result Syntax

[
    'Organization' => [
        'Arn' => '<string>',
        'AvailablePolicyTypes' => [
            [
                'Status' => 'ENABLED|PENDING_ENABLE|PENDING_DISABLE',
                'Type' => 'SERVICE_CONTROL_POLICY|TAG_POLICY|BACKUP_POLICY|AISERVICES_OPT_OUT_POLICY|CHATBOT_POLICY',
            ],
            // ...
        ],
        'FeatureSet' => 'ALL|CONSOLIDATED_BILLING',
        'Id' => '<string>',
        'MasterAccountArn' => '<string>',
        'MasterAccountEmail' => '<string>',
        'MasterAccountId' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

AlreadyInOrganizationException:

This account is already a member of an organization. An account can belong to only one organization at a time.

ConcurrentModificationException:

The target of the operation is currently being modified by a different request. Try again later.

ConstraintViolationException:

Performing this operation violates a minimum or maximum value limit. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

AccessDeniedForDependencyException:

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

Examples

Example 1: To create a new organization with all features enabled

Bill wants to create an organization using credentials from account 111111111111. The following example shows that the account becomes the master account in the new organization. Because he does not specify a feature set, the new organization defaults to all features enabled and service control policies enabled on the root:

$result = $client->createOrganization([
]);

Result syntax:

[
    'Organization' => [
        'Arn' => 'arn:aws:organizations::111111111111:organization/o-exampleorgid',
        'AvailablePolicyTypes' => [
            [
                'Status' => 'ENABLED',
                'Type' => 'SERVICE_CONTROL_POLICY',
            ],
        ],
        'FeatureSet' => 'ALL',
        'Id' => 'o-exampleorgid',
        'MasterAccountArn' => 'arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111',
        'MasterAccountEmail' => 'bill@example.com',
        'MasterAccountId' => '111111111111',
    ],
]

Example 2: 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:

$result = $client->createOrganization([
    'FeatureSet' => 'CONSOLIDATED_BILLING',
]);

Result syntax:

[
    'Organization' => [
        'Arn' => 'arn:aws:organizations::111111111111:organization/o-exampleorgid',
        'AvailablePolicyTypes' => [
        ],
        'FeatureSet' => 'CONSOLIDATED_BILLING',
        'Id' => 'o-exampleorgid',
        'MasterAccountArn' => 'arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111',
        'MasterAccountEmail' => 'bill@example.com',
        'MasterAccountId' => '111111111111',
    ],
]

CreateOrganizationalUnit

$result = $client->createOrganizationalUnit([/* ... */]);
$promise = $client->createOrganizationalUnitAsync([/* ... */]);

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 (OUs) in the Organizations User Guide.

If the request includes tags, then the requester must have the organizations:TagResource permission.

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

Parameter Syntax

$result = $client->createOrganizationalUnit([
    'Name' => '<string>', // REQUIRED
    'ParentId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'OrganizationalUnit' => [
        'Arn' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

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. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

ParentNotFoundException:

We can't find a root or OU with the ParentId that you specified.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

Examples

Example 1: 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.:

$result = $client->createOrganizationalUnit([
    'Name' => 'AccountingOU',
    'ParentId' => 'r-examplerootid111',
]);

Result syntax:

[
    'OrganizationalUnit' => [
        'Arn' => 'arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111',
        'Id' => 'ou-examplerootid111-exampleouid111',
        'Name' => 'AccountingOU',
    ],
]

CreatePolicy

$result = $client->createPolicy([/* ... */]);
$promise = $client->createPolicyAsync([/* ... */]);

Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual Amazon Web Services account.

For more information about policies and their use, see Managing Organizations policies.

If the request includes tags, then the requester must have the organizations:TagResource permission.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Parameter Syntax

$result = $client->createPolicy([
    'Content' => '<string>', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Type' => 'SERVICE_CONTROL_POLICY|TAG_POLICY|BACKUP_POLICY|AISERVICES_OPT_OUT_POLICY|CHATBOT_POLICY', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Policy' => [
        'Content' => '<string>',
        'PolicySummary' => [
            'Arn' => '<string>',
            'AwsManaged' => true || false,
            'Description' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'Type' => 'SERVICE_CONTROL_POLICY|TAG_POLICY|BACKUP_POLICY|AISERVICES_OPT_OUT_POLICY|CHATBOT_POLICY',
        ],
    ],
]

Result Details

Errors

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. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

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 SCP syntax in the 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 Managing Organizations policiesin the Organizations User Guide.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

Examples

Example 1: 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:

$result = $client->createPolicy([
    'Content' => '{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\"}}',
    'Description' => 'Enables admins of attached accounts to delegate all S3 permissions',
    'Name' => 'AllowAllS3Actions',
    'Type' => 'SERVICE_CONTROL_POLICY',
]);

Result syntax:

[
    'Policy' => [
        'Content' => '{"Version":"2012-10-17","Statement":{"Effect":"Allow","Action":"s3:*"}}',
        'PolicySummary' => [
            'Arn' => 'arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111',
            'Description' => 'Allows delegation of all S3 actions',
            'Name' => 'AllowAllS3Actions',
            'Type' => 'SERVICE_CONTROL_POLICY',
        ],
    ],
]

DeclineHandshake

$result = $client->declineHandshake([/* ... */]);
$promise = $client->declineHandshakeAsync([/* ... */]);

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 APIs for only 30 days. After that, it's deleted.

Parameter Syntax

$result = $client->declineHandshake([
    'HandshakeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Handshake' => [
        'Action' => 'INVITE|ENABLE_ALL_FEATURES|APPROVE_ALL_FEATURES|ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
        'Arn' => '<string>',
        'ExpirationTimestamp' => <DateTime>,
        'Id' => '<string>',
        'Parties' => [
            [
                'Id' => '<string>',
                'Type' => 'ACCOUNT|ORGANIZATION|EMAIL',
            ],
            // ...
        ],
        'RequestedTimestamp' => <DateTime>,
        'Resources' => [
            [
                'Resources' => [...], // RECURSIVE
                'Type' => 'ACCOUNT|ORGANIZATION|ORGANIZATION_FEATURE_SET|EMAIL|MASTER_EMAIL|MASTER_NAME|NOTES|PARENT_HANDSHAKE',
                'Value' => '<string>',
            ],
            // ...
        ],
        'State' => 'REQUESTED|OPEN|CANCELED|ACCEPTED|DECLINED|EXPIRED',
    ],
]

Result Details

Errors

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

Examples

Example 1: 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:

$result = $client->declineHandshake([
    'HandshakeId' => 'h-examplehandshakeid111',
]);

Result syntax:

[
    'Handshake' => [
        'Action' => 'INVITE',
        'Arn' => 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
        'ExpirationTimestamp' => ,
        'Id' => 'h-examplehandshakeid111',
        'Parties' => [
            [
                'Id' => '222222222222',
                'Type' => 'ACCOUNT',
            ],
            [
                'Id' => 'o-exampleorgid',
                'Type' => 'ORGANIZATION',
            ],
        ],
        'RequestedTimestamp' => ,
        'Resources' => [
            [
                'Resources' => [
                    [
                        'Type' => 'MASTER_EMAIL',
                        'Value' => 'bill@example.com',
                    ],
                    [
                        'Type' => 'MASTER_NAME',
                        'Value' => 'Master Account',
                    ],
                ],
                'Type' => 'ORGANIZATION',
                'Value' => 'o-exampleorgid',
            ],
            [
                'Type' => 'ACCOUNT',
                'Value' => '222222222222',
            ],
            [
                'Type' => 'NOTES',
                'Value' => 'This is an invitation to Susan's account to join the Bill's organization.',
            ],
        ],
        'State' => 'DECLINED',
    ],
]

DeleteOrganization

$result = $client->deleteOrganization([/* ... */]);
$promise = $client->deleteOrganizationAsync([/* ... */]);

Deletes the organization. You can delete an organization only by using credentials from the management account. The organization must be empty of member accounts.

Parameter Syntax

$result = $client->deleteOrganization([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

OrganizationNotEmptyException:

The organization isn't empty. To delete an organization, you must first remove all accounts except the management account.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

DeleteOrganizationalUnit

$result = $client->deleteOrganizationalUnit([/* ... */]);
$promise = $client->deleteOrganizationalUnitAsync([/* ... */]);

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 management account.

Parameter Syntax

$result = $client->deleteOrganizationalUnit([
    'OrganizationalUnitId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

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:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

Examples

Example 1: 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:

$result = $client->deleteOrganizationalUnit([
    'OrganizationalUnitId' => 'ou-examplerootid111-exampleouid111',
]);

DeletePolicy

$result = $client->deletePolicy([/* ... */]);
$promise = $client->deletePolicyAsync([/* ... */]);

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 management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Parameter Syntax

$result = $client->deletePolicy([
    'PolicyId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

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:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

Examples

Example 1: 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:

$result = $client->deletePolicy([
    'PolicyId' => 'p-examplepolicyid111',
]);

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes the resource policy from your organization.

You can only call this operation from the organization's management account.

Parameter Syntax

$result = $client->deleteResourcePolicy([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

ServiceException:

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

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

TooManyRequestsException:

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

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

ConcurrentModificationException:

The target of the operation is currently being modified by a different request. Try again later.

ConstraintViolationException:

Performing this operation violates a minimum or maximum value limit. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

ResourcePolicyNotFoundException:

We can't find a resource policy request with the parameter that you specified.

DeregisterDelegatedAdministrator

$result = $client->deregisterDelegatedAdministrator([/* ... */]);
$promise = $client->deregisterDelegatedAdministratorAsync([/* ... */]);

Removes the specified member Amazon Web Services account as a delegated administrator for the specified Amazon Web Services service.

You can run this action only for Amazon Web Services services that support this feature. For a current list of services that support it, see the column Supports Delegated Administrator in the table at Amazon Web Services Services that you can use with Organizations in the Organizations User Guide.

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

Parameter Syntax

$result = $client->deregisterDelegatedAdministrator([
    'AccountId' => '<string>', // REQUIRED
    'ServicePrincipal' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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 Amazon Web Services 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.

AccountNotRegisteredException:

The specified account is not a delegated administrator for this Amazon Web Services service.

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. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

TooManyRequestsException:

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

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

ServiceException:

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

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

DescribeAccount

$result = $client->describeAccount([/* ... */]);
$promise = $client->describeAccountAsync([/* ... */]);

Retrieves Organizations-related information about the specified account.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Parameter Syntax

$result = $client->describeAccount([
    'AccountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Account' => [
        'Arn' => '<string>',
        'Email' => '<string>',
        'Id' => '<string>',
        'JoinedMethod' => 'INVITED|CREATED',
        'JoinedTimestamp' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'ACTIVE|SUSPENDED|PENDING_CLOSURE',
    ],
]

Result Details

Errors

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 Amazon Web Services 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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

Examples

Example 1: To get the details about an account

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

$result = $client->describeAccount([
    'AccountId' => '555555555555',
]);

Result syntax:

[
    'Account' => [
        'Arn' => 'arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555',
        'Email' => 'anika@example.com',
        'Id' => '555555555555',
        'Name' => 'Beta Account',
    ],
]

DescribeCreateAccountStatus

$result = $client->describeCreateAccountStatus([/* ... */]);
$promise = $client->describeCreateAccountStatusAsync([/* ... */]);

Retrieves the current status of an asynchronous request to create an account.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Parameter Syntax

$result = $client->describeCreateAccountStatus([
    'CreateAccountRequestId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreateAccountStatus' => [
        'AccountId' => '<string>',
        'AccountName' => '<string>',
        'CompletedTimestamp' => <DateTime>,
        'FailureReason' => 'ACCOUNT_LIMIT_EXCEEDED|EMAIL_ALREADY_EXISTS|INVALID_ADDRESS|INVALID_EMAIL|CONCURRENT_ACCOUNT_MODIFICATION|INTERNAL_FAILURE|GOVCLOUD_ACCOUNT_ALREADY_EXISTS|MISSING_BUSINESS_VALIDATION|FAILED_BUSINESS_VALIDATION|PENDING_BUSINESS_VALIDATION|INVALID_IDENTITY_FOR_BUSINESS_VALIDATION|UNKNOWN_BUSINESS_VALIDATION|MISSING_PAYMENT_INSTRUMENT|INVALID_PAYMENT_INSTRUMENT|UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED',
        'GovCloudAccountId' => '<string>',
        'Id' => '<string>',
        'RequestedTimestamp' => <DateTime>,
        'State' => 'IN_PROGRESS|SUCCEEDED|FAILED',
    ],
]

Result Details

Errors

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 an create account request with the CreateAccountRequestId that you specified.

InvalidInputException:

The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:

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

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

Examples

Example 1: 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":

$result = $client->describeCreateAccountStatus([
    'CreateAccountRequestId' => 'car-exampleaccountcreationrequestid',
]);

Result syntax:

[
    'CreateAccountStatus' => [
        'AccountId' => '333333333333',
        'Id' => 'car-exampleaccountcreationrequestid',
        'State' => 'SUCCEEDED',
    ],
]

DescribeEffectivePolicy

$result = $client->describeEffectivePolicy([/* ... */]);
$promise = $client->describeEffectivePolicyAsync([/* ... */]);

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

This operation applies only to policy types other than service control policies (SCPs).

For more information about policy inheritance, see Understanding management policy inheritance in the Organizations User Guide.

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

Parameter Syntax

$result = $client->describeEffectivePolicy([
    'PolicyType' => 'TAG_POLICY|BACKUP_POLICY|AISERVICES_OPT_OUT_POLICY|CHATBOT_POLICY', // REQUIRED
    'TargetId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EffectivePolicy' => [
        'LastUpdatedTimestamp' => <DateTime>,
        'PolicyContent' => '<string>',
        'PolicyType' => 'TAG_POLICY|BACKUP_POLICY|AISERVICES_OPT_OUT_POLICY|CHATBOT_POLICY',
        'TargetId' => '<string>',
    ],
]

Result Details

Errors

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. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

TargetNotFoundException:

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

EffectivePolicyNotFoundException:

If you ran this action on the management 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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

DescribeHandshake

$result = $client->describeHandshake([/* ... */]);
$promise = $client->describeHandshakeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeHandshake([
    'HandshakeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Handshake' => [
        'Action' => 'INVITE|ENABLE_ALL_FEATURES|APPROVE_ALL_FEATURES|ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
        'Arn' => '<string>',
        'ExpirationTimestamp' => <DateTime>,
        'Id' => '<string>',
        'Parties' => [
            [
                'Id' => '<string>',
                'Type' => 'ACCOUNT|ORGANIZATION|EMAIL',
            ],
            // ...
        ],
        'RequestedTimestamp' => <DateTime>,
        'Resources' => [
            [
                'Resources' => [...], // RECURSIVE
                'Type' => 'ACCOUNT|ORGANIZATION|ORGANIZATION_FEATURE_SET|EMAIL|MASTER_EMAIL|MASTER_NAME|NOTES|PARENT_HANDSHAKE',
                'Value' => '<string>',
            ],
            // ...
        ],
        'State' => 'REQUESTED|OPEN|CANCELED|ACCEPTED|DECLINED|EXPIRED',
    ],
]

Result Details

Errors

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

Examples

Example 1: 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":

$result = $client->describeHandshake([
    'HandshakeId' => 'h-examplehandshakeid111',
]);

Result syntax:

[
    'Handshake' => [
        'Action' => 'INVITE',
        'Arn' => 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
        'ExpirationTimestamp' => ,
        'Id' => 'h-examplehandshakeid111',
        'Parties' => [
            [
                'Id' => 'o-exampleorgid',
                'Type' => 'ORGANIZATION',
            ],
            [
                'Id' => '333333333333',
                'Type' => 'ACCOUNT',
            ],
        ],
        'RequestedTimestamp' => ,
        'Resources' => [
            [
                'Resources' => [
                    [
                        'Type' => 'MASTER_EMAIL',
                        'Value' => 'bill@example.com',
                    ],
                    [
                        'Type' => 'MASTER_NAME',
                        'Value' => 'Master Account',
                    ],
                ],
                'Type' => 'ORGANIZATION',
                'Value' => 'o-exampleorgid',
            ],
            [
                'Type' => 'ACCOUNT',
                'Value' => '333333333333',
            ],
        ],
        'State' => 'OPEN',
    ],
]

DescribeOrganization

$result = $client->describeOrganization([/* ... */]);
$promise = $client->describeOrganizationAsync([/* ... */]);

Retrieves information about the organization that the user's account belongs to.

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

Parameter Syntax

$result = $client->describeOrganization([
]);

Parameter Details

Result Syntax

[
    'Organization' => [
        'Arn' => '<string>',
        'AvailablePolicyTypes' => [
            [
                'Status' => 'ENABLED|PENDING_ENABLE|PENDING_DISABLE',
                'Type' => 'SERVICE_CONTROL_POLICY|TAG_POLICY|BACKUP_POLICY|AISERVICES_OPT_OUT_POLICY|CHATBOT_POLICY',
            ],
            // ...
        ],
        'FeatureSet' => 'ALL|CONSOLIDATED_BILLING',
        'Id' => '<string>',
        'MasterAccountArn' => '<string>',
        'MasterAccountEmail' => '<string>',
        'MasterAccountId' => '<string>',
    ],
]

Result Details

Errors

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:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

Examples

Example 1: To get information about an organization

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

$result = $client->describeOrganization([
]);

Result syntax:

[
    'Organization' => [
        'Arn' => 'arn:aws:organizations::111111111111:organization/o-exampleorgid',
        'AvailablePolicyTypes' => [
            [
                'Status' => 'ENABLED',
                'Type' => 'SERVICE_CONTROL_POLICY',
            ],
        ],
        'FeatureSet' => 'ALL',
        'Id' => 'o-exampleorgid',
        'MasterAccountArn' => 'arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111',
        'MasterAccountEmail' => 'bill@example.com',
    ],
]

DescribeOrganizationalUnit

$result = $client->describeOrganizationalUnit([/* ... */]);
$promise = $client->describeOrganizationalUnitAsync([/* ... */]);

Retrieves information about an organizational unit (OU).

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Parameter Syntax

$result = $client->describeOrganizationalUnit([
    'OrganizationalUnitId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'OrganizationalUnit' => [
        'Arn' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

OrganizationalUnitNotFoundException:

We can't find an OU with the OrganizationalUnitId that you specified.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

Examples

Example 1: To get information about an organizational unit

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

$result = $client->describeOrganizationalUnit([
    'OrganizationalUnitId' => 'ou-examplerootid111-exampleouid111',
]);

Result syntax:

[
    'OrganizationalUnit' => [
        'Arn' => 'arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111',
        'Id' => 'ou-examplerootid111-exampleouid111',
        'Name' => 'Accounting Group',
    ],
]

DescribePolicy

$result = $client->describePolicy([/* ... */]);
$promise = $client->describePolicyAsync([/* ... */]);

Retrieves information about a policy.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Parameter Syntax

$result = $client->describePolicy([
    'PolicyId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Policy' => [
        'Content' => '<string>',
        'PolicySummary' => [
            'Arn' => '<string>',
            'AwsManaged' => true || false,
            'Description' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'Type' => 'SERVICE_CONTROL_POLICY|TAG_POLICY|BACKUP_POLICY|AISERVICES_OPT_OUT_POLICY|CHATBOT_POLICY',
        ],
    ],
]

Result Details

Errors

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

PolicyNotFoundException:

We can't find a policy with the PolicyId that you specified.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

Examples

Example 1: To get information about a policy

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

$result = $client->describePolicy([
    'PolicyId' => 'p-examplepolicyid111',
]);

Result syntax:

[
    'Policy' => [
        'Content' => '{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"*\",\n \"Resource\": \"*\"\n }\n ]\n}',
        'PolicySummary' => [
            'Arn' => 'arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111',
            'AwsManaged' => ,
            'Description' => 'Enables admins to delegate S3 permissions',
            'Id' => 'p-examplepolicyid111',
            'Name' => 'AllowAllS3Actions',
            'Type' => 'SERVICE_CONTROL_POLICY',
        ],
    ],
]

DescribeResourcePolicy

$result = $client->describeResourcePolicy([/* ... */]);
$promise = $client->describeResourcePolicyAsync([/* ... */]);

Retrieves information about a resource policy.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Parameter Syntax

$result = $client->describeResourcePolicy([
]);

Parameter Details

Result Syntax

[
    'ResourcePolicy' => [
        'Content' => '<string>',
        'ResourcePolicySummary' => [
            'Arn' => '<string>',
            'Id' => '<string>',
        ],
    ],
]

Result Details

Errors

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.

ServiceException:

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

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

TooManyRequestsException:

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

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations 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.

ResourcePolicyNotFoundException:

We can't find a resource policy request with the parameter that you specified.

ConstraintViolationException:

Performing this operation violates a minimum or maximum value limit. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

DetachPolicy

$result = $client->detachPolicy([/* ... */]);
$promise = $client->detachPolicyAsync([/* ... */]);

Detaches a policy from a target root, organizational unit (OU), or account.

Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with an SCP that limits the permissions that can be delegated, you must attach the replacement SCP before you can remove the default SCP. This is the authorization strategy of an "allow list". If you instead attach a second SCP and leave the FullAWSAccess SCP still attached, and specify "Effect": "Deny" in the second SCP to override the "Effect": "Allow" in the FullAWSAccess policy (or any other attached SCP), you're using the authorization strategy of a "deny list".

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Parameter Syntax

$result = $client->detachPolicy([
    'PolicyId' => '<string>', // REQUIRED
    'TargetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

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:

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

TargetNotFoundException:

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

TooManyRequestsException:

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

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

PolicyChangesInProgressException:

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

Examples

Example 1: To detach a policy from a root, OU, or account

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

$result = $client->detachPolicy([
    'PolicyId' => 'p-examplepolicyid111',
    'TargetId' => 'ou-examplerootid111-exampleouid111',
]);

DisableAWSServiceAccess

$result = $client->disableAWSServiceAccess([/* ... */]);
$promise = $client->disableAWSServiceAccessAsync([/* ... */]);

Disables the integration of an Amazon Web Services service (the service that is specified by ServicePrincipal) with 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 Organizations.

After you perform the DisableAWSServiceAccess operation, the specified service can no longer perform operations in your organization's accounts

For more information about integrating other services with Organizations, including the list of services that work with Organizations, see Using Organizations with other Amazon Web Services services in the Organizations User Guide.

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

Parameter Syntax

$result = $client->disableAWSServiceAccess([
    'ServicePrincipal' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

DisablePolicyType

$result = $client->disablePolicyType([/* ... */]);
$promise = $client->disablePolicyTypeAsync([/* ... */]);

Disables an organizational policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation.

This is an asynchronous request that Amazon Web Services performs in the background. If you disable a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. Amazon Web Services 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 management account or by a member account that is a delegated administrator for an Amazon Web Services service.

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

Parameter Syntax

$result = $client->disablePolicyType([
    'PolicyType' => 'SERVICE_CONTROL_POLICY|TAG_POLICY|BACKUP_POLICY|AISERVICES_OPT_OUT_POLICY|CHATBOT_POLICY', // REQUIRED
    'RootId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Root' => [
        'Arn' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'PolicyTypes' => [
            [
                'Status' => 'ENABLED|PENDING_ENABLE|PENDING_DISABLE',
                'Type' => 'SERVICE_CONTROL_POLICY|TAG_POLICY|BACKUP_POLICY|AISERVICES_OPT_OUT_POLICY|CHATBOT_POLICY',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

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. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

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 Organizations User Guide.

RootNotFoundException:

We can't find a root with the RootId that you specified.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

PolicyChangesInProgressException:

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

Examples

Example 1: 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

$result = $client->disablePolicyType([
    'PolicyType' => 'SERVICE_CONTROL_POLICY',
    'RootId' => 'r-examplerootid111',
]);

Result syntax:

[
    'Root' => [
        'Arn' => 'arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111',
        'Id' => 'r-examplerootid111',
        'Name' => 'Root',
        'PolicyTypes' => [
        ],
    ],
]

EnableAWSServiceAccess

$result = $client->enableAWSServiceAccess([/* ... */]);
$promise = $client->enableAWSServiceAccessAsync([/* ... */]);

Provides an Amazon Web Services service (the service that is specified by ServicePrincipal) with permissions to view the structure of an organization, create a service-linked role in all the accounts in the organization, and allow the service to perform operations on behalf of the organization and its accounts. Establishing these permissions can be a first step in enabling the integration of an Amazon Web Services service with Organizations.

For more information about enabling services to integrate with Organizations, see Using Organizations with other Amazon Web Services services in the Organizations User Guide.

You can only call this operation from the organization's management account and only if the organization has enabled all features.

Parameter Syntax

$result = $client->enableAWSServiceAccess([
    'ServicePrincipal' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

EnableAllFeatures

$result = $client->enableAllFeatures([/* ... */]);
$promise = $client->enableAllFeaturesAsync([/* ... */]);

Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that Organizations supports. For more information, see Enabling all features in your organization in the Organizations User Guide.

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 management 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 management 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 management account.

Parameter Syntax

$result = $client->enableAllFeatures([
]);

Parameter Details

Result Syntax

[
    'Handshake' => [
        'Action' => 'INVITE|ENABLE_ALL_FEATURES|APPROVE_ALL_FEATURES|ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
        'Arn' => '<string>',
        'ExpirationTimestamp' => <DateTime>,
        'Id' => '<string>',
        'Parties' => [
            [
                'Id' => '<string>',
                'Type' => 'ACCOUNT|ORGANIZATION|EMAIL',
            ],
            // ...
        ],
        'RequestedTimestamp' => <DateTime>,
        'Resources' => [
            [
                'Resources' => [...], // RECURSIVE
                'Type' => 'ACCOUNT|ORGANIZATION|ORGANIZATION_FEATURE_SET|EMAIL|MASTER_EMAIL|MASTER_NAME|NOTES|PARENT_HANDSHAKE',
                'Value' => '<string>',
            ],
            // ...
        ],
        'State' => 'REQUESTED|OPEN|CANCELED|ACCEPTED|DECLINED|EXPIRED',
    ],
]

Result Details

Errors

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 Amazon Web Services 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_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION: The handshake request is invalid because the organization has already started the process to enable 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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

Examples

Example 1: 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

$result = $client->enableAllFeatures([
]);

Result syntax:

[
    'Handshake' => [
        'Action' => 'ENABLE_ALL_FEATURES',
        'Arn' => 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/enable_all_features/h-examplehandshakeid111',
        'ExpirationTimestamp' => ,
        'Id' => 'h-examplehandshakeid111',
        'Parties' => [
            [
                'Id' => 'o-exampleorgid',
                'Type' => 'ORGANIZATION',
            ],
        ],
        'RequestedTimestamp' => ,
        'Resources' => [
            [
                'Type' => 'ORGANIZATION',
                'Value' => 'o-exampleorgid',
            ],
        ],
        'State' => 'REQUESTED',
    ],
]

EnablePolicyType

$result = $client->enablePolicyType([/* ... */]);
$promise = $client->enablePolicyTypeAsync([/* ... */]);

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 Amazon Web Services performs in the background. Amazon Web Services 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 management account or by a member account that is a delegated administrator for an Amazon Web Services service.

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.

Parameter Syntax

$result = $client->enablePolicyType([
    'PolicyType' => 'SERVICE_CONTROL_POLICY|TAG_POLICY|BACKUP_POLICY|AISERVICES_OPT_OUT_POLICY|CHATBOT_POLICY', // REQUIRED
    'RootId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Root' => [
        'Arn' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'PolicyTypes' => [
            [
                'Status' => 'ENABLED|PENDING_ENABLE|PENDING_DISABLE',
                'Type' => 'SERVICE_CONTROL_POLICY|TAG_POLICY|BACKUP_POLICY|AISERVICES_OPT_OUT_POLICY|CHATBOT_POLICY',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

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. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

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:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the 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 Managing Organizations policiesin the Organizations User Guide.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

PolicyChangesInProgressException:

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

Examples

Example 1: 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

$result = $client->enablePolicyType([
    'PolicyType' => 'SERVICE_CONTROL_POLICY',
    'RootId' => 'r-examplerootid111',
]);

Result syntax:

[
    'Root' => [
        'Arn' => 'arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111',
        'Id' => 'r-examplerootid111',
        'Name' => 'Root',
        'PolicyTypes' => [
            [
                'Status' => 'ENABLED',
                'Type' => 'SERVICE_CONTROL_POLICY',
            ],
        ],
    ],
]

InviteAccountToOrganization

$result = $client->inviteAccountToOrganization([/* ... */]);
$promise = $client->inviteAccountToOrganizationAsync([/* ... */]);

Sends an invitation to another account to join your organization as a member account. Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a Handshake whose details are in the response.

If the request includes tags, then the requester must have the organizations:TagResource permission.

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

Parameter Syntax

$result = $client->inviteAccountToOrganization([
    'Notes' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Target' => [ // REQUIRED
        'Id' => '<string>', // REQUIRED
        'Type' => 'ACCOUNT|ORGANIZATION|EMAIL', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'Handshake' => [
        'Action' => 'INVITE|ENABLE_ALL_FEATURES|APPROVE_ALL_FEATURES|ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE',
        'Arn' => '<string>',
        'ExpirationTimestamp' => <DateTime>,
        'Id' => '<string>',
        'Parties' => [
            [
                'Id' => '<string>',
                'Type' => 'ACCOUNT|ORGANIZATION|EMAIL',
            ],
            // ...
        ],
        'RequestedTimestamp' => <DateTime>,
        'Resources' => [
            [
                'Resources' => [...], // RECURSIVE
                'Type' => 'ACCOUNT|ORGANIZATION|ORGANIZATION_FEATURE_SET|EMAIL|MASTER_EMAIL|MASTER_NAME|NOTES|PARENT_HANDSHAKE',
                'Value' => '<string>',
            ],
            // ...
        ],
        'State' => 'REQUESTED|OPEN|CANCELED|ACCEPTED|DECLINED|EXPIRED',
    ],
]

Result Details

Errors

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 management account. For more information, see Email address verification in the 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 Amazon Web Services 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_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION: The handshake request is invalid because the organization has already started the process to enable 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.

ConstraintViolationException:

Performing this operation violates a minimum or maximum value limit. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

FinalizingOrganizationException:

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 Amazon Web Services Support.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

Examples

Example 1: To invite an account to join an organization

The following example shows the admin of the master account owned by bill@example.com inviting the account owned by juan@example.com to join an organization.

$result = $client->inviteAccountToOrganization([
    'Notes' => 'This is a request for Juan's account to join Bill's organization',
    'Target' => [
        'Id' => 'juan@example.com',
        'Type' => 'EMAIL',
    ],
]);

Result syntax:

[
    'Handshake' => [
        'Action' => 'INVITE',
        'Arn' => 'arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111',
        'ExpirationTimestamp' => ,
        'Id' => 'h-examplehandshakeid111',
        'Parties' => [
            [
                'Id' => 'o-exampleorgid',
                'Type' => 'ORGANIZATION',
            ],
            [
                'Id' => 'juan@example.com',
                'Type' => 'EMAIL',
            ],
        ],
        'RequestedTimestamp' => ,
        'Resources' => [
            [
                'Resources' => [
                    [
                        'Type' => 'MASTER_EMAIL',
                        'Value' => 'bill@amazon.com',
                    ],
                    [
                        'Type' => 'MASTER_NAME',
                        'Value' => 'Org Master Account',
                    ],
                    [
                        'Type' => 'ORGANIZATION_FEATURE_SET',
                        'Value' => 'FULL',
                    ],
                ],
                'Type' => 'ORGANIZATION',
                'Value' => 'o-exampleorgid',
            ],
            [
                'Type' => 'EMAIL',
                'Value' => 'juan@example.com',
            ],
        ],
        'State' => 'OPEN',
    ],
]

LeaveOrganization

$result = $client->leaveOrganization([/* ... */]);
$promise = $client->leaveOrganizationAsync([/* ... */]);

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 management account, use RemoveAccountFromOrganization instead.

This operation can be called only from a member account in the organization.

Parameter Syntax

$result = $client->leaveOrganization([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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 Amazon Web Services 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. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

MasterCannotLeaveOrganizationException:

You can't remove a management account from an organization. If you want the management account to become a member account in another organization, you must first delete the current organization of the management account.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

Examples

Example 1: To leave an organization as a member account

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

$result = $client->leaveOrganization([
]);

ListAWSServiceAccessForOrganization

$result = $client->listAWSServiceAccessForOrganization([/* ... */]);
$promise = $client->listAWSServiceAccessForOrganizationAsync([/* ... */]);

Returns a list of the Amazon Web Services 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 Organizations, including the list of services that currently work with Organizations, see Using Organizations with other Amazon Web Services services in the Organizations User Guide.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Parameter Syntax

$result = $client->listAWSServiceAccessForOrganization([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EnabledServicePrincipals' => [
        [
            'DateEnabled' => <DateTime>,
            'ServicePrincipal' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

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. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

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

• ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.

• 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 Removing a member account from your organization in the Organizations User Guide.

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

• ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.

• ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact Amazon Web Services 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 Amazon Web Services Support to request an increase in the number of accounts.

  Deleted and closed accounts still count toward your limit.

  If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact Amazon Web Services Support.

• CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot register a suspended account as a delegated administrator.

• CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.

• CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. To close the management account for the organization, you must first either remove or close all member accounts in the organization. Follow standard account closure process using root credentials.​

• CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

• CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the past 30 days.

• CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can close at a time. ​

• CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

• DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

• EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

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

• INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported payment method is associated with the account. Amazon Web Services does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your Amazon Web Services payments.

• MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. All accounts in an organization must be associated with the same marketplace.

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.

• MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.

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

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

• MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

• 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. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.

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

• 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_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

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

• POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

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

• SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.

• TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

• WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

UnsupportedAPIEndpointException:

This action isn't available in the current Amazon Web Services Region.

ListAccounts

$result = $client->listAccounts([/* ... */]);
$promise = $client->listAccountsAsync([/* ... */]);

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.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Parameter Syntax

$result = $client->listAccounts([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Accounts' => [
        [
            'Arn' => '<string>',
            'Email' => '<string>',
            'Id' => '<string>',
            'JoinedMethod' => 'INVITED|CREATED',
            'JoinedTimestamp' => <DateTime>,
            'Name' => '<string>',
            'Status' => 'ACTIVE|SUSPENDED|PENDING_CLOSURE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

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.

• DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.

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

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

• INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.

• INVALID_ENUM: You specified an invalid value.

• INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

• 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 Amazon Web Services 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.

• TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.

• UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.

ServiceException:

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 quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect Organizations, see Quotas for Organizations in the Organizations User Guide.

Examples

Example 1: 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:

$result = $client->listAccounts([
]);

Result syntax:

[
    'Accounts' => [
        [
            'Arn' => 'arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111',
            'Email' => 'bill@example.com',
            'Id' => '111111111111',
            'JoinedMethod' => 'INVITED',
            'JoinedTimestamp' => ,
            'Name' => 'Master Account',
            'Status' => 'ACTIVE',
        ],
        [
            'Arn' => 'arn:aws:organizations::111111111111:account/o-exampleorgid/222222222222',
            'Email' => 'alice@example.com',
            'Id' => '222222222222',
            'JoinedMethod' => 'INVITED',
            'JoinedTimestamp' => ,
            'Name' => 'Developer Account',
            'Status' => 'ACTIVE',
        ],
        [
            'Arn' => 'arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333',
            'Email' => 'juan@example.com',
            'Id' => '333333333333',
            'JoinedMethod' => 'INVITED',
            'JoinedTimestamp' => ,
            'Name' => 'Test Account',
            'Status' => 'ACTIVE',
        ],
        [
            'Arn' => 'arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444',
            'Email' => 'anika@example.com',
            'Id' => '444444444444',
            'JoinedMethod' => 'INVITED',
            'JoinedTimestamp' => ,
            'Name' => 'Production Account',
            'Status' => 'ACTIVE',
        ],
    ],
]

ListAccountsForParent

$result = $client->listAccountsForParent([/* ... */]);
$promise = $client->listAccountsForParentAsync([/* ... */]);

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.