Accepts a handshake by sending an ACCEPTED response to the sender. You can view accepted handshakes in API responses for 30 days before they are deleted.
Only the management account can accept the following handshakes:
Enable all features final confirmation (APPROVE_ALL_FEATURES)
Billing transfer (TRANSFER_RESPONSIBILITY)
For more information, see Enabling all features and Responding to a billing transfer invitation in the Organizations User Guide.
Only a member account can accept the following handshakes:
Invitation to join (INVITE)
Approve all features request (ENABLE_ALL_FEATURES)
For more information, see Responding to invitations and Enabling all features in the Organizations User Guide.
When a handshake is accepted, Organizations logs membership events in CloudTrail, available only in the management account's event history. If the account was standalone and joined a new organization, an AccountJoinedOrganization event is logged with joinedMethod:Invited and joinedTime fields. If the account departed one organization and joined another, both an AccountDepartedOrganization event with departedMethod:Left and departedTime and an AccountJoinedOrganization event with joinedMethod:Invited and joinedTime are logged in their respective management accounts.
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:
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "CancelHandshake":{ "name":"CancelHandshake", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelHandshakeRequest"}, "output":{"shape":"CancelHandshakeResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ConcurrentModificationException"}, {"shape":"HandshakeNotFoundException"}, {"shape":"InvalidHandshakeTransitionException"}, {"shape":"HandshakeAlreadyInStateException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Cancels a Handshake.
Only the account that sent a handshake can call this operation. The recipient of the handshake can't cancel it, but can use DeclineHandshake to decline. After a handshake is canceled, the recipient can no longer respond to the handshake.
You can view canceled handshakes in API responses for 30 days before they are deleted.
" }, "CloseAccount":{ "name":"CloseAccount", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CloseAccountRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AccountAlreadyClosedException"}, {"shape":"AccountNotFoundException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConflictException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"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.
Resources remaining within the account after closing will be automatically deleted after 90 days. During this 90-day period, the resources won't be available unless you contact Amazon Web Services Support to reopen the account. After 90 days, you can't reopen an account. You might still receive a bill after account closure.
Within a rolling 30 day period you can close the higher of either 250 or 20% of the member accounts in your organization, up to a maximum of 1,000. This quota is not bound by a calendar month, but starts when you close an account. After you reach this limit, you can't close additional accounts. For more information, see Closing a member account in your organization and Quotas for Organizations in the Organizations User Guide.
To reinstate a closed account, contact Amazon Web Services Support within the 90-day grace period while the account is in SUSPENDED status.
If the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud (US) account, the CloseAccount request will close both accounts. To learn important pre-closure details, see Closing an Amazon Web Services GovCloud (US) account in the Amazon Web Services GovCloud User Guide.
After the permanent termination of the account after the 90-day waiting period, Organizations logs a membership event in CloudTrail. The event is an AccountDepartedOrganization event with departedMethod:Cleaned and departedTime. This event is available only in the management account's event history.
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.
Additionally, the AccountJoinedOrganization event is logged in CloudTrail and is available only in the management account's event history. This event includes joinedMethod:Created and joinedTime fields to provide context on how and when the account joined the organization.
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.
You can only call this operation from the management account.
For more information about creating accounts, see Creating a member account in your organization in the Organizations User Guide.
When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.
If you get an exception that indicates that you exceeded your account limits for the organization, contact Amazon Web Services Support.
If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact Amazon Web Services Support.
It isn't recommended to use CreateAccount to create multiple temporary accounts, and using the CreateAccount API to close accounts is subject to a 30-day usage quota. For information on the requirements and process for closing an account, see Closing a member account in your organization in the Organizations User Guide.
When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting access to your billing information and tools.
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.
Additionally, the AccountJoinedOrganization event is logged in CloudTrail and is available only in the management account's event history only for the linked commercial account. This event includes joinedMethod:Created and joinedTime fields to provide context on how and when the account joined the organization.
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.
When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account is not automatically collected. This includes a payment method and signing the end user license agreement (EULA). If you must remove an account from your organization later, you can do so only after you provide the missing information. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.
If you get an exception that indicates that you exceeded your account limits for the organization, contact Amazon Web Services Support.
If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact Amazon Web Services Support.
Using CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the Amazon Web Services Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing a member account in your organization in the Organizations User Guide.
When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting access to your billing information and tools.
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.
The AccountJoinedOrganization event is logged in CloudTrail and is available only in the management account's event history. This event includes joinedMethod:Invited and joinedTime fields to provide context on how and when the account joined the organization.
Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five.
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.
You can only call this operation from the management account.
" }, "CreatePolicy":{ "name":"CreatePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePolicyRequest"}, "output":{"shape":"CreatePolicyResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"DuplicatePolicyException"}, {"shape":"InvalidInputException"}, {"shape":"MalformedPolicyDocumentException"}, {"shape":"PolicyTypeNotAvailableForOrganizationException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"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.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "DeclineHandshake":{ "name":"DeclineHandshake", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeclineHandshakeRequest"}, "output":{"shape":"DeclineHandshakeResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ConcurrentModificationException"}, {"shape":"HandshakeNotFoundException"}, {"shape":"InvalidHandshakeTransitionException"}, {"shape":"HandshakeAlreadyInStateException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Declines a Handshake.
Only the account that receives a handshake can call this operation. The sender of the handshake can use CancelHandshake to cancel if the handshake hasn't yet been responded to.
You can view canceled handshakes in API responses for 30 days before they are deleted.
" }, "DeleteOrganization":{ "name":"DeleteOrganization", "http":{ "method":"POST", "requestUri":"/" }, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"OrganizationNotEmptyException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Deletes the organization. You can delete an organization only by using credentials from the management account. The organization must be empty of member accounts.
When an organization is deleted, Organizations logs a membership event in CloudTrail. The event is an AccountDepartedOrganization event with departedMethod:Left and departedTime. This event is available only in the management account's event history.
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.
You can only call this operation from the management account.
" }, "DeletePolicy":{ "name":"DeletePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePolicyRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InvalidInputException"}, {"shape":"PolicyInUseException"}, {"shape":"PolicyNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"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.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "DeleteResourcePolicy":{ "name":"DeleteResourcePolicy", "http":{ "method":"POST", "requestUri":"/" }, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ServiceException"}, {"shape":"UnsupportedAPIEndpointException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ResourcePolicyNotFoundException"} ], "documentation":"Deletes the resource policy from your organization.
You can only call this operation from the management account.
" }, "DeregisterDelegatedAdministrator":{ "name":"DeregisterDelegatedAdministrator", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterDelegatedAdministratorRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AccountNotFoundException"}, {"shape":"AccountNotRegisteredException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"TooManyRequestsException"}, {"shape":"ServiceException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"Removes the specified member Amazon Web Services account as a delegated administrator for the specified Amazon Web Services service.
Deregistering a delegated administrator can have unintended impacts on the functionality of the enabled Amazon Web Services service. See the documentation for the enabled service before you deregister a delegated administrator so that you understand any potential impacts.
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.
You can only call this operation from the management account.
" }, "DescribeAccount":{ "name":"DescribeAccount", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountRequest"}, "output":{"shape":"DescribeAccountResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AccountNotFoundException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Retrieves Organizations-related information about the specified account.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "DescribeCreateAccountStatus":{ "name":"DescribeCreateAccountStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCreateAccountStatusRequest"}, "output":{"shape":"DescribeCreateAccountStatusResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"CreateAccountStatusNotFoundException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"Retrieves the current status of an asynchronous request to create an account.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "DescribeEffectivePolicy":{ "name":"DescribeEffectivePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEffectivePolicyRequest"}, "output":{"shape":"DescribeEffectivePolicyResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConstraintViolationException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"TargetNotFoundException"}, {"shape":"EffectivePolicyNotFoundException"}, {"shape":"InvalidInputException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"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 management policies. It does not apply to authorization policies: service control policies (SCPs) and resource control policies (RCPs).
For more information about policy inheritance, see Understanding management policy inheritance in the Organizations User Guide.
You can call this operation from any account in a organization.
" }, "DescribeHandshake":{ "name":"DescribeHandshake", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHandshakeRequest"}, "output":{"shape":"DescribeHandshakeResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ConcurrentModificationException"}, {"shape":"HandshakeNotFoundException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Returns details for a handshake. A handshake is the secure exchange of information between two Amazon Web Services accounts: a sender and a recipient.
You can view ACCEPTED, DECLINED, or CANCELED handshakes in API Responses for 30 days before they are deleted.
You can call this operation from any account in a organization.
" }, "DescribeOrganization":{ "name":"DescribeOrganization", "http":{ "method":"POST", "requestUri":"/" }, "output":{"shape":"DescribeOrganizationResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Retrieves information about the organization that the user's account belongs to.
You can call this operation from any account in a organization.
Even if a policy type is shown as available in the organization, you can disable it separately at the root level with DisablePolicyType. Use ListRoots to see the status of policy types for a specified root.
Retrieves information about an organizational unit (OU).
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "DescribePolicy":{ "name":"DescribePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePolicyRequest"}, "output":{"shape":"DescribePolicyResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"InvalidInputException"}, {"shape":"PolicyNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"Retrieves information about a policy.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "DescribeResourcePolicy":{ "name":"DescribeResourcePolicy", "http":{ "method":"POST", "requestUri":"/" }, "output":{"shape":"DescribeResourcePolicyResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ServiceException"}, {"shape":"UnsupportedAPIEndpointException"}, {"shape":"TooManyRequestsException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ResourcePolicyNotFoundException"}, {"shape":"ConstraintViolationException"} ], "documentation":"Retrieves information about a resource policy.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "DescribeResponsibilityTransfer":{ "name":"DescribeResponsibilityTransfer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeResponsibilityTransferRequest"}, "output":{"shape":"DescribeResponsibilityTransferResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ResponsibilityTransferNotFoundException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"Returns details for a transfer. A transfer is an arrangement between two management accounts where one account designates the other with specified responsibilities for their organization.
" }, "DetachPolicy":{ "name":"DetachPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachPolicyRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"PolicyNotAttachedException"}, {"shape":"PolicyNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TargetNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"}, {"shape":"PolicyChangesInProgressException"} ], "documentation":"Detaches a policy from a target root, organizational unit (OU), or account.
If the policy being detached is a service control policy (SCP), the changes to permissions for Identity and Access Management (IAM) users and roles in affected accounts are immediate.
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\".
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "DisableAWSServiceAccess":{ "name":"DisableAWSServiceAccess", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableAWSServiceAccessRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"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.
We strongly recommend that you don't use this command to disable integration between Organizations and the specified Amazon Web Services service. Instead, use the console or commands that are provided by the specified service. This lets the trusted service perform any required initialization when enabling trusted access, such as creating any required resources and any required clean up of resources when disabling trusted access.
For information about how to disable trusted service access to your organization using the trusted service, see the Learn more link under the Supports Trusted Access column at Amazon Web Services services that you can use with Organizations. on this page.
If you disable access by using this command, it causes the following actions to occur:
The service can no longer create a service-linked role in the accounts in your organization. This means that 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.
The service can no longer perform tasks in the member accounts in the organization, unless those operations are explicitly permitted by the IAM policies that are attached to your roles. This includes any data aggregation from the member accounts to the management account, or to a delegated administrator account, where relevant.
Some services detect this and clean up any remaining data or resources related to the integration, while other services stop accessing the organization but leave any historical data and configuration in place to support a possible re-enabling of the integration.
Using the other service's console or commands to disable the integration ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other Amazon Web Services service.
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.
You can only call this operation from the management account.
" }, "DisablePolicyType":{ "name":"DisablePolicyType", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisablePolicyTypeRequest"}, "output":{"shape":"DisablePolicyTypeResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"PolicyTypeNotEnabledException"}, {"shape":"RootNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"}, {"shape":"PolicyChangesInProgressException"} ], "documentation":"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.
You can only call this operation from the management account or a member account that is a delegated administrator.
To view the status of available policy types in the organization, use ListRoots.
" }, "EnableAWSServiceAccess":{ "name":"EnableAWSServiceAccess", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableAWSServiceAccessRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"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.
We recommend that you enable integration between Organizations and the specified Amazon Web Services service by using the console or commands that are provided by the specified service. Doing so ensures that the service is aware that it can create the resources that are required for the integration. How the service creates those resources in the organization's accounts depends on that service. For more information, see the documentation for the other Amazon Web Services service.
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 management account.
" }, "EnableAllFeatures":{ "name":"EnableAllFeatures", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableAllFeaturesRequest"}, "output":{"shape":"EnableAllFeaturesResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"HandshakeConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"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.
This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake.
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.
You can only call this operation from the management account.
" }, "EnablePolicyType":{ "name":"EnablePolicyType", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnablePolicyTypeRequest"}, "output":{"shape":"EnablePolicyTypeResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"PolicyTypeAlreadyEnabledException"}, {"shape":"RootNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"PolicyTypeNotAvailableForOrganizationException"}, {"shape":"UnsupportedAPIEndpointException"}, {"shape":"PolicyChangesInProgressException"} ], "documentation":"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.
You can only call this operation from the management account or a member account that is a delegated administrator.
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 ListRoots.
" }, "InviteAccountToOrganization":{ "name":"InviteAccountToOrganization", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"InviteAccountToOrganizationRequest"}, "output":{"shape":"InviteAccountToOrganizationResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"AccountOwnerNotVerifiedException"}, {"shape":"ConcurrentModificationException"}, {"shape":"HandshakeConstraintViolationException"}, {"shape":"DuplicateHandshakeException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"FinalizingOrganizationException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"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 you receive an exception that indicates that you exceeded your account limits for the organization or that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists after an hour, contact Amazon Web Services Support.
If the request includes tags, then the requester must have the organizations:TagResource permission.
You can only call this operation from the management account.
" }, "InviteOrganizationToTransferResponsibility":{ "name":"InviteOrganizationToTransferResponsibility", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"InviteOrganizationToTransferResponsibilityRequest"}, "output":{"shape":"InviteOrganizationToTransferResponsibilityResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"DuplicateHandshakeException"}, {"shape":"HandshakeConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"Sends an invitation to another organization's management account to designate your account with the specified responsibilities for their organization. The invitation is implemented as a Handshake whose details are in the response.
You can only call this operation from the management account.
" }, "LeaveOrganization":{ "name":"LeaveOrganization", "http":{ "method":"POST", "requestUri":"/" }, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AccountNotFoundException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"MasterCannotLeaveOrganizationException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"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.
You can only call from operation from a member account.
When an account leaves an organization, Organizations logs a membership event in CloudTrail. The event is an AccountDepartedOrganization event with departedMethod:Left and departedTime. This event is available only in the management account's event history.
The management account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do. This includes preventing them from successfully calling LeaveOrganization and leaving the organization.
You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For each account that you want to make standalone, you must perform the following steps. If any of the steps are already completed for this account, that step doesn't appear.
Choose a support plan
Provide and verify the required contact information
Provide a current payment method
Amazon Web Services uses the payment method to charge for any billable (not free tier) Amazon Web Services activity that occurs while the account isn't attached to an organization. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.
The account that you want to leave must not be a delegated administrator account for any Amazon Web Services service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization.
After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. Amazon Web Services accounts outside of an organization do not support tags.
A newly created account has a waiting period before it can be removed from its organization. You must wait until at least four days after the account was created. Invited accounts aren't subject to this waiting period.
If you are using an organization principal to call LeaveOrganization across multiple accounts, you can only do this up to 5 accounts per second in a single organization.
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.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "ListAccounts":{ "name":"ListAccounts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAccountsRequest"}, "output":{"shape":"ListAccountsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"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.
When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "ListAccountsForParent":{ "name":"ListAccountsForParent", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAccountsForParentRequest"}, "output":{"shape":"ListAccountsForParentResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"InvalidInputException"}, {"shape":"ParentNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"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.
When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "ListAccountsWithInvalidEffectivePolicy":{ "name":"ListAccountsWithInvalidEffectivePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAccountsWithInvalidEffectivePolicyRequest"}, "output":{"shape":"ListAccountsWithInvalidEffectivePolicyResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConstraintViolationException"}, {"shape":"EffectivePolicyNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidInputException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"Lists all the accounts in an organization that have invalid effective policies. An invalid effective policy is an effective policy that fails validation checks, resulting in the effective policy not being fully enforced on all the intended accounts within an organization.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "ListChildren":{ "name":"ListChildren", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListChildrenRequest"}, "output":{"shape":"ListChildrenResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"InvalidInputException"}, {"shape":"ParentNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables you to traverse the tree structure that makes up this root.
When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "ListCreateAccountStatus":{ "name":"ListCreateAccountStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCreateAccountStatusRequest"}, "output":{"shape":"ListCreateAccountStatusResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"Lists the account creation requests that match the specified status that is currently being tracked for the organization.
When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "ListDelegatedAdministrators":{ "name":"ListDelegatedAdministrators", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDelegatedAdministratorsRequest"}, "output":{"shape":"ListDelegatedAdministratorsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"TooManyRequestsException"}, {"shape":"ServiceException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"Lists the Amazon Web Services accounts that are designated as delegated administrators in this organization.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "ListDelegatedServicesForAccount":{ "name":"ListDelegatedServicesForAccount", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDelegatedServicesForAccountRequest"}, "output":{"shape":"ListDelegatedServicesForAccountResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AccountNotFoundException"}, {"shape":"AccountNotRegisteredException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"TooManyRequestsException"}, {"shape":"ServiceException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"List the Amazon Web Services services for which the specified account is a delegated administrator.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "ListEffectivePolicyValidationErrors":{ "name":"ListEffectivePolicyValidationErrors", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEffectivePolicyValidationErrorsRequest"}, "output":{"shape":"ListEffectivePolicyValidationErrorsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConstraintViolationException"}, {"shape":"EffectivePolicyNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"AccountNotFoundException"}, {"shape":"InvalidInputException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"Lists all the validation errors on an effective policy for a specified account and policy type.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "ListHandshakesForAccount":{ "name":"ListHandshakesForAccount", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListHandshakesForAccountRequest"}, "output":{"shape":"ListHandshakesForAccountResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Lists the recent handshakes that you have received.
You can view CANCELED, ACCEPTED, DECLINED, or EXPIRED handshakes in API responses for 30 days before they are deleted.
You can call this operation from any account in a organization.
When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.
Lists the recent handshakes that you have sent.
You can view CANCELED, ACCEPTED, DECLINED, or EXPIRED handshakes in API responses for 30 days before they are deleted.
You can only call this operation from the management account or a member account that is a delegated administrator.
When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.
Lists transfers that allow you to manage the specified responsibilities for another organization. This operation returns both transfer invitations and transfers.
When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.
Lists the organizational units (OUs) in a parent organizational unit or root.
When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "ListOutboundResponsibilityTransfers":{ "name":"ListOutboundResponsibilityTransfers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListOutboundResponsibilityTransfersRequest"}, "output":{"shape":"ListOutboundResponsibilityTransfersResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"Lists transfers that allow an account outside your organization to manage the specified responsibilities for your organization. This operation returns both transfer invitations and transfers.
When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.
Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with ListChildren enables you to traverse the tree structure that makes up this root.
When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.
You can only call this operation from the management account or a member account that is a delegated administrator.
In the current release, a child can have only a single parent.
Retrieves the list of all policies in an organization of a specified type.
When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "ListPoliciesForTarget":{ "name":"ListPoliciesForTarget", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPoliciesForTargetRequest"}, "output":{"shape":"ListPoliciesForTargetResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TargetNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list.
When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "ListRoots":{ "name":"ListRoots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRootsRequest"}, "output":{"shape":"ListRootsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Lists the roots that are defined in the current organization.
When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.
You can only call this operation from the management account or a member account that is a delegated administrator.
Policy types can be enabled and disabled in roots. This is distinct from whether they're available in the organization. When you enable all features, you make policy types available for use in that organization. Individual policy types can then be enabled and disabled in a root. To see the availability of a policy type in an organization, use DescribeOrganization.
Lists tags that are attached to the specified resource.
You can attach tags to the following resources in Organizations.
Amazon Web Services account
Organization root
Organizational unit (OU)
Policy (any type)
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "ListTargetsForPolicy":{ "name":"ListTargetsForPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTargetsForPolicyRequest"}, "output":{"shape":"ListTargetsForPolicyResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"InvalidInputException"}, {"shape":"PolicyNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.
When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "MoveAccount":{ "name":"MoveAccount", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MoveAccountRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InvalidInputException"}, {"shape":"SourceParentNotFoundException"}, {"shape":"DestinationParentNotFoundException"}, {"shape":"DuplicateAccountException"}, {"shape":"AccountNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConcurrentModificationException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ServiceException"} ], "documentation":"Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU.
You can only call this operation from the management account.
" }, "PutResourcePolicy":{ "name":"PutResourcePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutResourcePolicyRequest"}, "output":{"shape":"PutResourcePolicyResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ServiceException"}, {"shape":"UnsupportedAPIEndpointException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InvalidInputException"}, {"shape":"ConstraintViolationException"}, {"shape":"AWSOrganizationsNotInUseException"} ], "documentation":"Creates or updates a resource policy.
You can only call this operation from the management account..
" }, "RegisterDelegatedAdministrator":{ "name":"RegisterDelegatedAdministrator", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterDelegatedAdministratorRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AccountAlreadyRegisteredException"}, {"shape":"AccountNotFoundException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"TooManyRequestsException"}, {"shape":"ServiceException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"Enables the specified member account to administer the Organizations features of the specified Amazon Web Services service. It grants read-only access to Organizations service data. The account still requires IAM permissions to access and administer the 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.
You can only call this operation from the management account.
" }, "RemoveAccountFromOrganization":{ "name":"RemoveAccountFromOrganization", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveAccountFromOrganizationRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AccountNotFoundException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"MasterCannotLeaveOrganizationException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Removes the specified account from the organization.
The removed account becomes a standalone account that isn't a member of any organization. It's no longer subject to any policies and is responsible for its own bill payments. The organization's management account is no longer charged for any expenses accrued by the member account after it's removed from the organization.
You can only call this operation from the management account. Member accounts can remove themselves with LeaveOrganization instead.
When an account is removed from an organization, Organizations logs a membership event in CloudTrail. The event is an AccountDepartedOrganization event with departedMethod:Removed and departedTime. This event is available only in the management account's event history.
You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For more information, see Considerations before removing an account from an organization in the Organizations User Guide.
The account that you want to leave must not be a delegated administrator account for any Amazon Web Services service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization.
After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. Amazon Web Services accounts outside of an organization do not support tags.
Adds one or more tags to the specified resource.
Currently, you can attach tags to the following resources in Organizations.
Amazon Web Services account
Organization root
Organizational unit (OU)
Policy (any type)
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "TerminateResponsibilityTransfer":{ "name":"TerminateResponsibilityTransfer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateResponsibilityTransferRequest"}, "output":{"shape":"TerminateResponsibilityTransferResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"ResponsibilityTransferNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"}, {"shape":"ResponsibilityTransferAlreadyInStatusException"}, {"shape":"InvalidResponsibilityTransferTransitionException"} ], "documentation":"Ends a transfer. A transfer is an arrangement between two management accounts where one account designates the other with specified responsibilities for their organization.
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ConcurrentModificationException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"TargetNotFoundException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Removes any tags with the specified keys from the specified resource.
You can attach tags to the following resources in Organizations.
Amazon Web Services account
Organization root
Organizational unit (OU)
Policy (any type)
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "UpdateOrganizationalUnit":{ "name":"UpdateOrganizationalUnit", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateOrganizationalUnitRequest"}, "output":{"shape":"UpdateOrganizationalUnitResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"DuplicateOrganizationalUnitException"}, {"shape":"InvalidInputException"}, {"shape":"OrganizationalUnitNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Renames the specified organizational unit (OU). The ID and ARN don't change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached.
You can only call this operation from the management account.
" }, "UpdatePolicy":{ "name":"UpdatePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePolicyRequest"}, "output":{"shape":"UpdatePolicyResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"DuplicatePolicyException"}, {"shape":"InvalidInputException"}, {"shape":"MalformedPolicyDocumentException"}, {"shape":"PolicyNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"}, {"shape":"PolicyChangesInProgressException"} ], "documentation":"Updates an existing policy with a new name, description, or content. If you don't supply any parameter, that value remains unchanged. You can't change a policy's type.
You can only call this operation from the management account or a member account that is a delegated administrator.
" }, "UpdateResponsibilityTransfer":{ "name":"UpdateResponsibilityTransfer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateResponsibilityTransferRequest"}, "output":{"shape":"UpdateResponsibilityTransferResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ResponsibilityTransferNotFoundException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], "documentation":"Updates a transfer. A transfer is the arrangement between two management accounts where one account designates the other with specified responsibilities for their organization.
You can update the name assigned to a transfer.
" } }, "shapes":{ "AWSOrganizationsNotInUseException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"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.
", "exception":true }, "AcceptHandshakeRequest":{ "type":"structure", "required":["HandshakeId"], "members":{ "HandshakeId":{ "shape":"HandshakeId", "documentation":"ID for the handshake that you want to accept.
The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lowercase letters or digits.
" } } }, "AcceptHandshakeResponse":{ "type":"structure", "members":{ "Handshake":{ "shape":"Handshake", "documentation":"A Handshake object. Contains details for the handshake.
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.
", "exception":true }, "AccessDeniedForDependencyException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "Reason":{"shape":"AccessDeniedForDependencyExceptionReason"} }, "documentation":"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.
The unique identifier (ID) of the account.
The regex pattern for an account ID string requires exactly 12 digits.
" }, "Arn":{ "shape":"AccountArn", "documentation":"The Amazon Resource Name (ARN) of the account.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
" }, "Email":{ "shape":"Email", "documentation":"The email address associated with the Amazon Web Services account.
The regex pattern for this parameter is a string of characters that represents a standard internet email address.
" }, "Name":{ "shape":"AccountName", "documentation":"The friendly name of the account.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
" }, "Status":{ "shape":"AccountStatus", "documentation":"The status of the account in the organization.
The Status parameter in the Account object will be retired on September 9, 2026. Although both the account State and account Status parameters are currently available in the Organizations APIs (DescribeAccount, ListAccounts, ListAccountsForParent), we recommend that you update your scripts or other code to use the State parameter instead of Status before September 9, 2026.
Each state represents a specific phase in the account lifecycle. Use this information to manage account access, automate workflows, or trigger actions based on account state changes.
For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the Organizations User Guide.
" }, "Paths":{ "shape":"Paths", "documentation":"The paths in the organization where the account exists.
" }, "JoinedMethod":{ "shape":"AccountJoinedMethod", "documentation":"The method by which the account joined the organization.
" }, "JoinedTimestamp":{ "shape":"Timestamp", "documentation":"The date the account became a part of the organization.
" } }, "documentation":"Contains information about an Amazon Web Services account that is a member of an organization.
" }, "AccountAlreadyClosedException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"You attempted to close an account that is already closed.
", "exception":true }, "AccountAlreadyRegisteredException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"The specified account is already a delegated administrator for this Amazon Web Services service.
", "exception":true }, "AccountArn":{ "type":"string", "pattern":"^arn:aws:organizations::\\d{12}:account\\/o-[a-z0-9]{10,32}\\/\\d{12}" }, "AccountId":{ "type":"string", "max":12, "pattern":"^\\d{12}$" }, "AccountJoinedMethod":{ "type":"string", "enum":[ "INVITED", "CREATED" ] }, "AccountName":{ "type":"string", "max":128, "min":1, "pattern":"[\\s\\S]*", "sensitive":true }, "AccountNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":" 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.
The specified account is not a delegated administrator for this Amazon Web Services service.
", "exception":true }, "AccountOwnerNotVerifiedException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"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.
", "exception":true }, "AccountState":{ "type":"string", "enum":[ "PENDING_ACTIVATION", "ACTIVE", "SUSPENDED", "PENDING_CLOSURE", "CLOSED" ] }, "AccountStatus":{ "type":"string", "enum":[ "ACTIVE", "SUSPENDED", "PENDING_CLOSURE" ] }, "Accounts":{ "type":"list", "member":{"shape":"Account"} }, "ActionType":{ "type":"string", "enum":[ "INVITE", "ENABLE_ALL_FEATURES", "APPROVE_ALL_FEATURES", "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE", "TRANSFER_RESPONSIBILITY" ] }, "AlreadyInOrganizationException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"This account is already a member of an organization. An account can belong to only one organization at a time.
", "exception":true }, "AttachPolicyRequest":{ "type":"structure", "required":[ "PolicyId", "TargetId" ], "members":{ "PolicyId":{ "shape":"PolicyId", "documentation":"ID for the policy that you want to attach to the target. You can get the ID for the policy by calling the ListPolicies operation.
The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
" }, "TargetId":{ "shape":"PolicyTargetId", "documentation":"ID for the root, OU, or account that you want to attach the policy to. You can get the ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.
The regex pattern for a target ID string requires one of the following:
Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.
Account - A string that consists of exactly 12 digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
ID for the handshake that you want to cancel. You can get the ID from the ListHandshakesForOrganization operation.
The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lowercase letters or digits.
" } } }, "CancelHandshakeResponse":{ "type":"structure", "members":{ "Handshake":{ "shape":"Handshake", "documentation":"A Handshake object. Contains for the handshake that you canceled.
The unique identifier (ID) of this child entity.
The regex pattern for a child ID string requires one of the following:
Account - A string that consists of exactly 12 digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
The type of this child entity.
" } }, "documentation":"Contains a list of child entities, either OUs or accounts.
" }, "ChildId":{ "type":"string", "max":100, "pattern":"^(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" }, "ChildNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"We can't find an organizational unit (OU) or Amazon Web Services account with the ChildId that you specified.
Retrieves the Amazon Web Services account Id for the current CloseAccount API request.
The target of the operation is currently being modified by a different request. Try again later.
", "exception":true }, "ConflictException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"The request failed because it conflicts with the current state of the specified resource.
", "exception":true }, "ConstraintViolationException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "Reason":{"shape":"ConstraintViolationExceptionReason"} }, "documentation":"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.
ACTIVE_RESPONSIBILITY_TRANSFER_PROCESS: You cannot delete organization due to an ongoing responsibility transfer process. For example, a pending invitation or an in-progress transfer. To delete the organization, you must resolve the current transfer process.
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.
ALL_FEATURES_MIGRATION_ORGANIZATION_SIZE_LIMIT_EXCEEDED: Your organization has more than 5000 accounts, and you can only use the standard migration process for organizations with less than 5000 accounts. Use the assisted migration process to enable all features mode, or create a support case for assistance if you are unable to use assisted migration.
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 verification 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.
POLICY_TYPE_ENABLED_FOR_THIS_SERVICE: You attempted to disable service access before you disabled the policy type (for example, SECURITYHUB_POLICY). To complete this operation, you must first disable the policy type.
RESPONSIBILITY_TRANSFER_MAX_INBOUND_QUOTA_VIOLATION: You have exceeded your inbound transfers limit.
RESPONSIBILITY_TRANSFER_MAX_LEVEL_VIOLATION: You have exceeded the maximum length of your transfer chain.
RESPONSIBILITY_TRANSFER_MAX_OUTBOUND_QUOTA_VIOLATION: You have exceeded your outbound transfers limit.
RESPONSIBILITY_TRANSFER_MAX_TRANSFERS_QUOTA_VIOLATION: You have exceeded the maximum number of inbound transfers allowed in a transfer chain.
SERVICE_ACCESS_NOT_ENABLED:
You attempted to register a delegated administrator before you enabled service access. Call the EnableAWSServiceAccess API first.
You attempted to enable a policy type 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.
TRANSFER_RESPONSIBILITY_SOURCE_DELETION_IN_PROGRESS: The source organization cannot accept this transfer invitation because it is marked for deletion.
TRANSFER_RESPONSIBILITY_TARGET_DELETION_IN_PROGRESS: The source organization cannot accept this transfer invitation because target organization is marked for deletion.
UNSUPPORTED_PRICING: Your organization has a pricing contract that is unsupported.
WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, you must wait until at least four days after the account was created. Invited accounts aren't subject to this waiting period.
The email address of the owner to assign to the new member account. This email address must not already be associated with another Amazon Web Services account. You must use a valid email address to complete account creation.
The rules for a valid email address:
The address must be a minimum of 6 and a maximum of 64 characters long.
All characters must be 7-bit ASCII characters.
There must be one and only one @ symbol, which separates the local name from the domain name.
The local name can't contain any of the following characters:
whitespace, \" ' ( ) < > [ ] : ; , \\ | % &
The local name can't begin with a dot (.)
The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.)
The domain name can't begin or end with a hyphen (-) or dot (.)
The domain name must contain at least one dot
You can't access the root user of the account or remove an account that was created with an invalid email address.
" }, "AccountName":{ "shape":"CreateAccountName", "documentation":"The friendly name of the member account.
" }, "RoleName":{ "shape":"RoleName", "documentation":"The name of an IAM role that Organizations automatically preconfigures in the new member account. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account.
If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole.
For more information about how to use this role to access the member account, see the following links:
Creating the OrganizationAccountAccessRole in an invited member account in the Organizations User Guide
Steps 2 and 3 in IAM Tutorial: Delegate access across Amazon Web Services accounts using IAM roles in the IAM User Guide
The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-
" }, "IamUserAccessToBilling":{ "shape":"IAMUserAccessToBilling", "documentation":"If set to ALLOW, the new account enables IAM users to access account billing information if they have the required permissions. If set to DENY, only the root user of the new account can access account billing information. For more information, see About IAM access to the Billing and Cost Management console in the Amazon Web Services Billing and Cost Management User Guide.
If you don't specify this parameter, the value defaults to ALLOW, and IAM users and roles with the required permissions can access billing information for the new account.
A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.
If any one of the tags is not valid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created.
A structure that contains details about the request to create an account. This response structure might not be fully populated when you first receive it because account creation is an asynchronous process. You can pass the returned CreateAccountStatus ID as a parameter to DescribeCreateAccountStatus to get status about the progress of the request at later times. You can also check the CloudTrail log for the CreateAccountResult event. For more information, see Logging and monitoring in Organizations in the Organizations User Guide.
The unique identifier (ID) that references this request. You get this value from the response of the initial CreateAccount request to create the account.
The regex pattern for a create account request ID string requires \"car-\" followed by from 8 to 32 lowercase letters or digits.
" }, "AccountName":{ "shape":"CreateAccountName", "documentation":"The account name given to the account when it was created.
" }, "State":{ "shape":"CreateAccountState", "documentation":"The status of the asynchronous request to create an Amazon Web Services account.
" }, "RequestedTimestamp":{ "shape":"Timestamp", "documentation":"The date and time that the request was made for the account creation.
" }, "CompletedTimestamp":{ "shape":"Timestamp", "documentation":"The date and time that the account was created and the request completed.
" }, "AccountId":{ "shape":"AccountId", "documentation":"If the account was created successfully, the unique identifier (ID) of the new account.
The regex pattern for an account ID string requires exactly 12 digits.
" }, "GovCloudAccountId":{ "shape":"AccountId", "documentation":"If the account was created successfully, the ID for the new account in the Amazon Web Services GovCloud (US) Region.
" }, "FailureReason":{ "shape":"CreateAccountFailureReason", "documentation":"If the request failed, a description of the reason for the failure.
ACCOUNT_LIMIT_EXCEEDED: The account couldn't be created because you reached the limit on the number of accounts in your organization.
CONCURRENT_ACCOUNT_MODIFICATION: You already submitted a request with the same information.
EMAIL_ALREADY_EXISTS: The account could not be created because another Amazon Web Services account with that email address already exists.
FAILED_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization failed to receive business license validation.
GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the Amazon Web Services GovCloud (US) Region could not be created because this Region already includes an account with that email address.
IDENTITY_INVALID_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization can't complete business license validation because it doesn't have valid identity data.
INVALID_ADDRESS: The account could not be created because the address you provided is not valid.
INVALID_EMAIL: The account could not be created because the email address you provided is not valid.
INVALID_PAYMENT_INSTRUMENT: The Amazon Web Services account that owns your organization does not have a supported payment method 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.
INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact Amazon Web Services Customer Support.
MISSING_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization has not received Business Validation.
MISSING_PAYMENT_INSTRUMENT: You must configure the management account with a valid payment method, such as a credit card.
PENDING_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization is still in the process of completing business license validation.
UNKNOWN_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization has an unknown issue with business license validation.
Contains the status about a CreateAccount or CreateGovCloudAccount request to create an Amazon Web Services account or an Amazon Web Services GovCloud (US) account in an organization.
" }, "CreateAccountStatusNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"We can't find an create account request with the CreateAccountRequestId that you specified.
Specifies the email address of the owner to assign to the new member account in the commercial Region. This email address must not already be associated with another Amazon Web Services account. You must use a valid email address to complete account creation.
The rules for a valid email address:
The address must be a minimum of 6 and a maximum of 64 characters long.
All characters must be 7-bit ASCII characters.
There must be one and only one @ symbol, which separates the local name from the domain name.
The local name can't contain any of the following characters:
whitespace, \" ' ( ) < > [ ] : ; , \\ | % &
The local name can't begin with a dot (.)
The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.)
The domain name can't begin or end with a hyphen (-) or dot (.)
The domain name must contain at least one dot
You can't access the root user of the account or remove an account that was created with an invalid email address. Like all request parameters for CreateGovCloudAccount, the request for the email address for the Amazon Web Services GovCloud (US) account originates from the commercial Region, not from the Amazon Web Services GovCloud (US) Region.
The friendly name of the member account.
The account name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) You can't separate characters with a dash (–).
" }, "RoleName":{ "shape":"RoleName", "documentation":"(Optional)
The name of an IAM role that Organizations automatically preconfigures in the new member accounts in both the Amazon Web Services GovCloud (US) Region and in the commercial Region. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account.
If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole.
For more information about how to use this role to access the member account, see the following links:
Creating the OrganizationAccountAccessRole in an invited member account in the Organizations User Guide
Steps 2 and 3 in IAM Tutorial: Delegate access across Amazon Web Services accounts using IAM roles in the IAM User Guide
The regex pattern that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-
" }, "IamUserAccessToBilling":{ "shape":"IAMUserAccessToBilling", "documentation":"If set to ALLOW, the new linked account in the commercial Region enables IAM users to access account billing information if they have the required permissions. If set to DENY, only the root user of the new account can access account billing information. For more information, see About IAM access to the Billing and Cost Management console in the Amazon Web Services Billing and Cost Management User Guide.
If you don't specify this parameter, the value defaults to ALLOW, and IAM users and roles with the required permissions can access billing information for the new account.
A list of tags that you want to attach to the newly created account. These tags are attached to the commercial account associated with the GovCloud account, and not to the GovCloud account itself. To add tags to the actual GovCloud account, call the TagResource operation in the GovCloud region after the new GovCloud account exists.
For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.
If any one of the tags is not valid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created.
Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.
CONSOLIDATED_BILLING: All member accounts have their bills consolidated to and paid by the management account. For more information, see Consolidated billing in the Organizations User Guide.
The consolidated billing feature subset isn't available for organizations in the Amazon Web Services GovCloud (US) Region.
ALL: In addition to all the features supported by the consolidated billing feature set, the management account can also apply any policy type to any member account in the organization. For more information, see All features in the Organizations User Guide.
A structure that contains details about the newly created organization.
" } } }, "CreateOrganizationalUnitRequest":{ "type":"structure", "required":[ "ParentId", "Name" ], "members":{ "ParentId":{ "shape":"ParentId", "documentation":"ID for the parent root or OU that you want to create the new OU in.
The regex pattern for a parent ID string requires one of the following:
Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
The friendly name to assign to the new OU.
" }, "Tags":{ "shape":"Tags", "documentation":"A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.
If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire request fails and the OU is not created.
A structure that contains details about the newly created OU.
" } } }, "CreatePolicyRequest":{ "type":"structure", "required":[ "Content", "Description", "Name", "Type" ], "members":{ "Content":{ "shape":"PolicyContent", "documentation":"The policy text content to add to the new policy. The text that you supply must adhere to the rules of the policy type you specify in the Type parameter.
The maximum size of a policy document depends on the policy's type. For more information, see Maximum and minimum values in the Organizations User Guide.
" }, "Description":{ "shape":"PolicyDescription", "documentation":"An optional description to assign to the policy.
" }, "Name":{ "shape":"PolicyName", "documentation":"The friendly name to assign to the policy.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
" }, "Type":{ "shape":"PolicyType", "documentation":"The type of policy to create. You can specify one of the following values:
A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.
If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the entire request fails and the policy is not created.
A structure that contains details about the newly created policy.
" } } }, "DeclineHandshakeRequest":{ "type":"structure", "required":["HandshakeId"], "members":{ "HandshakeId":{ "shape":"HandshakeId", "documentation":"ID for the handshake that you want to decline. You can get the ID from the ListHandshakesForAccount operation.
The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lowercase letters or digits.
" } } }, "DeclineHandshakeResponse":{ "type":"structure", "members":{ "Handshake":{ "shape":"Handshake", "documentation":"A Handshake object. Contains details for the declined handshake.
The unique identifier (ID) of the delegated administrator's account.
" }, "Arn":{ "shape":"AccountArn", "documentation":"The Amazon Resource Name (ARN) of the delegated administrator's account.
" }, "Email":{ "shape":"Email", "documentation":"The email address that is associated with the delegated administrator's Amazon Web Services account.
" }, "Name":{ "shape":"AccountName", "documentation":"The friendly name of the delegated administrator's account.
" }, "Status":{ "shape":"AccountStatus", "documentation":"The status of the delegated administrator's account in the organization.
" }, "State":{ "shape":"AccountState", "documentation":"Each state represents a specific phase in the account lifecycle. Use this information to manage account access, automate workflows, or trigger actions based on account state changes.
For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the Organizations User Guide.
" }, "JoinedMethod":{ "shape":"AccountJoinedMethod", "documentation":"The method by which the delegated administrator's account joined the organization.
" }, "JoinedTimestamp":{ "shape":"Timestamp", "documentation":"The date when the delegated administrator's account became a part of the organization.
" }, "DelegationEnabledDate":{ "shape":"Timestamp", "documentation":"The date when the account was made a delegated administrator.
" } }, "documentation":"Contains information about the delegated administrator.
" }, "DelegatedAdministrators":{ "type":"list", "member":{"shape":"DelegatedAdministrator"} }, "DelegatedService":{ "type":"structure", "members":{ "ServicePrincipal":{ "shape":"ServicePrincipal", "documentation":"The name of an Amazon Web Services service that can request an operation for the specified service. This is typically in the form of a URL, such as: servicename.amazonaws.com.
The date that the account became a delegated administrator for this service.
" } }, "documentation":"Contains information about the Amazon Web Services service for which the account is a delegated administrator.
" }, "DelegatedServices":{ "type":"list", "member":{"shape":"DelegatedService"} }, "DeleteOrganizationalUnitRequest":{ "type":"structure", "required":["OrganizationalUnitId"], "members":{ "OrganizationalUnitId":{ "shape":"OrganizationalUnitId", "documentation":"ID for the organizational unit that you want to delete. You can get the ID from the ListOrganizationalUnitsForParent operation.
The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
" } } }, "DeletePolicyRequest":{ "type":"structure", "required":["PolicyId"], "members":{ "PolicyId":{ "shape":"PolicyId", "documentation":"ID for the policy that you want to delete. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.
The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
" } } }, "DeregisterDelegatedAdministratorRequest":{ "type":"structure", "required":[ "AccountId", "ServicePrincipal" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The account ID number of the member account in the organization that you want to deregister as a delegated administrator.
" }, "ServicePrincipal":{ "shape":"ServicePrincipal", "documentation":"The service principal name of an Amazon Web Services service for which the account is a delegated administrator.
Delegated administrator privileges are revoked for only the specified Amazon Web Services service from the member account. If the specified service is the only service for which the member account is a delegated administrator, the operation also revokes Organizations read action permissions.
" } } }, "DescribeAccountRequest":{ "type":"structure", "required":["AccountId"], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The unique identifier (ID) of the Amazon Web Services account that you want information about. You can get the ID from the ListAccounts or ListAccountsForParent operations.
The regex pattern for an account ID string requires exactly 12 digits.
" } } }, "DescribeAccountResponse":{ "type":"structure", "members":{ "Account":{ "shape":"Account", "documentation":"A structure that contains information about the requested account.
The Status parameter in the API response will be retired on September 9, 2026. Although both the account State and account Status parameters are currently available in the Organizations APIs (DescribeAccount, ListAccounts, ListAccountsForParent), we recommend that you update your scripts or other code to use the State parameter instead of Status before September 9, 2026.
Specifies the Id value that uniquely identifies the CreateAccount request. You can get the value from the CreateAccountStatus.Id response in an earlier CreateAccount request, or from the ListCreateAccountStatus operation.
The regex pattern for a create account request ID string requires \"car-\" followed by from 8 to 32 lowercase letters or digits.
" } } }, "DescribeCreateAccountStatusResponse":{ "type":"structure", "members":{ "CreateAccountStatus":{ "shape":"CreateAccountStatus", "documentation":"A structure that contains the current status of an account creation request.
" } } }, "DescribeEffectivePolicyRequest":{ "type":"structure", "required":["PolicyType"], "members":{ "PolicyType":{ "shape":"EffectivePolicyType", "documentation":"The type of policy that you want information about. You can specify one of the following values:
When you're signed in as the management account, specify the ID of the account that you want details about. Specifying an organization root or organizational unit (OU) as the target is not supported.
" } } }, "DescribeEffectivePolicyResponse":{ "type":"structure", "members":{ "EffectivePolicy":{ "shape":"EffectivePolicy", "documentation":"The contents of the effective policy.
" } } }, "DescribeHandshakeRequest":{ "type":"structure", "required":["HandshakeId"], "members":{ "HandshakeId":{ "shape":"HandshakeId", "documentation":"ID for the handshake that you want information about.
The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lowercase letters or digits.
" } } }, "DescribeHandshakeResponse":{ "type":"structure", "members":{ "Handshake":{ "shape":"Handshake", "documentation":"A Handshake object. Contains details for the handshake.
A structure that contains information about the organization.
The AvailablePolicyTypes part of the response is deprecated, and you shouldn't use it in your apps. It doesn't include any policy type supported by Organizations other than SCPs. In the China (Ningxia) Region, no policy type is included. To determine which policy types are enabled in your organization, use the ListRoots operation.
ID for the organizational unit that you want details about. You can get the ID from the ListOrganizationalUnitsForParent operation.
The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
" } } }, "DescribeOrganizationalUnitResponse":{ "type":"structure", "members":{ "OrganizationalUnit":{ "shape":"OrganizationalUnit", "documentation":"A structure that contains details about the specified OU.
" } } }, "DescribePolicyRequest":{ "type":"structure", "required":["PolicyId"], "members":{ "PolicyId":{ "shape":"PolicyId", "documentation":"ID for the policy that you want details about. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.
The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
" } } }, "DescribePolicyResponse":{ "type":"structure", "members":{ "Policy":{ "shape":"Policy", "documentation":"A structure that contains details about the specified policy.
" } } }, "DescribeResourcePolicyResponse":{ "type":"structure", "members":{ "ResourcePolicy":{ "shape":"ResourcePolicy", "documentation":"A structure that contains details about the resource policy.
" } } }, "DescribeResponsibilityTransferRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"ResponsibilityTransferId", "documentation":"ID for the transfer.
" } } }, "DescribeResponsibilityTransferResponse":{ "type":"structure", "members":{ "ResponsibilityTransfer":{ "shape":"ResponsibilityTransfer", "documentation":"A ResponsibilityTransfer object. Contains details for a transfer.
We can't find the destination container (a root or OU) with the ParentId that you specified.
ID for the policy you want to detach. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.
The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
" }, "TargetId":{ "shape":"PolicyTargetId", "documentation":"ID for the root, OU, or account that you want to detach the policy from. You can get the ID from the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.
The regex pattern for a target ID string requires one of the following:
Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.
Account - A string that consists of exactly 12 digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
The service principal name of the Amazon Web Services service for which you want to disable integration with your organization. This is typically in the form of a URL, such as service-abbreviation.amazonaws.com.
ID for the root in which you want to disable a policy type. You can get the ID from the ListRoots operation.
The regex pattern for a root ID string requires \"r-\" followed by from 4 to 32 lowercase letters or digits.
" }, "PolicyType":{ "shape":"PolicyType", "documentation":"The policy type that you want to disable in this root. You can specify one of the following values:
A structure that shows the root with the updated list of enabled policy types.
" } } }, "DuplicateAccountException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"That account is already present in the specified destination.
", "exception":true }, "DuplicateHandshakeException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"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.
", "exception":true }, "DuplicateOrganizationalUnitException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"An OU with the same name already exists.
", "exception":true }, "DuplicatePolicyAttachmentException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"The selected policy is already attached to the specified target.
", "exception":true }, "DuplicatePolicyException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"A policy with the same name already exists.
", "exception":true }, "EffectivePolicy":{ "type":"structure", "members":{ "PolicyContent":{ "shape":"PolicyContent", "documentation":"The text content of the policy.
" }, "LastUpdatedTimestamp":{ "shape":"Timestamp", "documentation":"The time of the last update to this policy.
" }, "TargetId":{ "shape":"PolicyTargetId", "documentation":"The account ID of the policy target.
" }, "PolicyType":{ "shape":"EffectivePolicyType", "documentation":"The policy type.
" } }, "documentation":"Contains rules to be applied to the affected accounts. The effective policy is the aggregation of any policies the account inherits, plus any policy directly attached to the account.
" }, "EffectivePolicyNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"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.
", "exception":true }, "EffectivePolicyType":{ "type":"string", "enum":[ "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY", "INSPECTOR_POLICY", "UPGRADE_ROLLOUT_POLICY", "BEDROCK_POLICY", "S3_POLICY", "NETWORK_SECURITY_DIRECTOR_POLICY" ] }, "EffectivePolicyValidationError":{ "type":"structure", "members":{ "ErrorCode":{ "shape":"ErrorCode", "documentation":"The error code for the validation error. For example, ELEMENTS_TOO_MANY.
The error message for the validation error.
" }, "PathToError":{ "shape":"PathToError", "documentation":"The path within the effective policy where the validation error occurred.
" }, "ContributingPolicies":{ "shape":"PolicyIds", "documentation":"The individual policies inherited and attached to the account which contributed to the validation error.
" } }, "documentation":"Contains details about the validation errors that occurred when generating or enforcing an effective policy, such as which policies contributed to the error and location of the error.
" }, "EffectivePolicyValidationErrors":{ "type":"list", "member":{"shape":"EffectivePolicyValidationError"} }, "Email":{ "type":"string", "max":64, "min":6, "pattern":"[^\\s@]+@[^\\s@]+\\.[^\\s@]+", "sensitive":true }, "EnableAWSServiceAccessRequest":{ "type":"structure", "required":["ServicePrincipal"], "members":{ "ServicePrincipal":{ "shape":"ServicePrincipal", "documentation":"The service principal name of the Amazon Web Services service for which you want to enable integration with your organization. This is typically in the form of a URL, such as service-abbreviation.amazonaws.com.
A structure that contains details about the handshake created to support this request to enable all features in the organization.
" } } }, "EnablePolicyTypeRequest":{ "type":"structure", "required":[ "RootId", "PolicyType" ], "members":{ "RootId":{ "shape":"RootId", "documentation":"ID for the root in which you want to enable a policy type. You can get the ID from the ListRoots operation.
The regex pattern for a root ID string requires \"r-\" followed by from 4 to 32 lowercase letters or digits.
" }, "PolicyType":{ "shape":"PolicyType", "documentation":"The policy type that you want to enable. You can specify one of the following values:
A structure that shows the root with the updated list of enabled policy types.
" } } }, "EnabledServicePrincipal":{ "type":"structure", "members":{ "ServicePrincipal":{ "shape":"ServicePrincipal", "documentation":"The name of the service principal. This is typically in the form of a URL, such as: servicename.amazonaws.com.
The date that the service principal was enabled for integration with Organizations.
" } }, "documentation":"A structure that contains details of a service principal that represents an Amazon Web Services service that is enabled to integrate with Organizations.
" }, "EnabledServicePrincipals":{ "type":"list", "member":{"shape":"EnabledServicePrincipal"} }, "ErrorCode":{"type":"string"}, "ErrorMessage":{"type":"string"}, "ExceptionMessage":{"type":"string"}, "ExceptionType":{"type":"string"}, "FinalizingOrganizationException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"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.
", "exception":true }, "GenericArn":{ "type":"string", "pattern":"^arn:aws:organizations::.+:.+" }, "Handshake":{ "type":"structure", "members":{ "Id":{ "shape":"HandshakeId", "documentation":"ID for the handshake.
The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lowercase letters or digits.
" }, "Arn":{ "shape":"HandshakeArn", "documentation":"Amazon Resource Name (ARN) for the handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
" }, "Parties":{ "shape":"HandshakeParties", "documentation":"An array of HandshakeParty objects. Contains details for participant in a handshake.
Current state for the handshake.
REQUESTED: Handshake awaiting a response from the recipient.
OPEN: Handshake sent to multiple recipients and all recipients have responded. The sender can now complete the handshake action.
CANCELED: Handshake canceled by the sender.
ACCEPTED: Handshake accepted by the recipient.
DECLINED: Handshake declined by the recipient.
EXPIRED: Handshake has expired.
Timestamp when the handshake request was made.
" }, "ExpirationTimestamp":{ "shape":"Timestamp", "documentation":"Timestamp when the handshake expires.
" }, "Action":{ "shape":"ActionType", "documentation":"The type of handshake:
INVITE: Handshake sent to a standalone account requesting that it to join the sender's organization.
ENABLE_ALL_FEATURES: Handshake sent to invited member accounts to enable all features for the organization.
APPROVE_ALL_FEATURES: Handshake sent to the management account when all invited member accounts have approved to enable all features.
TRANSFER_RESPONSIBILITY: Handshake sent to another organization's management account requesting that it designate the sender with the specified responsibilities for recipient's organization.
An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.
Contains details for a handshake. A handshake is the secure exchange of information between two Amazon Web Services accounts: a sender and a recipient.
Note: Handshakes that are CANCELED, ACCEPTED, DECLINED, or EXPIRED show up in lists for only 30 days after entering that state After that they are deleted.
The specified handshake is already in the requested state. For example, you can't accept a handshake that was already accepted.
", "exception":true }, "HandshakeArn":{ "type":"string", "pattern":"^arn:aws:organizations::\\d{12}:handshake\\/o-[a-z0-9]{10,32}\\/[a-z_]{1,32}\\/h-[0-9a-z]{8,32}" }, "HandshakeConstraintViolationException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "Reason":{"shape":"HandshakeConstraintViolationExceptionReason"} }, "documentation":"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.
LEGACY_PERMISSIONS_STILL_IN_USE: Your organization must migrate to use the new IAM fine-grained actions for billing, cost management, and accounts.
ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.
ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization.
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_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.
RESPONSIBILITY_TRANSFER_ALREADY_EXISTS: You cannot perform this operation with the current transfer.
SOURCE_AND_TARGET_CANNOT_MATCH: An account can't accept a transfer invitation if it is both the sender and recipient of the invitation.
UNUSED_PREPAYMENT_BALANCE: Your organization has an outstanding pre-payment balance.
The type of handshake.
If you specify ActionType, you cannot also specify ParentHandshakeId.
The parent handshake. Only used for handshake types that are a child of another type.
If you specify ParentHandshakeId, you cannot also specify ActionType.
The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lowercase letters or digits.
" } }, "documentation":"Contains the filter used to select the handshakes for an operation.
" }, "HandshakeId":{ "type":"string", "max":34, "pattern":"^h-[0-9a-z]{8,32}$" }, "HandshakeNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"We can't find a handshake with the HandshakeId that you specified.
ID for the participant: Acccount ID, organization ID, or email address.
The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lowercase letters or digits.
" }, "Type":{ "shape":"HandshakePartyType", "documentation":"The type of ID for the participant.
" } }, "documentation":"Contains details for a participant in a handshake.
" }, "HandshakePartyId":{ "type":"string", "max":64, "min":1, "pattern":"[\\s\\S]*", "sensitive":true }, "HandshakePartyType":{ "type":"string", "enum":[ "ACCOUNT", "ORGANIZATION", "EMAIL" ] }, "HandshakeResource":{ "type":"structure", "members":{ "Value":{ "shape":"HandshakeResourceValue", "documentation":"Additional information for the handshake. The format of the value string must match the requirements of the specified type.
" }, "Type":{ "shape":"HandshakeResourceType", "documentation":"The type of information being passed, specifying how the value is to be interpreted by the other party:
ACCOUNT: ID for an Amazon Web Services account.
ORGANIZATION: ID for an organization.
EMAIL: Email address for the recipient.
OWNER_EMAIL: Email address for the sender.
OWNER_NAME: Name of the sender.
NOTES: Additional text included by the sender for the recipient.
An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.
Contains additional details for a handshake.
" }, "HandshakeResourceType":{ "type":"string", "enum":[ "ACCOUNT", "ORGANIZATION", "ORGANIZATION_FEATURE_SET", "EMAIL", "MASTER_EMAIL", "MASTER_NAME", "NOTES", "PARENT_HANDSHAKE", "RESPONSIBILITY_TRANSFER", "TRANSFER_START_TIMESTAMP", "TRANSFER_TYPE", "MANAGEMENT_ACCOUNT", "MANAGEMENT_EMAIL", "MANAGEMENT_NAME" ] }, "HandshakeResourceValue":{ "type":"string", "sensitive":true }, "HandshakeResources":{ "type":"list", "member":{"shape":"HandshakeResource"} }, "HandshakeState":{ "type":"string", "enum":[ "REQUESTED", "OPEN", "CANCELED", "ACCEPTED", "DECLINED", "EXPIRED" ] }, "Handshakes":{ "type":"list", "member":{"shape":"Handshake"} }, "IAMUserAccessToBilling":{ "type":"string", "enum":[ "ALLOW", "DENY" ] }, "InvalidHandshakeTransitionException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"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.
", "exception":true }, "InvalidInputException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "Reason":{"shape":"InvalidInputExceptionReason"} }, "documentation":"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.
CALLER_REQUIRED_FIELD_MISSING: At least one of the required field is missing: Caller Account Id, Management Account Id or Organization Id.
DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.
END_DATE_NOT_END_OF_MONTH: You provided an invalid end date. The end date must be the end of the last day of the month (23.59.59.999).
END_DATE_TOO_EARLY: You provided an invalid end date. The end date is too early.
END_DATE_TOO_LATE: You provided an invalid end date. The end date is too late.
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_END_DATE: The selected withdrawal date doesn't meet the terms of your partner agreement. Visit Amazon Web Services Partner Central to view your partner agreements or contact your Amazon Web Services Partner for help.
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_PRINCIPAL: You specified an invalid principal element in the policy.
INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.
INVALID_START_DATE: The start date doesn't meet the minimum requirements.
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.
NON_DETACHABLE_POLICY: You can't detach this Amazon Web Services Managed Policy.
START_DATE_NOT_BEGINNING_OF_DAY: You provided an invalid start date. The start date must be the beginning of the day (00:00:00.000).
START_DATE_NOT_BEGINNING_OF_MONTH: You provided an invalid start date. The start date must be the first day of the month.
START_DATE_TOO_EARLY: You provided an invalid start date. The start date is too early.
START_DATE_TOO_LATE: You provided an invalid start date. The start date is too late.
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.
UNSUPPORTED_ACTION_IN_RESPONSIBILITY_TRANSFER: You provided a value that is not supported by this operation.
The responsibility transfer can't transition to the requested state because it's not in a valid state for this operation.
", "exception":true }, "InviteAccountToOrganizationRequest":{ "type":"structure", "required":["Target"], "members":{ "Target":{ "shape":"HandshakeParty", "documentation":"The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is a JSON object that contains the following elements:
{ \"Type\": \"ACCOUNT\", \"Id\": \"< account id number >\" }
If you use the CLI, you can submit this as a single string, similar to the following example:
--target Id=123456789012,Type=ACCOUNT
If you specify \"Type\": \"ACCOUNT\", you must provide the Amazon Web Services account ID number as the Id. If you specify \"Type\": \"EMAIL\", you must specify the email address that is associated with the account.
--target Id=diego@example.com,Type=EMAIL
Additional information that you want to include in the generated email to the recipient account owner.
" }, "Tags":{ "shape":"Tags", "documentation":"A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.
Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.
If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.
A structure that contains details about the handshake that is created to support this invitation request.
" } } }, "InviteOrganizationToTransferResponsibilityRequest":{ "type":"structure", "required":[ "Type", "Target", "StartTimestamp", "SourceName" ], "members":{ "Type":{ "shape":"ResponsibilityTransferType", "documentation":"The type of responsibility you want to designate to your organization. Currently, only BILLING is supported.
A HandshakeParty object. Contains details for the account you want to invite. Currently, only ACCOUNT and EMAIL are supported.
Additional information that you want to include in the invitation.
" }, "StartTimestamp":{ "shape":"Timestamp", "documentation":"Timestamp when the recipient will begin managing the specified responsibilities.
" }, "SourceName":{ "shape":"ResponsibilityTransferName", "documentation":"Name you want to assign to the transfer.
" }, "Tags":{ "shape":"Tags", "documentation":"A list of tags that you want to attach to the transfer. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.
Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the transfer. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.
If any one of the tags is not valid or if you exceed the allowed number of tags for a transfer, then the entire request fails and invitations are not sent.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
A list of the service principals for the services that are enabled to integrate with your organization. Each principal is a structure that includes the name and the date that it was enabled for integration with Organizations.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list.
" }, "NextToken":{ "shape":"NextToken", "documentation":"The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
A list of the accounts in the specified root or OU.
The Status parameter in the API response will be retired on September 9, 2026. Although both the account State and account Status parameters are currently available in the Organizations APIs (DescribeAccount, ListAccounts, ListAccountsForParent), we recommend that you update your scripts or other code to use the State parameter instead of Status before September 9, 2026.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
A list of objects in the organization.
The Status parameter in the API response will be retired on September 9, 2026. Although both the account State and account Status parameters are currently available in the Organizations APIs (DescribeAccount, ListAccounts, ListAccountsForParent), we recommend that you update your scripts or other code to use the State parameter instead of Status before September 9, 2026.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The type of policy that you want information about. You can specify one of the following values:
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
The accounts in the organization which have an invalid effective policy for the specified policy type.
" }, "PolicyType":{ "shape":"EffectivePolicyType", "documentation":"The specified policy type. One of the following values:
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The unique identifier (ID) for the parent root or OU whose children you want to list.
The regex pattern for a parent ID string requires one of the following:
Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
Filters the output to include only the specified child type.
" }, "NextToken":{ "shape":"NextToken", "documentation":"The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
The list of children of the specified parent container.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
A list of one or more states that you want included in the response. If this parameter isn't present, all requests are included in the response.
" }, "NextToken":{ "shape":"NextToken", "documentation":"The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
A list of objects with details about the requests. Certain elements, such as the accountId number, are present in the output only after the account has been successfully created.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Specifies a service principal name. If specified, then the operation lists the delegated administrators only for the specified service.
If you don't specify a service principal, the operation lists all delegated administrators for all services in your organization.
" }, "NextToken":{ "shape":"NextToken", "documentation":"The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
The list of delegated administrators in your organization.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The account ID number of a delegated administrator account in the organization.
" }, "NextToken":{ "shape":"NextToken", "documentation":"The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
The services for which the account is a delegated administrator.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The ID of the account that you want details about. Specifying an organization root or organizational unit (OU) as the target is not supported.
" }, "PolicyType":{ "shape":"EffectivePolicyType", "documentation":"The type of policy that you want information about. You can specify one of the following values:
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
The ID of the specified account.
" }, "PolicyType":{ "shape":"EffectivePolicyType", "documentation":"The specified policy type. One of the following values:
The path in the organization where the specified account exists.
" }, "EvaluationTimestamp":{ "shape":"Timestamp", "documentation":"The time when the latest effective policy was generated for the specified account.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The EffectivePolicyValidationError object contains details about the validation errors that occurred when generating or enforcing an effective policy, such as which policies contributed to the error and location of the error.
A HandshakeFilter object. Contains the filer used to select the handshakes for an operation.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
An array of Handshakeobjects. Contains details for a handshake.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
A HandshakeFilter object. Contains the filer used to select the handshakes for an operation.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
An array of Handshakeobjects. Contains details for a handshake.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The type of responsibility. Currently, only BILLING is supported.
ID for the transfer.
" }, "NextToken":{ "shape":"NextToken", "documentation":"The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
A ResponsibilityTransfers object. Contains details for a transfer.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
ID for the root or OU whose child OUs you want to list.
The regex pattern for a parent ID string requires one of the following:
Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
A list of the OUs in the specified root or parent OU.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The type of responsibility. Currently, only BILLING is supported.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
An array of ResponsibilityTransfer objects. Contains details for a transfer.
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
ID for the OU or account whose parent containers you want to list. Don't specify a root.
The regex pattern for a child ID string requires one of the following:
Account - A string that consists of exactly 12 digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
A list of parents for the specified child account or OU.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
ID for the root, organizational unit, or account whose policies you want to list.
The regex pattern for a target ID string requires one of the following:
Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.
Account - A string that consists of exactly 12 digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
The type of policy that you want to include in the returned list. You must specify one of the following values:
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
The list of policies that match the criteria in the request.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
Specifies the type of policy that you want to include in the response. You must specify one of the following values:
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
A list of policies that match the filter criteria in the request. The output list doesn't include the policy contents. To see the content for a policy, see DescribePolicy.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
A list of roots that are defined in an organization.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
The ID of the resource with the tags to list.
You can specify any of the following taggable resources.
Amazon Web Services account – specify the account ID number.
Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz
Root – specify the root ID that begins with r- and looks similar to: r-1a2b
Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The tags that are assigned to the resource.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
ID for the policy whose attachments you want to know.
The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
" }, "NextToken":{ "shape":"NextToken", "documentation":"The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.
A list of structures, each of which contains details about one of the entities to which the specified policy is attached.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
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.
", "exception":true }, "MasterCannotLeaveOrganizationException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"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.
", "exception":true }, "MaxResults":{ "type":"integer", "box":true, "max":20, "min":1 }, "MoveAccountRequest":{ "type":"structure", "required":[ "AccountId", "SourceParentId", "DestinationParentId" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"ID for the account that you want to move.
The regex pattern for an account ID string requires exactly 12 digits.
" }, "SourceParentId":{ "shape":"ParentId", "documentation":"ID for the root or organizational unit that you want to move the account from.
The regex pattern for a parent ID string requires one of the following:
Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
ID for the root or organizational unit that you want to move the account to.
The regex pattern for a parent ID string requires one of the following:
Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
The unique identifier (ID) of an organization.
The regex pattern for an organization ID string requires \"o-\" followed by from 10 to 32 lowercase letters or digits.
" }, "Arn":{ "shape":"OrganizationArn", "documentation":"The Amazon Resource Name (ARN) of an organization.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
" }, "FeatureSet":{ "shape":"OrganizationFeatureSet", "documentation":"Specifies the functionality that currently is available to the organization. If set to \"ALL\", then all features are enabled and policies can be applied to accounts in the organization. If set to \"CONSOLIDATED_BILLING\", then only consolidated billing functionality is available. For more information, see Enabling all features in your organization in the Organizations User Guide.
" }, "MasterAccountArn":{ "shape":"AccountArn", "documentation":"The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
" }, "MasterAccountId":{ "shape":"AccountId", "documentation":"The unique identifier (ID) of the management account of an organization.
The regex pattern for an account ID string requires exactly 12 digits.
" }, "MasterAccountEmail":{ "shape":"Email", "documentation":"The email address that is associated with the Amazon Web Services account that is designated as the management account for the organization.
" }, "AvailablePolicyTypes":{ "shape":"PolicyTypes", "documentation":"Do not use. This field is deprecated and doesn't provide complete information about the policies in your organization.
To determine the policies that are enabled and available for use in your organization, use the ListRoots operation instead.
" } }, "documentation":"Contains details about an organization. An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies .
" }, "OrganizationArn":{ "type":"string", "pattern":"^arn:aws:organizations::\\d{12}:organization\\/o-[a-z0-9]{10,32}" }, "OrganizationFeatureSet":{ "type":"string", "enum":[ "ALL", "CONSOLIDATED_BILLING" ] }, "OrganizationId":{ "type":"string", "pattern":"^o-[a-z0-9]{10,32}$" }, "OrganizationNotEmptyException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"The organization isn't empty. To delete an organization, you must first remove all accounts except the management account.
", "exception":true }, "OrganizationalUnit":{ "type":"structure", "members":{ "Id":{ "shape":"OrganizationalUnitId", "documentation":"The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
" }, "Arn":{ "shape":"OrganizationalUnitArn", "documentation":"The Amazon Resource Name (ARN) of this OU.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
" }, "Name":{ "shape":"OrganizationalUnitName", "documentation":"The friendly name of this OU.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
" }, "Path":{ "shape":"Path", "documentation":"The path in the organization where this OU exists.
" } }, "documentation":"Contains details about an organizational unit (OU). An OU is a container of Amazon Web Services accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.
" }, "OrganizationalUnitArn":{ "type":"string", "pattern":"^arn:aws:organizations::\\d{12}:ou\\/o-[a-z0-9]{10,32}\\/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}" }, "OrganizationalUnitId":{ "type":"string", "max":68, "pattern":"^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$" }, "OrganizationalUnitName":{ "type":"string", "max":128, "min":1, "pattern":"[\\s\\S]*" }, "OrganizationalUnitNotEmptyException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"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.
", "exception":true }, "OrganizationalUnitNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"We can't find an OU with the OrganizationalUnitId that you specified.
The unique identifier (ID) of the parent entity.
The regex pattern for a parent ID string requires one of the following:
Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
The type of the parent entity.
" } }, "documentation":"Contains information about either a root or an organizational unit (OU) that can contain OUs or accounts in an organization.
" }, "ParentId":{ "type":"string", "max":100, "pattern":"^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" }, "ParentNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"We can't find a root or OU with the ParentId that you specified.
A structure that contains additional details about the policy.
" }, "Content":{ "shape":"PolicyContent", "documentation":"The text content of the policy.
" } }, "documentation":"Contains rules to be applied to the affected accounts. Policies can be attached directly to accounts, or to roots and OUs to affect all accounts in those hierarchies.
" }, "PolicyArn":{ "type":"string", "pattern":"^(arn:aws:organizations::\\d{12}:policy\\/o-[a-z0-9]{10,32}\\/[0-9a-z_]+\\/p-[0-9a-z]{10,32})|(arn:aws:organizations::aws:policy\\/[0-9a-z_]+\\/p-[0-9a-zA-Z_]{10,128})" }, "PolicyChangesInProgressException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"Changes to the effective policy are in progress, and its contents can't be returned. Try the operation again later.
", "exception":true }, "PolicyContent":{ "type":"string", "min":1, "pattern":"[\\s\\S]*" }, "PolicyDescription":{ "type":"string", "max":512, "pattern":"[\\s\\S]*" }, "PolicyId":{ "type":"string", "max":130, "pattern":"^p-[0-9a-zA-Z_]{8,128}$" }, "PolicyIds":{ "type":"list", "member":{"shape":"PolicyId"} }, "PolicyInUseException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"The policy is attached to one or more entities. You must detach it from all roots, OUs, and accounts before performing this operation.
", "exception":true }, "PolicyName":{ "type":"string", "max":128, "min":1, "pattern":"[\\s\\S]*" }, "PolicyNotAttachedException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"The policy isn't attached to the specified target in the specified root.
", "exception":true }, "PolicyNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"We can't find a policy with the PolicyId that you specified.
The unique identifier (ID) of the policy.
The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
" }, "Arn":{ "shape":"PolicyArn", "documentation":"The Amazon Resource Name (ARN) of the policy.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
" }, "Name":{ "shape":"PolicyName", "documentation":"The friendly name of the policy.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
" }, "Description":{ "shape":"PolicyDescription", "documentation":"The description of the policy.
" }, "Type":{ "shape":"PolicyType", "documentation":"The type of policy.
" }, "AwsManaged":{ "shape":"AwsManagedPolicy", "documentation":"A boolean value that indicates whether the specified policy is an Amazon Web Services managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
" } }, "documentation":"Contains information about a policy, but does not include the content. To see the content of a policy, see DescribePolicy.
" }, "PolicyTargetId":{ "type":"string", "max":100, "pattern":"^(r-[0-9a-z]{4,32})|(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" }, "PolicyTargetSummary":{ "type":"structure", "members":{ "TargetId":{ "shape":"PolicyTargetId", "documentation":"The unique identifier (ID) of the policy target.
The regex pattern for a target ID string requires one of the following:
Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or digits.
Account - A string that consists of exactly 12 digits.
Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
The Amazon Resource Name (ARN) of the policy target.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
" }, "Name":{ "shape":"TargetName", "documentation":"The friendly name of the policy target.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
" }, "Type":{ "shape":"TargetType", "documentation":"The type of the policy target.
" } }, "documentation":"Contains information about a root, OU, or account that a policy is attached to.
" }, "PolicyTargets":{ "type":"list", "member":{"shape":"PolicyTargetSummary"} }, "PolicyType":{ "type":"string", "enum":[ "SERVICE_CONTROL_POLICY", "RESOURCE_CONTROL_POLICY", "TAG_POLICY", "BACKUP_POLICY", "AISERVICES_OPT_OUT_POLICY", "CHATBOT_POLICY", "DECLARATIVE_POLICY_EC2", "SECURITYHUB_POLICY", "INSPECTOR_POLICY", "UPGRADE_ROLLOUT_POLICY", "BEDROCK_POLICY", "S3_POLICY", "NETWORK_SECURITY_DIRECTOR_POLICY" ] }, "PolicyTypeAlreadyEnabledException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"The specified policy type is already enabled in the specified root.
", "exception":true }, "PolicyTypeNotAvailableForOrganizationException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"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.
", "exception":true }, "PolicyTypeNotEnabledException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"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.
", "exception":true }, "PolicyTypeStatus":{ "type":"string", "enum":[ "ENABLED", "PENDING_ENABLE", "PENDING_DISABLE" ] }, "PolicyTypeSummary":{ "type":"structure", "members":{ "Type":{ "shape":"PolicyType", "documentation":"The name of the policy type.
" }, "Status":{ "shape":"PolicyTypeStatus", "documentation":"The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.
" } }, "documentation":"Contains information about a policy type and its status in the associated root.
" }, "PolicyTypes":{ "type":"list", "member":{"shape":"PolicyTypeSummary"} }, "PutResourcePolicyRequest":{ "type":"structure", "required":["Content"], "members":{ "Content":{ "shape":"ResourcePolicyContent", "documentation":"If provided, the new content for the resource policy. The text must be correctly formatted JSON that complies with the syntax for the resource policy's type. For more information, see SCP syntax in the Organizations User Guide.
" }, "Tags":{ "shape":"Tags", "documentation":"A list of tags that you want to attach to the newly created resource policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.
Calls with tags apply to the initial creation of the resource policy, otherwise an exception is thrown. If any one of the tags is not valid or if you exceed the allowed number of tags for the resource policy, then the entire request fails and the resource policy is not created.
A structure that contains details about the resource policy.
" } } }, "RegisterDelegatedAdministratorRequest":{ "type":"structure", "required":[ "AccountId", "ServicePrincipal" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The account ID number of the member account in the organization to register as a delegated administrator.
" }, "ServicePrincipal":{ "shape":"ServicePrincipal", "documentation":"The service principal of the Amazon Web Services service for which you want to make the member account a delegated administrator.
" } } }, "RemoveAccountFromOrganizationRequest":{ "type":"structure", "required":["AccountId"], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"ID for the member account that you want to remove from the organization.
The regex pattern for an account ID string requires exactly 12 digits.
" } } }, "ResourcePolicy":{ "type":"structure", "members":{ "ResourcePolicySummary":{ "shape":"ResourcePolicySummary", "documentation":"A structure that contains resource policy ID and Amazon Resource Name (ARN).
" }, "Content":{ "shape":"ResourcePolicyContent", "documentation":"The policy text of the resource policy.
" } }, "documentation":"A structure that contains details about a resource policy.
" }, "ResourcePolicyArn":{ "type":"string", "pattern":"^arn:[a-z0-9][a-z0-9-.]{0,62}:organizations::\\d{12}:resourcepolicy\\/o-[a-z0-9]{10,32}\\/rp-[0-9a-zA-Z_]{4,128}" }, "ResourcePolicyContent":{ "type":"string", "max":40000, "min":1, "pattern":"[\\s\\S]*" }, "ResourcePolicyId":{ "type":"string", "max":131, "pattern":"^rp-[0-9a-zA-Z_]{4,128}$" }, "ResourcePolicyNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"We can't find a resource policy request with the parameter that you specified.
", "exception":true }, "ResourcePolicySummary":{ "type":"structure", "members":{ "Id":{ "shape":"ResourcePolicyId", "documentation":"The unique identifier (ID) of the resource policy.
" }, "Arn":{ "shape":"ResourcePolicyArn", "documentation":"The Amazon Resource Name (ARN) of the resource policy.
" } }, "documentation":"A structure that contains resource policy ID and Amazon Resource Name (ARN).
" }, "ResponsibilityTransfer":{ "type":"structure", "members":{ "Arn":{ "shape":"ResponsibilityTransferArn", "documentation":"Amazon Resource Name (ARN) for the transfer.
" }, "Name":{ "shape":"ResponsibilityTransferName", "documentation":"Name assigned to the transfer.
" }, "Id":{ "shape":"ResponsibilityTransferId", "documentation":"ID for the transfer.
" }, "Type":{ "shape":"ResponsibilityTransferType", "documentation":"The type of transfer. Currently, only BILLING is supported.
Status for the transfer.
" }, "Source":{ "shape":"TransferParticipant", "documentation":"Account that allows another account external to its organization to manage the specified responsibilities for the organization.
" }, "Target":{ "shape":"TransferParticipant", "documentation":"Account that manages the specified responsibilities for another organization.
" }, "StartTimestamp":{ "shape":"Timestamp", "documentation":"Timestamp when the transfer starts.
" }, "EndTimestamp":{ "shape":"Timestamp", "documentation":"Timestamp when the transfer ends.
" }, "ActiveHandshakeId":{ "shape":"HandshakeId", "documentation":"ID for the handshake of the transfer.
" } }, "documentation":"Contains details for a transfer. A transfer is the arrangement between two management accounts where one account designates the other with specified responsibilities for their organization.
" }, "ResponsibilityTransferAlreadyInStatusException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"The responsibility transfer is already in the status that you specified.
", "exception":true }, "ResponsibilityTransferArn":{ "type":"string", "pattern":"^arn:[a-z0-9][a-z0-9-.]{0,62}:organizations::\\d{12}:transfer\\/o-[a-z0-9]{10,32}\\/(billing)\\/(inbound|outbound)\\/rt-[0-9a-z]{8,32}$" }, "ResponsibilityTransferId":{ "type":"string", "pattern":"^rt-[0-9a-z]{8,32}$" }, "ResponsibilityTransferName":{ "type":"string", "max":128, "min":1, "pattern":"^[ -~]+$", "sensitive":true }, "ResponsibilityTransferNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"We can't find a transfer that you specified.
", "exception":true }, "ResponsibilityTransferStatus":{ "type":"string", "enum":[ "REQUESTED", "DECLINED", "CANCELED", "EXPIRED", "ACCEPTED", "WITHDRAWN" ] }, "ResponsibilityTransferType":{ "type":"string", "enum":["BILLING"] }, "ResponsibilityTransfers":{ "type":"list", "member":{"shape":"ResponsibilityTransfer"} }, "RoleName":{ "type":"string", "max":64, "pattern":"[\\w+=,.@-]{1,64}" }, "Root":{ "type":"structure", "members":{ "Id":{ "shape":"RootId", "documentation":"The unique identifier (ID) for the root. The ID is unique to the organization only.
The regex pattern for a root ID string requires \"r-\" followed by from 4 to 32 lowercase letters or digits.
" }, "Arn":{ "shape":"RootArn", "documentation":"The Amazon Resource Name (ARN) of the root.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
" }, "Name":{ "shape":"RootName", "documentation":"The friendly name of the root.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
" }, "PolicyTypes":{ "shape":"PolicyTypes", "documentation":"The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.
Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization.
Contains details about a root. A root is a top-level parent node in the hierarchy of an organization that can contain organizational units (OUs) and accounts. The root contains every Amazon Web Services account in the organization.
" }, "RootArn":{ "type":"string", "pattern":"^arn:aws:organizations::\\d{12}:root\\/o-[a-z0-9]{10,32}\\/r-[0-9a-z]{4,32}" }, "RootId":{ "type":"string", "max":34, "pattern":"^r-[0-9a-z]{4,32}$" }, "RootName":{ "type":"string", "max":128, "min":1 }, "RootNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"We can't find a root with the RootId that you specified.
Organizations can't complete your request because of an internal service error. Try again later.
", "exception":true, "fault":true }, "ServicePrincipal":{ "type":"string", "max":128, "min":1, "pattern":"[\\w+=,.@-]*" }, "SourceParentNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"We can't find a source root or OU with the ParentId that you specified.
The key identifier, or name, of the tag.
" }, "Value":{ "shape":"TagValue", "documentation":"The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
" } }, "documentation":"A custom key-value pair associated with a resource within your organization.
You can attach tags to any of the following organization resources.
Amazon Web Services account
Organizational unit (OU)
Organization root
Policy
The ID of the resource to add a tag to.
You can specify any of the following taggable resources.
Amazon Web Services account – specify the account ID number.
Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz
Root – specify the root ID that begins with r- and looks similar to: r-1a2b
Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3
A list of tags to add to the specified resource.
For each tag in the list, you must specify both a tag key and a value. The value can be an empty string, but you can't set it to null.
If any one of the tags is not valid or if you exceed the maximum allowed number of tags for a resource, then the entire request fails.
We can't find a root, OU, account, or policy with the TargetId that you specified.
ID for the transfer.
" }, "EndTimestamp":{ "shape":"Timestamp", "documentation":"Timestamp when the responsibility transfer is to end.
" } } }, "TerminateResponsibilityTransferResponse":{ "type":"structure", "members":{ "ResponsibilityTransfer":{ "shape":"ResponsibilityTransfer", "documentation":"A ResponsibilityTransfer object. Contains details for a transfer.
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.
", "exception":true }, "TransferParticipant":{ "type":"structure", "members":{ "ManagementAccountId":{ "shape":"AccountId", "documentation":"ID for the management account.
" }, "ManagementAccountEmail":{ "shape":"Email", "documentation":"Email address for the management account.
" } }, "documentation":"Contains details for a participant in a transfer. A transfer is the arrangement between two management accounts where one account designates the other with specified responsibilities for their organization.
" }, "UnsupportedAPIEndpointException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"This action isn't available in the current Amazon Web Services Region.
", "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceId", "TagKeys" ], "members":{ "ResourceId":{ "shape":"TaggableResourceId", "documentation":"The ID of the resource to remove a tag from.
You can specify any of the following taggable resources.
Amazon Web Services account – specify the account ID number.
Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz
Root – specify the root ID that begins with r- and looks similar to: r-1a2b
Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3
The list of keys for tags to remove from the specified resource.
" } } }, "UpdateOrganizationalUnitRequest":{ "type":"structure", "required":["OrganizationalUnitId"], "members":{ "OrganizationalUnitId":{ "shape":"OrganizationalUnitId", "documentation":"ID for the OU that you want to rename. You can get the ID from the ListOrganizationalUnitsForParent operation.
The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits.
" }, "Name":{ "shape":"OrganizationalUnitName", "documentation":"The new name that you want to assign to the OU.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
" } } }, "UpdateOrganizationalUnitResponse":{ "type":"structure", "members":{ "OrganizationalUnit":{ "shape":"OrganizationalUnit", "documentation":"A structure that contains the details about the specified OU, including its new name.
" } } }, "UpdatePolicyRequest":{ "type":"structure", "required":["PolicyId"], "members":{ "PolicyId":{ "shape":"PolicyId", "documentation":"ID for the policy that you want to update.
The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
" }, "Name":{ "shape":"PolicyName", "documentation":"If provided, the new name for the policy.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
" }, "Description":{ "shape":"PolicyDescription", "documentation":"If provided, the new description for the policy.
" }, "Content":{ "shape":"PolicyContent", "documentation":"If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see SCP syntax in the Organizations User Guide.
The maximum size of a policy document depends on the policy's type. For more information, see Maximum and minimum values in the Organizations User Guide.
" } } }, "UpdatePolicyResponse":{ "type":"structure", "members":{ "Policy":{ "shape":"Policy", "documentation":"A structure that contains details about the updated policy, showing the requested changes.
" } } }, "UpdateResponsibilityTransferRequest":{ "type":"structure", "required":[ "Id", "Name" ], "members":{ "Id":{ "shape":"ResponsibilityTransferId", "documentation":"ID for the transfer.
" }, "Name":{ "shape":"ResponsibilityTransferName", "documentation":"New name you want to assign to the transfer.
" } } }, "UpdateResponsibilityTransferResponse":{ "type":"structure", "members":{ "ResponsibilityTransfer":{"shape":"ResponsibilityTransfer"} } } }, "documentation":"Organizations is a web service that enables you to consolidate your multiple Amazon Web Services accounts into an organization and centrally manage your accounts and their resources.
This guide provides descriptions of the Organizations operations. For more information about using this service, see the Organizations User Guide.
Support and feedback for Organizations
We welcome your feedback. You can post your feedback and questions in the Organizations support forum. For more information about the Amazon Web Services Support forums, see Forums Help.
Endpoint to call When using the CLI or the Amazon Web Services SDK
For the current release of Organizations, specify the us-east-1 region for all Amazon Web Services API and CLI calls made from the commercial Amazon Web Services Regions outside of China. If calling from one of the Amazon Web Services Regions in China, then specify cn-northwest-1. You can do this in the CLI by using these parameters and commands:
Use the following parameter with each command to specify both the endpoint and its region:
--endpoint-url https://organizations.us-east-1.amazonaws.com (from commercial Amazon Web Services Regions outside of China)
or
--endpoint-url https://organizations.cn-northwest-1.amazonaws.com.cn (from Amazon Web Services Regions in China)
Use the default endpoint, but configure your default region with this command:
aws configure set default.region us-east-1 (from commercial Amazon Web Services Regions outside of China)
or
aws configure set default.region cn-northwest-1 (from Amazon Web Services Regions in China)
Use the following parameter with each command to specify the endpoint:
--region us-east-1 (from commercial Amazon Web Services Regions outside of China)
or
--region cn-northwest-1 (from Amazon Web Services Regions in China)
Recording API Requests
Organizations supports CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Organizations service received, who made the request and when, and so on. For more about Organizations and its support for CloudTrail, see Logging Organizations API calls with CloudTrail in the Organizations User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the CloudTrail User Guide.
" }