Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.
This operation can be called only by the following principals when they also have the relevant IAM permissions:
Invitation to join or Approve all features request handshakes: only a principal from the member account.
The user who calls the API for an invitation to join must have the organizations:AcceptHandshake permission. If you enabled all features in the organization, then the user must also have the iam:CreateServiceLinkedRole permission so that Organizations can create the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.
Enable all features final confirmation handshake: only a principal from the master account.
For more information about invitations, see Inviting an AWS Account to Join Your Organization in the AWS Organizations User Guide. For more information about requests to enable all features in the organization, see Enabling All Features in Your Organization in the AWS Organizations User Guide.
After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.
" }, "AttachPolicy":{ "name":"AttachPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachPolicyRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"DuplicatePolicyAttachmentException"}, {"shape":"InvalidInputException"}, {"shape":"PolicyNotFoundException"}, {"shape":"PolicyTypeNotEnabledException"}, {"shape":"ServiceException"}, {"shape":"TargetNotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"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:
Service control policy (SCP) - An SCP specifies what permissions can be delegated to users in affected member accounts. The scope of influence for a policy depends on what you attach the policy to:
If you attach an SCP to a root, it affects all accounts in the organization.
If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs.
If you attach the policy directly to an account, then it affects only that account.
SCPs essentially are permission \"filters\". When you attach one SCP to a higher level root or OU, and you also attach a different SCP to a child OU or to an account, the child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child cannot grant a permission that is not already granted by the parent. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They cannot use A or B because they were filtered out by the child OU. They also cannot use F and G because they were filtered out by the parent OU. They cannot be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP.
AWS Organizations attaches a default SCP named \"FullAWSAccess to every root, OU, and account. This default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the permissions that you want to allow in that OU or account.
For more information about how Organizations policies permissions work, see Using Service Control Policies in the AWS Organizations User Guide.
This operation can be called only from the organization's master account.
" }, "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. Canceling a handshake sets the handshake state to CANCELED.
This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient can no longer respond to that handshake.
After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.
" }, "CreateAccount":{ "name":"CreateAccount", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAccountRequest"}, "output":{"shape":"CreateAccountResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"ConstraintViolationException"}, {"shape":"InvalidInputException"}, {"shape":"FinalizingOrganizationException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:
Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.
Check the AWS CloudTrail log for the CreateAccountResult event. For information on using AWS CloudTrail with Organizations, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide.
The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations will create the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.
AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the master account administrator permissions in the new member account. Principals in the master account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's master account.
This operation can be called only from the organization's master account.
For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.
When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide.
If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support.
If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support.
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 AWS organization. The account whose user is calling the CreateOrganization operation automatically becomes the master account of the new organization.
This operation must be called using credentials from the account that is to become the new organization's master account. The principal must also have the relevant IAM permissions.
By default (or if you set the FeatureSet parameter to ALL), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the FeatureSet parameter to CONSOLIDATED_BILLING\", then no policy types are enabled by default and you cannot use organization policies.
Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five.
For more information about OUs, see Managing Organizational Units in the AWS Organizations User Guide.
This operation can be called only from the organization's master account.
" }, "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"} ], "documentation":"Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account.
For more information about policies and their use, see Managing Organization Policies.
This operation can be called only from the organization's master account.
" }, "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 request. This sets the handshake state to DECLINED and effectively deactivates the request.
This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake instead. The originator can't reactivate a declined request, but can re-initiate the process with a new handshake request.
After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.
" }, "DeleteOrganization":{ "name":"DeleteOrganization", "http":{ "method":"POST", "requestUri":"/" }, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InvalidInputException"}, {"shape":"OrganizationNotEmptyException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Deletes the organization. You can delete an organization only by using credentials from the master account. The organization must be empty of member accounts.
" }, "DeleteOrganizationalUnit":{ "name":"DeleteOrganizationalUnit", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteOrganizationalUnitRequest"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InvalidInputException"}, {"shape":"OrganizationalUnitNotEmptyException"}, {"shape":"OrganizationalUnitNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Deletes an organizational unit (OU) from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete.
This operation can be called only from the organization's master account.
" }, "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"} ], "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.
This operation can be called only from the organization's master 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.
This operation can be called only from the organization's master account.
" }, "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"} ], "documentation":"Retrieves the current status of an asynchronous request to create an account.
This operation can be called only from the organization's master account.
" }, "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":"Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake.
You can access handshakes that are ACCEPTED, DECLINED, or CANCELED for only 30 days after they change to that state. They are then deleted and no longer accessible.
This operation can be called from any account in the organization.
" }, "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.
This operation can be called from any account in the organization.
Even if a policy type is shown as available in the organization, it can be disabled 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).
This operation can be called only from the organization's master account.
" }, "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"} ], "documentation":"Retrieves information about a policy.
This operation can be called only from the organization's master account.
" }, "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"} ], "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 IAM users and roles in affected accounts are immediate.
Note: Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with one that limits the permissions that can be delegated, then you must attach the replacement policy before you can remove the default one. This is the authorization strategy of whitelisting. If you instead attach a second SCP and leave the FullAWSAccess SCP still attached, and specify \"Effect\": \"Deny\" in the second SCP to override the \"Effect\": \"Allow\" in the FullAWSAccess policy (or any other attached SCP), then you are using the authorization strategy of blacklisting.
This operation can be called only from the organization's master account.
" }, "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"} ], "documentation":"Disables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you disable integration, the specified service no longer can create a service-linked role in new accounts in your organization. This means the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from AWS Organizations.
We recommend that you disable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service.
After you perform the DisableAWSServiceAccess operation, the specified service can no longer perform operations in your organization's accounts unless the operations are explicitly permitted by the IAM policies that are attached to your roles.
For more information about integrating other services with AWS Organizations, including the list of services that work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.
This operation can be called only from the organization's master account.
" }, "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"} ], "documentation":"Disables an organizational control policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation.
This operation can be called only from the organization's master account.
If you disable a policy type for a root, it still shows as enabled for the organization if all features are enabled in that organization. Use ListRoots to see the status of policy types for a specified root. Use DescribeOrganization to see the status of policy types in the organization.
Enables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you enable integration, you allow the specified service to create a service-linked role in all the accounts in your organization. This allows the service to perform operations on your behalf in your organization and its accounts.
We recommend that you enable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the service is aware that it can create the resources that are required for the integration. How the service creates those resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service.
For more information about enabling services to integrate with AWS Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.
This operation can be called only from the organization's master account and only if the organization has enabled all features.
" }, "EnableAllFeatures":{ "name":"EnableAllFeatures", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableAllFeaturesRequest"}, "output":{"shape":"EnableAllFeaturesResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"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 AWS Organizations supports. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.
This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change 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 master account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The master account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this.
This operation can be called only from the organization's master account.
" }, "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"} ], "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 operation can be called only from the organization's master account.
You can enable a policy type in a root only if that policy type is available in the organization. Use DescribeOrganization to view the status of available policy types in the organization.
To view the status of policy type in a root, 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":"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.
You can invite AWS accounts only from the same seller as the master account. For example, if your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India, then you can only invite other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS, or any other AWS seller. For more information, see Consolidated Billing in India.
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, then contact AWS Customer Support.
This operation can be called only from the organization's master 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 master account, use RemoveAccountFromOrganization instead.
This operation can be called only from a member account in the organization.
The master account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do, including preventing them from successfully calling LeaveOrganization and leaving the organization.
You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For each account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
You can leave an organization only after you enable IAM user access to billing in your account. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.
Returns a list of the AWS services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts.
For more information about integrating other services with AWS Organizations, including the list of services that currently work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.
This operation can be called only from the organization's master account.
" }, "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.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" }, "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 are not in any OU. If you specify an OU, you get a list of all the accounts in only that OU, and not in any child OUs. To get a list of all accounts in the organization, use the ListAccounts operation.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" }, "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.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" }, "ListCreateAccountStatus":{ "name":"ListCreateAccountStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCreateAccountStatusRequest"}, "output":{"shape":"ListCreateAccountStatusResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Lists the account creation requests that match the specified status that is currently being tracked for the organization.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" }, "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 current handshakes that are associated with the account of the requesting user.
Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called from any account in the organization.
" }, "ListHandshakesForOrganization":{ "name":"ListHandshakesForOrganization", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListHandshakesForOrganizationRequest"}, "output":{"shape":"ListHandshakesForOrganizationResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Lists the handshakes that are associated with the organization that the requesting user is part of. The ListHandshakesForOrganization operation returns a list of handshake structures. Each structure contains details and status about a handshake.
Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" }, "ListOrganizationalUnitsForParent":{ "name":"ListOrganizationalUnitsForParent", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListOrganizationalUnitsForParentRequest"}, "output":{"shape":"ListOrganizationalUnitsForParentResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"InvalidInputException"}, {"shape":"ParentNotFoundException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Lists the organizational units (OUs) in a parent organizational unit or root.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" }, "ListParents":{ "name":"ListParents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListParentsRequest"}, "output":{"shape":"ListParentsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"AWSOrganizationsNotInUseException"}, {"shape":"ChildNotFoundException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with ListChildren enables you to traverse the tree structure that makes up this root.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
In the current release, a child can have only a single parent.
Retrieves the list of all policies in an organization of a specified type.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" }, "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"} ], "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.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" }, "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.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
Policy types can be enabled and disabled in roots. This is distinct from whether they are 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 all the roots, organizaitonal units (OUs), and accounts to which the specified policy is attached.
Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
This operation can be called only from the organization's master account.
" }, "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.
This operation can be called only from the organization's master 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 stand-alone account that is not a member of any organization. It is no longer subject to any policies and is responsible for its own bill payments. The organization's master account is no longer charged for any expenses accrued by the member account after it is removed from the organization.
This operation can be called only from the organization's master account. Member accounts can remove themselves with LeaveOrganization instead.
You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For an account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. To remove an account that does not yet have this information, you must sign in as the member account and follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
Renames the specified organizational unit (OU). The ID and ARN do not change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached.
This operation can be called only from the organization's master account.
" }, "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"} ], "documentation":"Updates an existing policy with a new name, description, or content. If any parameter is not supplied, that value remains unchanged. Note that you cannot change a policy's type.
This operation can be called only from the organization's master account.
" } }, "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":"The unique identifier (ID) of the handshake that you want to accept.
The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lower-case letters or digits.
" } } }, "AcceptHandshakeResponse":{ "type":"structure", "members":{ "Handshake":{ "shape":"Handshake", "documentation":"A structure that contains details about the accepted handshake.
" } } }, "AccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"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 so that AWS 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 AWS Organizations User Guide.
" }, "Email":{ "shape":"Email", "documentation":"The email address associated with the AWS 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.
" }, "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 AWS account that is a member of an organization.
" }, "AccountArn":{ "type":"string", "pattern":"^arn:aws:organizations::\\d{12}:account\\/o-[a-z0-9]{10,32}\\/\\d{12}" }, "AccountId":{ "type":"string", "pattern":"^\\d{12}$" }, "AccountJoinedMethod":{ "type":"string", "enum":[ "INVITED", "CREATED" ] }, "AccountName":{ "type":"string", "max":50, "min":1, "pattern":"[\\u0020-\\u007E]+", "sensitive":true }, "AccountNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":" We can't find an AWS account with the AccountId that you specified, or the account whose credentials you used to make this request isn't a member of an organization.
You can't invite an existing account to your organization until you verify that you own the email address associated with the master account. For more information, see Email Address Verification in the AWS Organizations User Guide.
", "exception":true }, "AccountStatus":{ "type":"string", "enum":[ "ACTIVE", "SUSPENDED" ] }, "Accounts":{ "type":"list", "member":{"shape":"Account"} }, "ActionType":{ "type":"string", "enum":[ "INVITE", "ENABLE_ALL_FEATURES", "APPROVE_ALL_FEATURES", "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE" ] }, "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":"The unique identifier (ID) of 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 lower-case letters or digits.
" }, "TargetId":{ "shape":"PolicyTargetId", "documentation":"The unique identifier (ID) of 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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.
The unique identifier (ID) of 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 lower-case letters or digits.
" } } }, "CancelHandshakeResponse":{ "type":"structure", "members":{ "Handshake":{ "shape":"Handshake", "documentation":"A structure that contains details about the handshake that you canceled.
" } } }, "Child":{ "type":"structure", "members":{ "Id":{ "shape":"ChildId", "documentation":"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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.
The type of this child entity.
" } }, "documentation":"Contains a list of child entities, either OUs or accounts.
" }, "ChildId":{ "type":"string", "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 AWS account with the ChildId that you specified.
The target of the operation is currently being modified by a different request. Try again later.
", "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 removing 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_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contactAWS Support to request an increase in your limit.
Or the number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations or contact AWS Support to request an increase in the number of accounts.
Deleted and closed accounts still count toward your limit.
If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.
ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.
POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.
The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address.
" }, "AccountName":{ "shape":"AccountName", "documentation":"The friendly name of the member account.
" }, "RoleName":{ "shape":"RoleName", "documentation":"(Optional)
The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master 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 Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide, and steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide.
The regex pattern that is used to validate this parameter is a string of characters that can consist of 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 Activating Access to the Billing and Cost Management Console in the AWS 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 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 AWS CloudTrail log for the CreateAccountResult event. For more information, see Monitoring the Activity in Your Organization in the AWS 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 an create account request ID string requires \"car-\" followed by from 8 to 32 lower-case letters or digits.
" }, "AccountName":{ "shape":"AccountName", "documentation":"The account name given to the account when it was created.
" }, "State":{ "shape":"CreateAccountState", "documentation":"The status of the request.
" }, "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.
" }, "FailureReason":{ "shape":"CreateAccountFailureReason", "documentation":"If the request failed, a description of the reason for the failure.
ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have reached the limit on the number of accounts in your organization.
EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address already exists.
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.
INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact Customer Support.
Contains the status about a CreateAccount request to create an AWS 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 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 master account. For more information, see Consolidated Billing in the AWS Organizations User Guide.
ALL: In addition to all the features supported by the consolidated billing feature set, the master account can also apply any type of policy to any member account in the organization. For more information, see All features in the AWS Organizations User Guide.
A structure that contains details about the newly created organization.
" } } }, "CreateOrganizationalUnitRequest":{ "type":"structure", "required":[ "ParentId", "Name" ], "members":{ "ParentId":{ "shape":"ParentId", "documentation":"The unique identifier (ID) of the parent root or OU in which you want to create the new OU.
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 lower-case letters or digits.
Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.
The friendly name to assign to the new OU.
" } } }, "CreateOrganizationalUnitResponse":{ "type":"structure", "members":{ "OrganizationalUnit":{ "shape":"OrganizationalUnit", "documentation":"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 content to add to the new policy. For example, if you create a service control policy (SCP), this string must be JSON text that specifies the permissions that admins in attached accounts can delegate to their users, groups, and roles. For more information about the SCP syntax, see Service Control Policy Syntax in the AWS 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.
In the current release, the only type of policy that you can create is a service control policy (SCP).
A structure that contains details about the newly created policy.
" } } }, "DeclineHandshakeRequest":{ "type":"structure", "required":["HandshakeId"], "members":{ "HandshakeId":{ "shape":"HandshakeId", "documentation":"The unique identifier (ID) of 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 lower-case letters or digits.
" } } }, "DeclineHandshakeResponse":{ "type":"structure", "members":{ "Handshake":{ "shape":"Handshake", "documentation":"A structure that contains details about the declined handshake. The state is updated to show the value DECLINED.
The unique identifier (ID) of 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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.
" } } }, "DeletePolicyRequest":{ "type":"structure", "required":["PolicyId"], "members":{ "PolicyId":{ "shape":"PolicyId", "documentation":"The unique identifier (ID) of 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 lower-case letters or digits.
" } } }, "DescribeAccountRequest":{ "type":"structure", "required":["AccountId"], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The unique identifier (ID) of the AWS 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.
" } } }, "DescribeCreateAccountStatusRequest":{ "type":"structure", "required":["CreateAccountRequestId"], "members":{ "CreateAccountRequestId":{ "shape":"CreateAccountRequestId", "documentation":"Specifies the operationId that uniquely identifies the request. You can get the ID from the response to an earlier CreateAccount request, or from the ListCreateAccountStatus operation.
The regex pattern for an create account request ID string requires \"car-\" followed by from 8 to 32 lower-case letters or digits.
" } } }, "DescribeCreateAccountStatusResponse":{ "type":"structure", "members":{ "CreateAccountStatus":{ "shape":"CreateAccountStatus", "documentation":"A structure that contains the current status of an account creation request.
" } } }, "DescribeHandshakeRequest":{ "type":"structure", "required":["HandshakeId"], "members":{ "HandshakeId":{ "shape":"HandshakeId", "documentation":"The unique identifier (ID) of the handshake that you want information about. You can get the ID from the original call to InviteAccountToOrganization, or from a call to ListHandshakesForAccount or ListHandshakesForOrganization.
The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lower-case letters or digits.
" } } }, "DescribeHandshakeResponse":{ "type":"structure", "members":{ "Handshake":{ "shape":"Handshake", "documentation":"A structure that contains information about the specified handshake.
" } } }, "DescribeOrganizationResponse":{ "type":"structure", "members":{ "Organization":{ "shape":"Organization", "documentation":"A structure that contains information about the organization.
" } } }, "DescribeOrganizationalUnitRequest":{ "type":"structure", "required":["OrganizationalUnitId"], "members":{ "OrganizationalUnitId":{ "shape":"OrganizationalUnitId", "documentation":"The unique identifier (ID) of 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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second \"-\" dash and from 8 to 32 additional lower-case 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":"The unique identifier (ID) of 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 lower-case letters or digits.
" } } }, "DescribePolicyResponse":{ "type":"structure", "members":{ "Policy":{ "shape":"Policy", "documentation":"A structure that contains details about the specified policy.
" } } }, "DestinationParentNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"We can't find the destination container (a root or OU) with the ParentId that you specified.
The unique identifier (ID) of 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 lower-case letters or digits.
" }, "TargetId":{ "shape":"PolicyTargetId", "documentation":"The unique identifier (ID) of the root, OU, or account from which you want to detach the policy. 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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.
The service principal name of the AWS 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.
The unique identifier (ID) of 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 lower-case letters or digits.
" }, "PolicyType":{ "shape":"PolicyType", "documentation":"The policy type that you want to disable in this root.
" } } }, "DisablePolicyTypeResponse":{ "type":"structure", "members":{ "Root":{ "shape":"Root", "documentation":"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 }, "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 AWS 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":"The unique identifier (ID) of 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 lower-case letters or digits.
" }, "PolicyType":{ "shape":"PolicyType", "documentation":"The policy type that you want to enable.
" } } }, "EnablePolicyTypeResponse":{ "type":"structure", "members":{ "Root":{ "shape":"Root", "documentation":"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 AWS Organizations.
" } }, "documentation":"A structure that contains details of a service principal that is enabled to integrate with AWS Organizations.
" }, "EnabledServicePrincipals":{ "type":"list", "member":{"shape":"EnabledServicePrincipal"} }, "ExceptionMessage":{"type":"string"}, "ExceptionType":{"type":"string"}, "FinalizingOrganizationException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"AWS Organizations couldn't perform the operation because your organization hasn't finished initializing. This can take up to an hour. Try again later. If after one hour you continue to receive this error, contact AWS Support.
", "exception":true }, "GenericArn":{ "type":"string", "pattern":"^arn:aws:organizations::.+:.+" }, "Handshake":{ "type":"structure", "members":{ "Id":{ "shape":"HandshakeId", "documentation":"The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.
The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lower-case letters or digits.
" }, "Arn":{ "shape":"HandshakeArn", "documentation":"The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
" }, "Parties":{ "shape":"HandshakeParties", "documentation":"Information about the two accounts that are participating in the handshake.
" }, "State":{ "shape":"HandshakeState", "documentation":"The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
CANCELED: This handshake is no longer active because it was canceled by the originating account.
ACCEPTED: This handshake is complete because it has been accepted by the recipient.
DECLINED: This handshake is no longer active because it was declined by the recipient account.
EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
The date and time that the handshake request was made.
" }, "ExpirationTimestamp":{ "shape":"Timestamp", "documentation":"The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.
" }, "Action":{ "shape":"ActionType", "documentation":"The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.
Additional information that is needed to process the handshake.
" } }, "documentation":"Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient). For example, when a master account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.
Note: Handshakes that are CANCELED, ACCEPTED, or DECLINED show up in lists for only 30 days after entering that state After that they are deleted.
" }, "HandshakeAlreadyInStateException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"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 AWS Support.
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.
ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.
ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.
INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You 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.
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.
ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be from the same marketplace.
ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change the membership of an account too quickly after its previous change.
Specifies the type of handshake action.
If you specify ActionType, you cannot also specify ParentHandshakeId.
Specifies 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 lower-case letters or digits.
" } }, "documentation":"Specifies the criteria that are used to select the handshakes for the operation.
" }, "HandshakeId":{ "type":"string", "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.
The unique identifier (ID) for the party.
The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lower-case letters or digits.
" }, "Type":{ "shape":"HandshakePartyType", "documentation":"The type of party.
" } }, "documentation":"Identifies a participant in a handshake.
" }, "HandshakePartyId":{ "type":"string", "max":64, "min":1, "sensitive":true }, "HandshakePartyType":{ "type":"string", "enum":[ "ACCOUNT", "ORGANIZATION", "EMAIL" ] }, "HandshakeResource":{ "type":"structure", "members":{ "Value":{ "shape":"HandshakeResourceValue", "documentation":"The information that is passed to the other party in 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 - Specifies an AWS account ID number.
ORGANIZATION - Specifies an organization ID number.
EMAIL - Specifies the email address that is associated with the account that receives the handshake.
OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
When needed, contains an additional array of HandshakeResource objects.
Contains additional data that is needed to process a handshake.
" }, "HandshakeResourceType":{ "type":"string", "enum":[ "ACCOUNT", "ORGANIZATION", "ORGANIZATION_FEATURE_SET", "EMAIL", "MASTER_EMAIL", "MASTER_NAME", "NOTES", "PARENT_HANDSHAKE" ] }, "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:
IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.
INPUT_REQUIRED: You must include a value for all required parameters.
INVALID_ENUM: You specified a value that isn't valid for that parameter.
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.
INVALID_PATTERN: You provided a value that doesn't match the required pattern.
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
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.
The identifier (ID) of the AWS 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 AWS CLI, you can submit this as a single string, similar to the following example:
--target Id=123456789012,Type=ACCOUNT
If you specify \"Type\": \"ACCOUNT\", then you must provide the AWS account ID number as the Id. If you specify \"Type\": \"EMAIL\", then 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.
" } } }, "InviteAccountToOrganizationResponse":{ "type":"structure", "members":{ "Handshake":{ "shape":"Handshake", "documentation":"A structure that contains details about the handshake that is created to support this invitation request.
" } } }, "ListAWSServiceAccessForOrganizationRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the 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 AWS Organizations.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, this value indicates that there is more output 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":"Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
A list of the accounts in the specified root or OU.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, this value indicates that there is more output 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.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
A list of objects in the organization.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, this value indicates that there is more output 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 lower-case letters or digits.
Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.
Filters the output to include only the specified child type.
" }, "NextToken":{ "shape":"NextToken", "documentation":"Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The list of children of the specified parent container.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, this value indicates that there is more output 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 is not present, then all requests are included in the response.
" }, "NextToken":{ "shape":"NextToken", "documentation":"Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the 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, this value indicates that there is more output 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.
Filters the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE-FULL-CONTROL, or APPROVE-FULL-CONTROL. Alternatively, for the ENABLE-FULL-CONTROL handshake that generates a separate child handshake for each member account, you can specify ParentHandshakeId to see only the handshakes that were generated by that parent request.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
A list of Handshake objects with details about each of the handshakes that is associated with the specified account.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, this value indicates that there is more output 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 filter of the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE-ALL-FEATURES, or APPROVE-ALL-FEATURES. Alternatively, for the ENABLE-ALL-FEATURES handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId to see only the handshakes that were generated by that parent request.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
A list of Handshake objects with details about each of the handshakes that are associated with an organization.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, this value indicates that there is more output 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) of 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 lower-case letters or digits.
Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
A list of the OUs in the specified root or parent OU.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, this value indicates that there is more output 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) of the OU or account whose parent containers you want to list. Do not 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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
A list of parents for the specified child account or OU.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, this value indicates that there is more output 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) of 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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.
The type of policy that you want to include in the returned list.
" }, "NextToken":{ "shape":"NextToken", "documentation":"Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The list of policies that match the criteria in the request.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, this value indicates that there is more output 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.
" }, "NextToken":{ "shape":"NextToken", "documentation":"Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
A list of policies that match the filter criteria in the request. The output list does not include the policy contents. To see the content for a policy, see DescribePolicy.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, this value indicates that there is more output 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.
Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
A list of roots that are defined in an organization.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If present, this value indicates that there is more output 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) of the policy for which you want to know its attachments.
The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lower-case letters or digits.
" }, "NextToken":{ "shape":"NextToken", "documentation":"Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the 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, this value indicates that there is more output 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 Service Control Policy Syntax in the AWS Organizations User Guide.
", "exception":true }, "MasterCannotLeaveOrganizationException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"You can't remove a master account from an organization. If you want the master account to become a member account in another organization, you must first delete the current organization of the master account.
", "exception":true }, "MaxResults":{ "type":"integer", "box":true, "max":20, "min":1 }, "MoveAccountRequest":{ "type":"structure", "required":[ "AccountId", "SourceParentId", "DestinationParentId" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The unique identifier (ID) of the account that you want to move.
The regex pattern for an account ID string requires exactly 12 digits.
" }, "SourceParentId":{ "shape":"ParentId", "documentation":"The unique identifier (ID) of 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 lower-case letters or digits.
Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.
The unique identifier (ID) of 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 lower-case letters or digits.
Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case 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 lower-case 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 AWS Organizations User Guide.
" }, "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 AWS Organizations User Guide.
" }, "MasterAccountArn":{ "shape":"AccountArn", "documentation":"The Amazon Resource Name (ARN) of the account that is designated as the master account for the organization.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
" }, "MasterAccountId":{ "shape":"AccountId", "documentation":"The unique identifier (ID) of the master 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 AWS account that is designated as the master account for the organization.
" }, "AvailablePolicyTypes":{ "shape":"PolicyTypes", "documentation":"A list of policy types that are enabled for this organization. For example, if your organization has all features enabled, then service control policies (SCPs) are included in the list.
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 ListRoots to see the status of a policy type in that root.
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 master account, delete all OUs, and delete all policies.
", "exception":true }, "OrganizationalUnit":{ "type":"structure", "members":{ "Id":{ "shape":"OrganizationalUnitId", "documentation":"The unique identifier (ID) associated with this OU.
The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second \"-\" dash and from 8 to 32 additional lower-case 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 AWS Organizations User Guide.
" }, "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.
" } }, "documentation":"Contains details about an organizational unit (OU). An OU is a container of AWS 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", "pattern":"^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$" }, "OrganizationalUnitName":{ "type":"string", "max":128, "min":1 }, "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 lower-case letters or digits.
Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case 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", "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})" }, "PolicyContent":{ "type":"string", "max":1000000, "min":1 }, "PolicyDescription":{ "type":"string", "max":512 }, "PolicyId":{ "type":"string", "pattern":"^p-[0-9a-zA-Z_]{8,128}$" }, "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 }, "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 lower-case letters or digits.
" }, "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 AWS Organizations User Guide.
" }, "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 AWS 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", "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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case 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 AWS Organizations User Guide.
" }, "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"] }, "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 Enabling and Disabling a Policy Type on a Root in the AWS 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 AWS 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"} }, "RemoveAccountFromOrganizationRequest":{ "type":"structure", "required":["AccountId"], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The unique identifier (ID) of the member account that you want to remove from the organization.
The regex pattern for an account ID string requires exactly 12 digits.
" } } }, "RoleName":{ "type":"string", "pattern":"[\\w+=,.@-]{1,64}" }, "Root":{ "type":"structure", "members":{ "Id":{ "shape":"RootId", "documentation":"The unique identifier (ID) for the root.
The regex pattern for a root ID string requires \"r-\" followed by from 4 to 32 lower-case 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 AWS Organizations User Guide.
" }, "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. Every root contains every AWS account in the organization. Each root enables the accounts to be organized in a different way and to have different policy types enabled for use in that root.
" }, "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", "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.
AWS Organizations can't complete your request because of an internal service error. Try again later.
", "exception":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.
We can't find a root, OU, or account with the TargetId that you specified.
You've sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.
", "exception":true }, "UpdateOrganizationalUnitRequest":{ "type":"structure", "required":["OrganizationalUnitId"], "members":{ "OrganizationalUnitId":{ "shape":"OrganizationalUnitId", "documentation":"The unique identifier (ID) of 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 lower-case letters or digits (the ID of the root that contains the OU) followed by a second \"-\" dash and from 8 to 32 additional lower-case 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":"The unique identifier (ID) of the policy that you want to update.
The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lower-case letters or digits.
" }, "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 Service Control Policy Syntax in the AWS Organizations User Guide.
" } } }, "UpdatePolicyResponse":{ "type":"structure", "members":{ "Policy":{ "shape":"Policy", "documentation":"A structure that contains details about the updated policy, showing the requested changes.
" } } } }, "documentation":"AWS Organizations is a web service that enables you to consolidate your multiple AWS accounts into an organization and centrally manage your accounts and their resources.
This guide provides descriptions of the Organizations API. For more information about using this service, see the AWS Organizations User Guide.
API Version
This version of the Organizations API Reference documents the Organizations API version 2016-11-28.
As an alternative to using the API directly, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to AWS Organizations. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the AWS SDKs to make programmatic API calls to Organizations. However, you also can use the Organizations Query API to make direct calls to the Organizations web service. To learn more about the Organizations Query API, see Making Query Requests in the AWS Organizations User Guide. Organizations supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.
Signing Requests
When you send HTTP requests to AWS, you must sign the requests so that AWS can identify who sent them. You sign requests with your AWS access key, which consists of an access key ID and a secret access key. We strongly recommend that you do not create an access key for your root account. Anyone who has the access key for your root account has unrestricted access to all the resources in your account. Instead, create an access key for an IAM user account that has administrative privileges. As another option, use AWS Security Token Service to generate temporary security credentials, and use those credentials to sign requests.
To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.
When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools.
In this release, each organization can have only one root. In a future release, a single organization will support multiple roots.
Support and Feedback for AWS Organizations
We welcome your feedback. Send your comments to feedback-awsorganizations@amazon.com or post your feedback and questions in the AWS Organizations support forum. For more information about the AWS support forums, see Forums Help.
Endpoint to Call When Using the CLI or the AWS API
For the current release of Organizations, you must specify the us-east-1 region for all AWS API and CLI calls. You can do this in the CLI by using these parameters and commands:
Use the following parameter with each command to specify both the endpoint and its region:
--endpoint-url https://organizations.us-east-1.amazonaws.com
Use the default endpoint, but configure your default region with this command:
aws configure set default.region us-east-1
Use the following parameter with each command to specify the endpoint:
--region us-east-1
For the various SDKs used to call the APIs, see the documentation for the SDK of interest to learn how to direct the requests to a specific endpoint. For more information, see Regions and Endpoints in the AWS General Reference.
How examples are presented
The JSON returned by the AWS Organizations service as response to your requests is returned as a single long string without line breaks or formatting whitespace. Both line breaks and whitespace are included in the examples in this guide to improve readability. When example input parameters also would result in long strings that would extend beyond the screen, we insert line breaks to enhance readability. You should always submit the input as a single JSON text string.
Recording API Requests
AWS Organizations supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by AWS CloudTrail, you can determine which requests were successfully made to Organizations, who made the request, when it was made, and so on. For more about AWS Organizations and its support for AWS CloudTrail, see Logging AWS Organizations Events with AWS CloudTrail in the AWS Organizations User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
" }