META-INF.smithy.organizations.smithy Maven / Gradle / Ivy
Show all versions of aws-organizations-spec Show documentation
$version: "2.0"
metadata suppressions = [
{
id: "HttpMethodSemantics"
namespace: "*"
}
{
id: "HttpResponseCodeSemantics"
namespace: "*"
}
{
id: "PaginatedTrait"
namespace: "*"
}
{
id: "HttpHeaderTrait"
namespace: "*"
}
{
id: "HttpUriConflict"
namespace: "*"
}
{
id: "Service"
namespace: "*"
}
]
namespace com.amazonaws.organizations
use aws.api#service
use aws.auth#sigv4
use aws.protocols#awsJson1_1
/// Organizations is a web service that enables you to consolidate your multiple
/// Amazon Web Services accounts into an organization and centrally manage your
/// accounts and their resources.
/// This guide provides descriptions of the Organizations operations. For more
/// information about using this service, see the Organizations User Guide.
///
/// Support and feedback for Organizations
///
/// We welcome your feedback. Send your comments to [email protected] or post your feedback and questions in
/// the Organizations support forum. For
/// more information about the Amazon Web Services support forums, see Forums Help.
///
/// Endpoint to call When using the CLI or the Amazon Web Services
/// SDK
///
/// For the current release of Organizations, specify the us-east-1 region
/// for all Amazon Web Services API and CLI calls made from the commercial Amazon Web Services Regions outside of
/// China. If calling from one of the Amazon Web Services Regions in China, then specify
/// cn-northwest-1. You can do this in the CLI by using these parameters
/// and commands:
///
/// -
///
Use the following parameter with each command to specify both the endpoint and
/// its region:
///
/// --endpoint-url https://organizations.us-east-1.amazonaws.com
/// (from commercial Amazon Web Services Regions outside of China)
///
/// or
///
/// --endpoint-url
/// https://organizations.cn-northwest-1.amazonaws.com.cn
/// (from Amazon Web Services Regions in China)
///
///
/// -
///
Use the default endpoint, but configure your default region with this
/// command:
///
/// aws configure set default.region us-east-1
/// (from commercial Amazon Web Services Regions outside of China)
///
/// or
///
/// aws configure set default.region cn-northwest-1
/// (from Amazon Web Services Regions in China)
///
///
/// -
///
Use the following parameter with each command to specify the endpoint:
///
/// --region us-east-1
/// (from commercial Amazon Web Services Regions outside of China)
///
/// or
///
/// --region cn-northwest-1
/// (from Amazon Web Services Regions in China)
///
///
///
///
/// Recording API Requests
///
/// Organizations supports CloudTrail, a service that records Amazon Web Services API calls for your
/// Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected
/// by CloudTrail, you can determine which requests the Organizations service received, who made the
/// request and when, and so on. For more about Organizations and its support for CloudTrail, see
/// Logging
/// Organizations API calls with CloudTrail in the
/// Organizations User Guide. To learn more about CloudTrail, including how to turn it
/// on and find your log files, see the CloudTrail User Guide.
@service(
sdkId: "Organizations"
arnNamespace: "organizations"
cloudFormationName: "Organizations"
cloudTrailEventSource: "organizations.amazonaws.com"
endpointPrefix: "organizations"
)
@sigv4(
name: "organizations"
)
@awsJson1_1
@title("AWS Organizations")
@xmlNamespace(
uri: "http://organizations.amazonaws.com/doc/2016-11-28/"
)
service AWSOrganizationsV20161128 {
version: "2016-11-28"
operations: [
AcceptHandshake
AttachPolicy
CancelHandshake
CloseAccount
CreateAccount
CreateGovCloudAccount
CreateOrganization
CreateOrganizationalUnit
CreatePolicy
DeclineHandshake
DeleteOrganization
DeleteOrganizationalUnit
DeletePolicy
DeleteResourcePolicy
DeregisterDelegatedAdministrator
DescribeAccount
DescribeCreateAccountStatus
DescribeEffectivePolicy
DescribeHandshake
DescribeOrganization
DescribeOrganizationalUnit
DescribePolicy
DescribeResourcePolicy
DetachPolicy
DisableAWSServiceAccess
DisablePolicyType
EnableAllFeatures
EnableAWSServiceAccess
EnablePolicyType
InviteAccountToOrganization
LeaveOrganization
ListAccounts
ListAccountsForParent
ListAWSServiceAccessForOrganization
ListChildren
ListCreateAccountStatus
ListDelegatedAdministrators
ListDelegatedServicesForAccount
ListHandshakesForAccount
ListHandshakesForOrganization
ListOrganizationalUnitsForParent
ListParents
ListPolicies
ListPoliciesForTarget
ListRoots
ListTagsForResource
ListTargetsForPolicy
MoveAccount
PutResourcePolicy
RegisterDelegatedAdministrator
RemoveAccountFromOrganization
TagResource
UntagResource
UpdateOrganizationalUnit
UpdatePolicy
]
}
/// Sends a response to the originator of a handshake agreeing to the action proposed by
/// the handshake request.
/// You can only call this operation by the following principals when they also have the
/// relevant IAM permissions:
///
/// -
///
/// Invitation to join or Approve all features request handshakes: only a principal from
/// the member account.
/// The user who calls the API for an invitation to join must have the
/// organizations:AcceptHandshake permission. If you enabled all
/// features in the organization, the user must also have the
/// iam:CreateServiceLinkedRole permission so that Organizations can
/// create the required service-linked role named AWSServiceRoleForOrganizations. For
/// more information, see Organizations and service-linked roles in the
/// Organizations User Guide.
///
/// -
///
/// Enable all features final confirmation
/// handshake: only a principal from the management account.
/// For more information about invitations, see Inviting an
/// Amazon Web Services account to join your organization in the
/// Organizations User Guide. For more information about requests to
/// enable all features in the organization, see Enabling all features in your organization in
/// the Organizations User Guide.
///
///
/// After you accept a handshake, it continues to appear in the results of relevant APIs
/// for only 30 days. After that, it's deleted.
operation AcceptHandshake {
input: AcceptHandshakeRequest
output: AcceptHandshakeResponse
errors: [
AccessDeniedException
AccessDeniedForDependencyException
AWSOrganizationsNotInUseException
ConcurrentModificationException
HandshakeAlreadyInStateException
HandshakeConstraintViolationException
HandshakeNotFoundException
InvalidHandshakeTransitionException
InvalidInputException
ServiceException
TooManyRequestsException
]
}
/// Attaches a policy to a root, an organizational unit (OU), or an individual account.
/// How the policy affects accounts depends on the type of policy. Refer to the
/// Organizations User Guide for information about each policy type:
///
/// -
///
/// AISERVICES_OPT_OUT_POLICY
///
///
/// -
///
/// BACKUP_POLICY
///
///
/// -
///
/// SERVICE_CONTROL_POLICY
///
///
/// -
///
/// TAG_POLICY
///
///
///
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To attach a policy to an OU"
documentation: "The following example shows how to attach a service control policy (SCP) to an OU:\n"
input: {
TargetId: "ou-examplerootid111-exampleouid111"
PolicyId: "p-examplepolicyid111"
}
}
])
operation AttachPolicy {
input: AttachPolicyRequest
output: Unit
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
DuplicatePolicyAttachmentException
InvalidInputException
PolicyChangesInProgressException
PolicyNotFoundException
PolicyTypeNotEnabledException
ServiceException
TargetNotFoundException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Cancels a handshake. Canceling a handshake sets the handshake state to
/// CANCELED.
/// This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient
/// can no longer respond to that handshake.
/// After you cancel a handshake, it continues to appear in the results of relevant APIs
/// for only 30 days. After that, it's deleted.
operation CancelHandshake {
input: CancelHandshakeRequest
output: CancelHandshakeResponse
errors: [
AccessDeniedException
ConcurrentModificationException
HandshakeAlreadyInStateException
HandshakeNotFoundException
InvalidHandshakeTransitionException
InvalidInputException
ServiceException
TooManyRequestsException
]
}
/// Closes an Amazon Web Services member account within an organization. You can close an account when
/// all
/// features are enabled . You can't close the management account with this API.
/// This is an asynchronous request that Amazon Web Services performs in the background. Because
/// CloseAccount operates asynchronously, it can return a successful
/// completion message even though account closure might still be in progress. You need to
/// wait a few minutes before the account is fully closed. To check the status of the
/// request, do one of the following:
///
/// -
///
Use the AccountId that you sent in the CloseAccount
/// request to provide as a parameter to the DescribeAccount
/// operation.
/// While the close account request is in progress, Account status will indicate
/// PENDING_CLOSURE. When the close account request completes, the status will
/// change to SUSPENDED.
///
/// -
///
Check the CloudTrail log for the CloseAccountResult event that gets
/// published after the account closes successfully. For information on using CloudTrail
/// with Organizations, see Logging and monitoring in Organizations in the
/// Organizations User Guide.
///
///
///
///
/// -
///
You can close only 10% of member accounts, between 10 and 200, within a
/// rolling 30 day period. This quota is not bound by a calendar month, but
/// starts when you close an account. After you reach this limit, you can close
/// additional accounts. For more information, see Closing a member
/// account in your organization in the
/// Organizations User Guide.
///
///
/// -
///
To reinstate a closed account, contact Amazon Web Services Support within the 90-day
/// grace period while the account is in SUSPENDED status.
///
/// -
///
If the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud
/// (US) account, the CloseAccount request will close both
/// accounts. To learn important pre-closure details, see
/// Closing an Amazon Web Services GovCloud (US) account in the
/// Amazon Web Services GovCloud User Guide.
///
///
///
operation CloseAccount {
input: CloseAccountRequest
output: Unit
errors: [
AccessDeniedException
AccountAlreadyClosedException
AccountNotFoundException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConflictException
ConstraintViolationException
InvalidInputException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Creates an Amazon Web Services account that is automatically a member of the organization whose
/// credentials made the request. This is an asynchronous request that Amazon Web Services performs in the
/// background. Because CreateAccount operates asynchronously, it can return a
/// successful completion message even though account initialization might still be in
/// progress. You might need to wait a few minutes before you can successfully access the
/// account. To check the status of the request, do one of the following:
///
/// -
///
Use the Id value of the CreateAccountStatus response
/// element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.
///
/// -
///
Check the CloudTrail log for the CreateAccountResult event. For
/// information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the
/// Organizations User Guide.
///
///
/// The user who calls the API to create an account must have the
/// organizations:CreateAccount permission. If you enabled all features in
/// the organization, Organizations creates the required service-linked role named
/// AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the
/// Organizations User Guide.
/// If the request includes tags, then the requester must have the
/// organizations:TagResource permission.
/// Organizations preconfigures the new member account with a role (named
/// OrganizationAccountAccessRole by default) that grants users in the
/// management account administrator permissions in the new member account. Principals in
/// the management account can assume the role. Organizations clones the company name and address
/// information for the new account from the organization's management account.
/// This operation can be called only from the organization's management account.
/// For more information about creating accounts, see Creating
/// a member account in your organization in the
/// Organizations User Guide.
///
///
/// -
///
When you create an account in an organization using the Organizations console,
/// API, or CLI commands, the information required for the account to operate
/// as a standalone account, such as a payment method 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. For more
/// information, see Considerations before removing an account from an organization
/// in the Organizations User Guide.
///
/// -
///
If you get an exception that indicates that you exceeded your account
/// limits for the organization, contact Amazon Web Services Support.
///
/// -
///
If you get an exception that indicates that the operation failed because
/// your organization is still initializing, wait one hour and then try again.
/// If the error persists, contact Amazon Web Services Support.
///
/// -
///
Using CreateAccount to create multiple temporary accounts
/// isn't recommended. You can only close an account from the Billing and Cost Management console, and
/// you must be signed in as the root user. For information on the requirements
/// and process for closing an account, see Closing a member
/// account in your organization in the
/// Organizations User Guide.
///
///
///
///
/// When you create a member account with this operation, you can choose whether to
/// create the account with the IAM User and Role Access to
/// Billing Information switch enabled. If you enable it, IAM users and
/// roles that have appropriate permissions can view billing information for the
/// account. If you disable it, only the account root user can access billing
/// information. For information about how to disable this switch for an account, see
/// Granting access to
/// your billing information and tools.
///
@examples([
{
title: "To create a new account that is automatically part of the organization"
documentation: "The owner of an organization creates a member account in the organization. The following example shows that when the organization owner creates the member account, the account is preconfigured with the name \"Production Account\" and an owner email address of [email protected]. An IAM role is automatically created using the default name because the roleName parameter is not used. AWS Organizations sends Susan a \"Welcome to AWS\" email:\n\n"
input: {
Email: "[email protected]"
AccountName: "Production Account"
}
output: {
CreateAccountStatus: {
State: "IN_PROGRESS"
Id: "car-examplecreateaccountrequestid111"
}
}
}
])
operation CreateAccount {
input: CreateAccountRequest
output: CreateAccountResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
FinalizingOrganizationException
InvalidInputException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// This action is available if all of the following are true:
///
/// -
///
You're authorized to create accounts in the Amazon Web Services GovCloud (US) Region. For
/// more information on the Amazon Web Services GovCloud (US) Region, see the
/// Amazon Web Services GovCloud User Guide.
///
///
/// -
///
You already have an account in the Amazon Web Services GovCloud (US) Region that is paired
/// with a management account of an organization in the commercial Region.
///
/// -
///
You call this action from the management account of your organization in the
/// commercial Region.
///
/// -
///
You have the organizations:CreateGovCloudAccount permission.
///
///
///
/// Organizations automatically creates the required service-linked role named
/// AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the
/// Organizations User Guide.
/// Amazon Web Services automatically enables CloudTrail for Amazon Web Services GovCloud (US) accounts, but you should also
/// do the following:
///
/// -
///
Verify that CloudTrail is enabled to store logs.
///
/// -
///
Create an Amazon S3 bucket for CloudTrail log storage.
/// For more information, see Verifying CloudTrail Is
/// Enabled in the Amazon Web Services GovCloud User Guide.
///
///
///
/// If the request includes tags, then the requester must have the
/// organizations:TagResource permission. The tags are attached to the
/// commercial account associated with the GovCloud account, rather than the GovCloud
/// account itself. To add tags to the GovCloud account, call the TagResource operation in the GovCloud Region after the new GovCloud
/// account exists.
/// You call this action from the management account of your organization in the
/// commercial Region to create a standalone Amazon Web Services account in the Amazon Web Services GovCloud (US)
/// Region. After the account is created, the management account of an organization in the
/// Amazon Web Services GovCloud (US) Region can invite it to that organization. For more information on
/// inviting standalone accounts in the Amazon Web Services GovCloud (US) to join an organization, see
/// Organizations in the
/// Amazon Web Services GovCloud User Guide.
/// Calling CreateGovCloudAccount is an asynchronous request that Amazon Web Services
/// performs in the background. Because CreateGovCloudAccount operates
/// asynchronously, it can return a successful completion message even though account
/// initialization might still be in progress. You might need to wait a few minutes before
/// you can successfully access the account. To check the status of the request, do one of
/// the following:
///
/// -
///
Use the OperationId response element from this operation to
/// provide as a parameter to the DescribeCreateAccountStatus
/// operation.
///
/// -
///
Check the CloudTrail log for the CreateAccountResult event. For
/// information on using CloudTrail with Organizations, see Logging and
/// monitoring in Organizations in the
/// Organizations User Guide.
///
///
///
/// When you call the CreateGovCloudAccount action, you create two accounts:
/// a standalone account in the Amazon Web Services GovCloud (US) Region and an associated account in the
/// commercial Region for billing and support purposes. The account in the commercial Region
/// is automatically a member of the organization whose credentials made the request. Both
/// accounts are associated with the same email address.
/// A role is created in the new account in the commercial Region that allows the
/// management account in the organization in the commercial Region to assume it. An Amazon Web Services
/// GovCloud (US) account is then created and associated with the commercial account that
/// you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can
/// be assumed by the Amazon Web Services GovCloud (US) account that is associated with the management
/// account of the commercial organization. For more information and to view a diagram that
/// explains how account access works, see Organizations in the
/// Amazon Web Services GovCloud User Guide.
/// For more information about creating accounts, see Creating
/// a member account in your organization in the
/// Organizations User Guide.
///
///
/// -
///
When you create an account in an organization using the Organizations console,
/// API, or CLI commands, the information required for the account to operate as
/// a standalone account is not automatically collected.
/// This includes a payment method and signing the end user license agreement
/// (EULA). If you must remove an account from your organization later, you can
/// do so only after you provide the missing information. For more information,
/// see Considerations before removing an account from an organization
/// in the Organizations User Guide.
///
/// -
///
If you get an exception that indicates that you exceeded your account
/// limits for the organization, contact Amazon Web Services Support.
///
/// -
///
If you get an exception that indicates that the operation failed because
/// your organization is still initializing, wait one hour and then try again.
/// If the error persists, contact Amazon Web Services Support.
///
/// -
///
Using CreateGovCloudAccount to create multiple temporary
/// accounts isn't recommended. You can only close an account from the Amazon Web Services
/// Billing and Cost Management console, and you must be signed in as the root user. For information on
/// the requirements and process for closing an account, see Closing a member
/// account in your organization in the
/// Organizations User Guide.
///
///
///
///
/// When you create a member account with this operation, you can choose whether to
/// create the account with the IAM User and Role Access to
/// Billing Information switch enabled. If you enable it, IAM users and
/// roles that have appropriate permissions can view billing information for the
/// account. If you disable it, only the account root user can access billing
/// information. For information about how to disable this switch for an account, see
/// Granting
/// access to your billing information and tools.
///
operation CreateGovCloudAccount {
input: CreateGovCloudAccountRequest
output: CreateGovCloudAccountResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
FinalizingOrganizationException
InvalidInputException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Creates an Amazon Web Services organization. The account whose user is calling the
/// CreateOrganization operation automatically becomes the management account of the new organization.
/// This operation must be called using credentials from the account that is to become the
/// new organization's management account. The principal must also have the relevant IAM
/// permissions.
/// By default (or if you set the FeatureSet parameter to ALL),
/// the new organization is created with all features enabled and service control policies
/// automatically enabled in the root. If you instead choose to create the organization
/// supporting only the consolidated billing features by setting the FeatureSet
/// parameter to CONSOLIDATED_BILLING, no policy types are enabled by default
/// and you can't use organization policies.
@examples([
{
title: "To create a new organization with all features enabled"
documentation: "Bill wants to create an organization using credentials from account 111111111111. The following example shows that the account becomes the master account in the new organization. Because he does not specify a feature set, the new organization defaults to all features enabled and service control policies enabled on the root:\n\n"
output: {
Organization: {
AvailablePolicyTypes: [
{
Status: "ENABLED"
Type: "SERVICE_CONTROL_POLICY"
}
]
MasterAccountId: "111111111111"
MasterAccountArn: "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111"
MasterAccountEmail: "[email protected]"
FeatureSet: "ALL"
Id: "o-exampleorgid"
Arn: "arn:aws:organizations::111111111111:organization/o-exampleorgid"
}
}
}
])
operation CreateOrganization {
input: CreateOrganizationRequest
output: CreateOrganizationResponse
errors: [
AccessDeniedException
AccessDeniedForDependencyException
AlreadyInOrganizationException
ConcurrentModificationException
ConstraintViolationException
InvalidInputException
ServiceException
TooManyRequestsException
]
}
/// Creates an organizational unit (OU) within a root or parent OU. An OU is a container
/// for accounts that enables you to organize your accounts to apply policies according to
/// your business requirements. The number of levels deep that you can nest OUs is dependent
/// upon the policy types enabled for that root. For service control policies, the limit is
/// five.
/// For more information about OUs, see Managing organizational units (OUs) in the
/// Organizations User Guide.
/// If the request includes tags, then the requester must have the
/// organizations:TagResource permission.
/// This operation can be called only from the organization's management account.
@examples([
{
title: "To create a new organization unit"
documentation: "The following example shows how to create an OU that is named AccountingOU. The new OU is directly under the root.:\n\n"
input: {
ParentId: "r-examplerootid111"
Name: "AccountingOU"
}
output: {
OrganizationalUnit: {
Id: "ou-examplerootid111-exampleouid111"
Arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111"
Name: "AccountingOU"
}
}
}
])
operation CreateOrganizationalUnit {
input: CreateOrganizationalUnitRequest
output: CreateOrganizationalUnitResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
DuplicateOrganizationalUnitException
InvalidInputException
ParentNotFoundException
ServiceException
TooManyRequestsException
]
}
/// Creates a policy of a specified type that you can attach to a root, an organizational
/// unit (OU), or an individual Amazon Web Services account.
/// For more information about policies and their use, see Managing
/// Organizations policies.
/// If the request includes tags, then the requester must have the
/// organizations:TagResource permission.
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To create a service control policy"
documentation: "The following example shows how to create a service control policy (SCP) that is named AllowAllS3Actions. The JSON string in the content parameter specifies the content in the policy. The parameter string is escaped with backslashes to ensure that the embedded double quotes in the JSON policy are treated as literals in the parameter, which itself is surrounded by double quotes:\n\n"
input: {
Content: "{\\\"Version\\\":\\\"2012-10-17\\\",\\\"Statement\\\":{\\\"Effect\\\":\\\"Allow\\\",\\\"Action\\\":\\\"s3:*\\\"}}"
Type: "SERVICE_CONTROL_POLICY"
Description: "Enables admins of attached accounts to delegate all S3 permissions"
Name: "AllowAllS3Actions"
}
output: {
Policy: {
Content: "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\"}}"
PolicySummary: {
Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111"
Description: "Allows delegation of all S3 actions"
Name: "AllowAllS3Actions"
Type: "SERVICE_CONTROL_POLICY"
}
}
}
}
])
operation CreatePolicy {
input: CreatePolicyRequest
output: CreatePolicyResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
DuplicatePolicyException
InvalidInputException
MalformedPolicyDocumentException
PolicyTypeNotAvailableForOrganizationException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Declines a handshake request. This sets the handshake state to DECLINED
/// and effectively deactivates the request.
/// This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake
/// instead. The originator can't reactivate a declined request, but can reinitiate the
/// process with a new handshake request.
/// After you decline a handshake, it continues to appear in the results of relevant APIs
/// for only 30 days. After that, it's deleted.
@examples([
{
title: "To decline a handshake sent from the master account"
documentation: "The following example shows Susan declining an invitation to join Bill's organization. The DeclineHandshake operation returns a handshake object, showing that the state is now DECLINED:"
input: {
HandshakeId: "h-examplehandshakeid111"
}
output: {
Handshake: {
Id: "h-examplehandshakeid111"
State: "DECLINED"
Resources: [
{
Type: "ORGANIZATION"
Value: "o-exampleorgid"
Resources: [
{
Type: "MASTER_EMAIL"
Value: "[email protected]"
}
{
Type: "MASTER_NAME"
Value: "Master Account"
}
]
}
{
Type: "ACCOUNT"
Value: "222222222222"
}
{
Type: "NOTES"
Value: "This is an invitation to Susan's account to join the Bill's organization."
}
]
Parties: [
{
Type: "ACCOUNT"
Id: "222222222222"
}
{
Type: "ORGANIZATION"
Id: "o-exampleorgid"
}
]
Action: "INVITE"
RequestedTimestamp: "2016-11-30T19:27:58Z"
ExpirationTimestamp: "2016-12-15T19:27:58Z"
Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111"
}
}
}
])
operation DeclineHandshake {
input: DeclineHandshakeRequest
output: DeclineHandshakeResponse
errors: [
AccessDeniedException
ConcurrentModificationException
HandshakeAlreadyInStateException
HandshakeNotFoundException
InvalidHandshakeTransitionException
InvalidInputException
ServiceException
TooManyRequestsException
]
}
/// Deletes the organization. You can delete an organization only by using credentials
/// from the management account. The organization must be empty of member accounts.
operation DeleteOrganization {
input: Unit
output: Unit
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
InvalidInputException
OrganizationNotEmptyException
ServiceException
TooManyRequestsException
]
}
/// Deletes an organizational unit (OU) from a root or another OU. You must first remove
/// all accounts and child OUs from the OU that you want to delete.
/// This operation can be called only from the organization's management account.
@examples([
{
title: "To delete an organization unit"
documentation: "The following example shows how to delete an OU. The example assumes that you previously removed all accounts and other OUs from the OU:\n\n"
input: {
OrganizationalUnitId: "ou-examplerootid111-exampleouid111"
}
}
])
operation DeleteOrganizationalUnit {
input: DeleteOrganizationalUnitRequest
output: Unit
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
InvalidInputException
OrganizationalUnitNotEmptyException
OrganizationalUnitNotFoundException
ServiceException
TooManyRequestsException
]
}
/// Deletes the specified policy from your organization. Before you perform this
/// operation, you must first detach the policy from all organizational units (OUs), roots,
/// and accounts.
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To delete a policy"
documentation: "The following example shows how to delete a policy from an organization. The example assumes that you previously detached the policy from all entities:\n\n"
input: {
PolicyId: "p-examplepolicyid111"
}
}
])
operation DeletePolicy {
input: DeletePolicyRequest
output: Unit
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
InvalidInputException
PolicyInUseException
PolicyNotFoundException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Deletes the resource policy from your organization.
/// You can only call this operation from the organization's management account.
operation DeleteResourcePolicy {
input: Unit
output: Unit
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
ResourcePolicyNotFoundException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Removes the specified member Amazon Web Services account as a delegated administrator for the
/// specified Amazon Web Services service.
///
/// Deregistering a delegated administrator can have unintended impacts on the
/// functionality of the enabled Amazon Web Services service. See the documentation for the enabled
/// service before you deregister a delegated administrator so that you understand any
/// potential impacts.
///
/// You can run this action only for Amazon Web Services services that support this
/// feature. For a current list of services that support it, see the column Supports
/// Delegated Administrator in the table at Amazon Web Services Services that you can use with
/// Organizations in the Organizations User Guide.
///
/// This operation can be called only from the organization's management account.
operation DeregisterDelegatedAdministrator {
input: DeregisterDelegatedAdministratorRequest
output: Unit
errors: [
AccessDeniedException
AccountNotFoundException
AccountNotRegisteredException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
InvalidInputException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Retrieves Organizations-related information about the specified account.
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To get the details about an account"
documentation: "The following example shows a user in the master account (111111111111) asking for details about account 555555555555:"
input: {
AccountId: "555555555555"
}
output: {
Account: {
Arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555"
Id: "555555555555"
Email: "[email protected]"
Name: "Beta Account"
}
}
}
])
operation DescribeAccount {
input: DescribeAccountRequest
output: DescribeAccountResponse
errors: [
AccessDeniedException
AccountNotFoundException
AWSOrganizationsNotInUseException
InvalidInputException
ServiceException
TooManyRequestsException
]
}
/// Retrieves the current status of an asynchronous request to create an account.
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To get information about a request to create an account"
documentation: "The following example shows how to request the status about a previous request to create an account in an organization. This operation can be called only by a principal from the organization's master account. In the example, the specified \"createAccountRequestId\" comes from the response of the original call to \"CreateAccount\":"
input: {
CreateAccountRequestId: "car-exampleaccountcreationrequestid"
}
output: {
CreateAccountStatus: {
State: "SUCCEEDED"
AccountId: "333333333333"
Id: "car-exampleaccountcreationrequestid"
}
}
}
])
operation DescribeCreateAccountStatus {
input: DescribeCreateAccountStatusRequest
output: DescribeCreateAccountStatusResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
CreateAccountStatusNotFoundException
InvalidInputException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Returns the contents of the effective policy for specified policy type and account.
/// The effective policy is the aggregation of any policies of the specified type that the
/// account inherits, plus any policy of that type that is directly attached to the
/// account.
/// This operation applies only to policy types other than service
/// control policies (SCPs).
/// For more information about policy inheritance, see Understanding management policy
/// inheritance in the Organizations User Guide.
/// This operation can be called from any account in the organization.
operation DescribeEffectivePolicy {
input: DescribeEffectivePolicyRequest
output: DescribeEffectivePolicyResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConstraintViolationException
EffectivePolicyNotFoundException
InvalidInputException
ServiceException
TargetNotFoundException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Retrieves information about a previously requested handshake. The handshake ID comes
/// from the response to the original InviteAccountToOrganization
/// operation that generated the handshake.
/// You can access handshakes that are ACCEPTED, DECLINED, or
/// CANCELED for only 30 days after they change to that state. They're then
/// deleted and no longer accessible.
/// This operation can be called from any account in the organization.
@examples([
{
title: "To get information about a handshake"
documentation: "The following example shows you how to request details about a handshake. The handshake ID comes either from the original call to \"InviteAccountToOrganization\", or from a call to \"ListHandshakesForAccount\" or \"ListHandshakesForOrganization\":"
input: {
HandshakeId: "h-examplehandshakeid111"
}
output: {
Handshake: {
Id: "h-examplehandshakeid111"
State: "OPEN"
Resources: [
{
Type: "ORGANIZATION"
Value: "o-exampleorgid"
Resources: [
{
Type: "MASTER_EMAIL"
Value: "[email protected]"
}
{
Type: "MASTER_NAME"
Value: "Master Account"
}
]
}
{
Type: "ACCOUNT"
Value: "333333333333"
}
]
Parties: [
{
Type: "ORGANIZATION"
Id: "o-exampleorgid"
}
{
Type: "ACCOUNT"
Id: "333333333333"
}
]
Action: "INVITE"
RequestedTimestamp: "2016-11-30T17:24:58.046Z"
ExpirationTimestamp: "2016-11-30T17:24:58.046Z"
Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111"
}
}
}
])
operation DescribeHandshake {
input: DescribeHandshakeRequest
output: DescribeHandshakeResponse
errors: [
AccessDeniedException
ConcurrentModificationException
HandshakeNotFoundException
InvalidInputException
ServiceException
TooManyRequestsException
]
}
/// Retrieves information about the organization that the user's account belongs
/// to.
/// This operation can be called from any account in the organization.
///
/// Even if a policy type is shown as available in the organization, you can disable
/// it separately at the root level with DisablePolicyType. Use ListRoots to see the status of policy types for a specified
/// root.
///
@examples([
{
title: "To get information about an organization"
documentation: "The following example shows how to request information about the current user's organization:/n/n"
output: {
Organization: {
MasterAccountArn: "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111"
MasterAccountEmail: "[email protected]"
Id: "o-exampleorgid"
FeatureSet: "ALL"
Arn: "arn:aws:organizations::111111111111:organization/o-exampleorgid"
AvailablePolicyTypes: [
{
Status: "ENABLED"
Type: "SERVICE_CONTROL_POLICY"
}
]
}
}
}
])
operation DescribeOrganization {
input: Unit
output: DescribeOrganizationResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ServiceException
TooManyRequestsException
]
}
/// Retrieves information about an organizational unit (OU).
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To get information about an organizational unit"
documentation: "The following example shows how to request details about an OU:/n/n"
input: {
OrganizationalUnitId: "ou-examplerootid111-exampleouid111"
}
output: {
OrganizationalUnit: {
Name: "Accounting Group"
Arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111"
Id: "ou-examplerootid111-exampleouid111"
}
}
}
])
operation DescribeOrganizationalUnit {
input: DescribeOrganizationalUnitRequest
output: DescribeOrganizationalUnitResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
InvalidInputException
OrganizationalUnitNotFoundException
ServiceException
TooManyRequestsException
]
}
/// Retrieves information about a policy.
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To get information about a policy"
documentation: "The following example shows how to request information about a policy:/n/n"
input: {
PolicyId: "p-examplepolicyid111"
}
output: {
Policy: {
Content: "{\\n \\\"Version\\\": \\\"2012-10-17\\\",\\n \\\"Statement\\\": [\\n {\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Action\\\": \\\"*\\\",\\n \\\"Resource\\\": \\\"*\\\"\\n }\\n ]\\n}"
PolicySummary: {
Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111"
Type: "SERVICE_CONTROL_POLICY"
Id: "p-examplepolicyid111"
AwsManaged: false
Name: "AllowAllS3Actions"
Description: "Enables admins to delegate S3 permissions"
}
}
}
}
])
operation DescribePolicy {
input: DescribePolicyRequest
output: DescribePolicyResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
InvalidInputException
PolicyNotFoundException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Retrieves information about a resource policy.
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
operation DescribeResourcePolicy {
input: Unit
output: DescribeResourcePolicyResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConstraintViolationException
ResourcePolicyNotFoundException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Detaches a policy from a target root, organizational unit (OU), or account.
///
/// If the policy being detached is a service control policy (SCP), the changes to
/// permissions for Identity and Access Management (IAM) users and roles in affected accounts are
/// immediate.
///
/// Every root, OU, and account must have at least one SCP attached. If you want to
/// replace the default FullAWSAccess policy with an SCP that limits the
/// permissions that can be delegated, you must attach the replacement SCP before you can
/// remove the default SCP. This is the authorization strategy of an "allow list". If you instead attach a second SCP and
/// leave the FullAWSAccess SCP still attached, and specify "Effect":
/// "Deny" in the second SCP to override the "Effect": "Allow" in
/// the FullAWSAccess policy (or any other attached SCP), you're using the
/// authorization strategy of a "deny list".
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To detach a policy from a root, OU, or account"
documentation: "The following example shows how to detach a policy from an OU:/n/n"
input: {
TargetId: "ou-examplerootid111-exampleouid111"
PolicyId: "p-examplepolicyid111"
}
}
])
operation DetachPolicy {
input: DetachPolicyRequest
output: Unit
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
InvalidInputException
PolicyChangesInProgressException
PolicyNotAttachedException
PolicyNotFoundException
ServiceException
TargetNotFoundException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Disables the integration of an Amazon Web Services service (the service that is specified by
/// ServicePrincipal) with Organizations. When you disable integration, the
/// specified service no longer can create a service-linked role in
/// new accounts in your organization. This means the service can't
/// perform operations on your behalf on any new accounts in your organization. The service
/// can still perform operations in older accounts until the service completes its clean-up
/// from Organizations.
///
/// We
/// strongly recommend
/// that
/// you don't use this command to disable integration between Organizations and the specified
/// Amazon Web Services service. Instead, use the console or commands that are provided by the
/// specified service. This lets the trusted service perform any required initialization
/// when enabling trusted access, such as creating any required resources and any
/// required clean up of resources when disabling trusted access.
/// For information about how to disable trusted service access to your organization
/// using the trusted service, see the Learn more link
/// under the Supports Trusted Access column at Amazon Web Services services that you can use with Organizations. on this page.
/// If you disable access by using this command, it causes the following actions to
/// occur:
///
/// -
///
The service can no longer create a service-linked role in the accounts in
/// your organization. This means that the service can't perform operations on
/// your behalf on any new accounts in your organization. The service can still
/// perform operations in older accounts until the service completes its
/// clean-up from Organizations.
///
/// -
///
The service can no longer perform tasks in the member accounts in the
/// organization, unless those operations are explicitly permitted by the IAM
/// policies that are attached to your roles. This includes any data aggregation
/// from the member accounts to the management account, or to a delegated
/// administrator account, where relevant.
///
/// -
///
Some services detect this and clean up any remaining data or resources
/// related to the integration, while other services stop accessing the
/// organization but leave any historical data and configuration in place to
/// support a possible re-enabling of the integration.
///
///
/// Using the other service's console or commands to disable the integration ensures
/// that the other service is aware that it can clean up any resources that are required
/// only for the integration. How the service cleans up its resources in the
/// organization's accounts depends on that service. For more information, see the
/// documentation for the other Amazon Web Services service.
///
/// After you perform the DisableAWSServiceAccess operation, the specified
/// service can no longer perform operations in your organization's accounts
/// For more information about integrating other services with Organizations, including the
/// list of services that work with Organizations, see Using Organizations with other
/// Amazon Web Services services in the Organizations User Guide.
/// This operation can be called only from the organization's management account.
operation DisableAWSServiceAccess {
input: DisableAWSServiceAccessRequest
output: Unit
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
InvalidInputException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Disables an organizational policy type in a root. A policy of a certain type can be
/// attached to entities in a root only if that type is enabled in the root. After you
/// perform this operation, you no longer can attach policies of the specified type to that
/// root or to any organizational unit (OU) or account in that root. You can undo this by
/// using the EnablePolicyType operation.
/// This is an asynchronous request that Amazon Web Services performs in the background. If you disable
/// a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. Amazon Web Services recommends that you
/// first use ListRoots to see the status of policy types for a specified
/// root, and then use this operation.
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
/// To view the status of available policy types in the organization, use DescribeOrganization.
@examples([
{
title: "To disable a policy type in a root"
documentation: "The following example shows how to disable the service control policy (SCP) policy type in a root. The response shows that the PolicyTypes response element no longer includes SERVICE_CONTROL_POLICY:/n/n"
input: {
RootId: "r-examplerootid111"
PolicyType: "SERVICE_CONTROL_POLICY"
}
output: {
Root: {
PolicyTypes: []
Name: "Root"
Id: "r-examplerootid111"
Arn: "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111"
}
}
}
])
operation DisablePolicyType {
input: DisablePolicyTypeRequest
output: DisablePolicyTypeResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
InvalidInputException
PolicyChangesInProgressException
PolicyTypeNotEnabledException
RootNotFoundException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Enables all features in an organization. This enables the use of organization policies
/// that can restrict the services and actions that can be called in each account. Until you
/// enable all features, you have access only to consolidated billing, and you can't use any
/// of the advanced account administration features that Organizations supports. For more
/// information, see Enabling all features in your organization in the
/// Organizations User Guide.
///
/// This operation is required only for organizations that were created explicitly
/// with only the consolidated billing features enabled. Calling this operation sends a
/// handshake to every invited account in the organization. The feature set change can
/// be finalized and the additional features enabled only after all administrators in
/// the invited accounts approve the change by accepting the handshake.
///
/// After you enable all features, you can separately enable or disable individual policy
/// types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use
/// ListRoots.
/// After all invited member accounts accept the handshake, you finalize the feature set
/// change by accepting the handshake that contains "Action":
/// "ENABLE_ALL_FEATURES". This completes the change.
/// After you enable all features in your organization, the management account in the
/// organization can apply policies on all member accounts. These policies can restrict what
/// users and even administrators in those accounts can do. The management account can apply
/// policies that prevent accounts from leaving the organization. Ensure that your account
/// administrators are aware of this.
/// This operation can be called only from the organization's management account.
@examples([
{
title: "To enable all features in an organization"
documentation: "This example shows the administrator asking all the invited accounts in the organization to approve enabling all features in the organization. AWS Organizations sends an email to the address that is registered with every invited member account asking the owner to approve the change by accepting the handshake that is sent. After all invited member accounts accept the handshake, the organization administrator can finalize the change to enable all features, and those with appropriate permissions can create policies and apply them to roots, OUs, and accounts:/n/n"
output: {
Handshake: {
Action: "ENABLE_ALL_FEATURES"
Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/enable_all_features/h-examplehandshakeid111"
ExpirationTimestamp: "2017-02-28T09:35:40.05Z"
Id: "h-examplehandshakeid111"
Parties: [
{
Id: "o-exampleorgid"
Type: "ORGANIZATION"
}
]
RequestedTimestamp: "2017-02-13T09:35:40.05Z"
Resources: [
{
Type: "ORGANIZATION"
Value: "o-exampleorgid"
}
]
State: "REQUESTED"
}
}
}
])
operation EnableAllFeatures {
input: EnableAllFeaturesRequest
output: EnableAllFeaturesResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
HandshakeConstraintViolationException
InvalidInputException
ServiceException
TooManyRequestsException
]
}
/// Enables the integration of an Amazon Web Services service (the service that is specified by
/// ServicePrincipal) with 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 Organizations and the specified Amazon Web Services
/// service by using the console or commands that are provided by the specified service.
/// Doing so ensures that the service is aware that it can create the resources that are
/// required for the integration. How the service creates those resources in the
/// organization's accounts depends on that service. For more information, see the
/// documentation for the other Amazon Web Services service.
///
/// For more information about enabling services to integrate with Organizations, see Using
/// Organizations with other Amazon Web Services services in the
/// Organizations User Guide.
/// You can only call this operation from the organization's management account and only
/// if the organization has enabled all
/// features.
operation EnableAWSServiceAccess {
input: EnableAWSServiceAccessRequest
output: Unit
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
InvalidInputException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Enables a policy type in a root. After you enable a policy type in a root, you can
/// attach policies of that type to the root, any organizational unit (OU), or account in
/// that root. You can undo this by using the DisablePolicyType
/// operation.
/// This is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services
/// recommends that you first use ListRoots to see the status of policy
/// types for a specified root, and then use this operation.
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
/// You can enable a policy type in a root only if that policy type is available in the
/// organization. To view the status of available policy types in the organization, use
/// DescribeOrganization.
@examples([
{
title: "To enable a policy type in a root"
documentation: "The following example shows how to enable the service control policy (SCP) policy type in a root. The output shows a root object with a PolicyTypes response element showing that SCPs are now enabled:/n/n"
input: {
RootId: "r-examplerootid111"
PolicyType: "SERVICE_CONTROL_POLICY"
}
output: {
Root: {
PolicyTypes: [
{
Status: "ENABLED"
Type: "SERVICE_CONTROL_POLICY"
}
]
Name: "Root"
Id: "r-examplerootid111"
Arn: "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111"
}
}
}
])
operation EnablePolicyType {
input: EnablePolicyTypeRequest
output: EnablePolicyTypeResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
InvalidInputException
PolicyChangesInProgressException
PolicyTypeAlreadyEnabledException
PolicyTypeNotAvailableForOrganizationException
RootNotFoundException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// 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 Amazon Web Services accounts only from the same seller as the management
/// account. For example, if your organization's management account was created
/// by Amazon Internet Services Pvt. Ltd (AISPL), an Amazon Web Services seller in India, you
/// can invite only other AISPL accounts to your organization. You can't combine
/// accounts from AISPL and Amazon Web Services or from any other Amazon Web Services 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, contact Amazon Web Services Support.
///
///
///
/// If the request includes tags, then the requester must have the
/// organizations:TagResource permission.
/// This operation can be called only from the organization's management account.
@examples([
{
title: "To invite an account to join an organization"
documentation: "The following example shows the admin of the master account owned by [email protected] inviting the account owned by [email protected] to join an organization."
input: {
Notes: "This is a request for Juan's account to join Bill's organization"
Target: {
Type: "EMAIL"
Id: "[email protected]"
}
}
output: {
Handshake: {
Action: "INVITE"
Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111"
ExpirationTimestamp: "2017-02-16T09:36:05.02Z"
Id: "h-examplehandshakeid111"
Parties: [
{
Id: "o-exampleorgid"
Type: "ORGANIZATION"
}
{
Id: "[email protected]"
Type: "EMAIL"
}
]
RequestedTimestamp: "2017-02-01T09:36:05.02Z"
Resources: [
{
Resources: [
{
Type: "MASTER_EMAIL"
Value: "[email protected]"
}
{
Type: "MASTER_NAME"
Value: "Org Master Account"
}
{
Type: "ORGANIZATION_FEATURE_SET"
Value: "FULL"
}
]
Type: "ORGANIZATION"
Value: "o-exampleorgid"
}
{
Type: "EMAIL"
Value: "[email protected]"
}
]
State: "OPEN"
}
}
}
])
operation InviteAccountToOrganization {
input: InviteAccountToOrganizationRequest
output: InviteAccountToOrganizationResponse
errors: [
AccessDeniedException
AccountOwnerNotVerifiedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
DuplicateHandshakeException
FinalizingOrganizationException
HandshakeConstraintViolationException
InvalidInputException
ServiceException
TooManyRequestsException
]
}
/// Removes a member account from its parent organization. This version of the operation
/// is performed by the account that wants to leave. To remove a member account as a user in
/// the management account, use RemoveAccountFromOrganization
/// instead.
/// This operation can be called only from a member account in the organization.
///
///
/// -
///
The management account in an organization with all features enabled can
/// set service control policies (SCPs) that can restrict what administrators of
/// member accounts can do. This includes preventing them from successfully
/// calling LeaveOrganization and leaving the organization.
///
/// -
///
You can leave an organization as a member account only if the account is
/// configured with the information required to operate as a standalone account.
/// When you create an account in an organization using the Organizations console,
/// API, or CLI commands, the information required of standalone accounts is
/// not automatically collected. For each account that
/// you want to make standalone, you must perform the following steps. If any of
/// the steps are already completed for this account, that step doesn't
/// appear.
///
/// -
///
Choose a support plan
///
/// -
///
Provide and verify the required contact information
///
/// -
///
Provide a current payment method
///
///
/// Amazon Web Services uses the payment method to charge for any billable (not free tier)
/// Amazon Web Services activity that occurs while the account isn't attached to an
/// organization. For more information, see Considerations before removing an account from an organization
/// in the Organizations User Guide.
///
/// -
///
The account that you want to leave must not be a delegated administrator
/// account for any Amazon Web Services service enabled for your organization. If the account
/// is a delegated administrator, you must first change the delegated
/// administrator account to another account that is remaining in the
/// organization.
///
/// -
///
You can leave an organization only after you enable IAM user access to
/// billing in your account. For more information, see About IAM
/// access to the Billing and Cost Management console in the
/// Amazon Web Services Billing and Cost Management User Guide.
///
/// -
///
After the account leaves the organization, all tags that were attached to
/// the account object in the organization are deleted. Amazon Web Services accounts outside
/// of an organization do not support tags.
///
/// -
///
A newly created account has a waiting period before it can be removed from
/// its organization. If you get an error that indicates that a wait period is
/// required, then try again in a few days.
///
/// -
///
If you are using an organization principal to call
/// LeaveOrganization across multiple accounts, you can only do
/// this up to 5 accounts per second in a single organization.
///
///
///
@examples([
{
title: "To leave an organization as a member account"
documentation: "TThe following example shows how to remove your member account from an organization:"
}
])
operation LeaveOrganization {
input: Unit
output: Unit
errors: [
AccessDeniedException
AccountNotFoundException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
InvalidInputException
MasterCannotLeaveOrganizationException
ServiceException
TooManyRequestsException
]
}
/// 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
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation ListAccounts {
input: ListAccountsRequest
output: ListAccountsResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
InvalidInputException
ServiceException
TooManyRequestsException
]
}
/// Lists the accounts in an organization that are contained by the specified target root
/// or organizational unit (OU). If you specify the root, you get a list of all the accounts
/// that aren't in any OU. If you specify an OU, you get a list of all the accounts in only
/// that OU and not in any child OUs. To get a list of all accounts in the organization, use
/// the ListAccounts operation.
///
/// Always check the NextToken response parameter
/// for a null value when calling a List* operation. These operations can
/// occasionally return an empty set of results even when there are more results available. The
/// NextToken response parameter value is null
/// only
/// when there are no more results to display.
///
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To retrieve a list of all of the accounts in a root or OU"
documentation: "The following example shows how to request a list of the accounts in an OU:/n/n"
input: {
ParentId: "ou-examplerootid111-exampleouid111"
}
output: {
Accounts: [
{
Arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333"
JoinedMethod: "INVITED"
JoinedTimestamp: 1.481835795536E9
Id: "333333333333"
Name: "Development Account"
Email: "[email protected]"
Status: "ACTIVE"
}
{
Arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444"
JoinedMethod: "INVITED"
JoinedTimestamp: 1.481835812143E9
Id: "444444444444"
Name: "Test Account"
Email: "[email protected]"
Status: "ACTIVE"
}
]
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation ListAccountsForParent {
input: ListAccountsForParentRequest
output: ListAccountsForParentResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
InvalidInputException
ParentNotFoundException
ServiceException
TooManyRequestsException
]
}
/// Returns a list of the Amazon Web Services services that you enabled to integrate with your
/// organization. After a service on this list creates the resources that it requires for
/// the integration, it can perform operations on your organization and its accounts.
/// For more information about integrating other services with Organizations, including the
/// list of services that currently work with Organizations, see Using Organizations with other
/// Amazon Web Services services in the Organizations User Guide.
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation ListAWSServiceAccessForOrganization {
input: ListAWSServiceAccessForOrganizationRequest
output: ListAWSServiceAccessForOrganizationResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConstraintViolationException
InvalidInputException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// 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
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To retrieve a list of all of the child accounts and OUs in a parent root or OU"
documentation: "The following example shows how to request a list of the child OUs in a parent root or OU:/n/n"
input: {
ChildType: "ORGANIZATIONAL_UNIT"
ParentId: "ou-examplerootid111-exampleouid111"
}
output: {
Children: [
{
Id: "ou-examplerootid111-exampleouid111"
Type: "ORGANIZATIONAL_UNIT"
}
{
Id: "ou-examplerootid111-exampleouid222"
Type: "ORGANIZATIONAL_UNIT"
}
]
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation ListChildren {
input: ListChildrenRequest
output: ListChildrenResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
InvalidInputException
ParentNotFoundException
ServiceException
TooManyRequestsException
]
}
/// 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
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To get a list of completed account creation requests made in the organization"
documentation: "The following example shows a user requesting a list of only the completed account creation requests made for the current organization:"
input: {
States: [
"SUCCEEDED"
]
}
output: {
CreateAccountStatuses: [
{
Id: "car-exampleaccountcreationrequestid1"
AccountId: "444444444444"
AccountName: "Developer Test Account"
RequestedTimestamp: "2017-01-15T13:45:23.01Z"
State: "SUCCEEDED"
CompletedTimestamp: "2017-01-15T13:45:23.6Z"
}
]
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation ListCreateAccountStatus {
input: ListCreateAccountStatusRequest
output: ListCreateAccountStatusResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
InvalidInputException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Lists the Amazon Web Services accounts that are designated as delegated administrators in this
/// organization.
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
items: "DelegatedAdministrators"
pageSize: "MaxResults"
)
operation ListDelegatedAdministrators {
input: ListDelegatedAdministratorsRequest
output: ListDelegatedAdministratorsResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConstraintViolationException
InvalidInputException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// List the Amazon Web Services services for which the specified account is a delegated
/// administrator.
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
items: "DelegatedServices"
pageSize: "MaxResults"
)
operation ListDelegatedServicesForAccount {
input: ListDelegatedServicesForAccountRequest
output: ListDelegatedServicesForAccountResponse
errors: [
AccessDeniedException
AccountNotFoundException
AccountNotRegisteredException
AWSOrganizationsNotInUseException
ConstraintViolationException
InvalidInputException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Lists the current handshakes that are associated with the account of the requesting
/// user.
/// Handshakes that are ACCEPTED, DECLINED,
/// CANCELED, or EXPIRED appear in the results of this API for
/// only 30 days after changing to that state. After that, they're deleted and no longer
/// accessible.
///
/// Always check the NextToken response parameter
/// for a null value when calling a List* operation. These operations can
/// occasionally return an empty set of results even when there are more results available. The
/// NextToken response parameter value is null
/// only
/// when there are no more results to display.
///
/// This operation can be called from any account in the organization.
@examples([
{
title: "To retrieve a list of the handshakes sent to an account"
documentation: "The following example shows you how to get a list of handshakes that are associated with the account of the credentials used to call the operation:"
output: {
Handshakes: [
{
Action: "INVITE"
Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111"
ExpirationTimestamp: "2017-01-28T14:35:23.3Z"
Id: "h-examplehandshakeid111"
Parties: [
{
Id: "o-exampleorgid"
Type: "ORGANIZATION"
}
{
Id: "[email protected]"
Type: "EMAIL"
}
]
RequestedTimestamp: "2017-01-13T14:35:23.3Z"
Resources: [
{
Resources: [
{
Type: "MASTER_EMAIL"
Value: "[email protected]"
}
{
Type: "MASTER_NAME"
Value: "Org Master Account"
}
{
Type: "ORGANIZATION_FEATURE_SET"
Value: "FULL"
}
]
Type: "ORGANIZATION"
Value: "o-exampleorgid"
}
{
Type: "EMAIL"
Value: "[email protected]"
}
]
State: "OPEN"
}
]
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation ListHandshakesForAccount {
input: ListHandshakesForAccountRequest
output: ListHandshakesForAccountResponse
errors: [
AccessDeniedException
ConcurrentModificationException
InvalidInputException
ServiceException
TooManyRequestsException
]
}
/// 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,
/// CANCELED, or EXPIRED appear in the results of this API for
/// only 30 days after changing to that state. After that, they're deleted and no longer
/// accessible.
///
/// Always check the NextToken response parameter
/// for a null value when calling a List* operation. These operations can
/// occasionally return an empty set of results even when there are more results available. The
/// NextToken response parameter value is null
/// only
/// when there are no more results to display.
///
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To retrieve a list of the handshakes associated with an organization"
documentation: "The following example shows you how to get a list of handshakes associated with the current organization:"
output: {
Handshakes: [
{
Action: "INVITE"
Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111"
ExpirationTimestamp: "2017-01-28T14:35:23.3Z"
Id: "h-examplehandshakeid111"
Parties: [
{
Id: "o-exampleorgid"
Type: "ORGANIZATION"
}
{
Id: "[email protected]"
Type: "EMAIL"
}
]
RequestedTimestamp: "2017-01-13T14:35:23.3Z"
Resources: [
{
Resources: [
{
Type: "MASTER_EMAIL"
Value: "[email protected]"
}
{
Type: "MASTER_NAME"
Value: "Org Master Account"
}
{
Type: "ORGANIZATION_FEATURE_SET"
Value: "FULL"
}
]
Type: "ORGANIZATION"
Value: "o-exampleorgid"
}
{
Type: "EMAIL"
Value: "[email protected]"
}
]
State: "OPEN"
}
{
Action: "INVITE"
State: "ACCEPTED"
Arn: "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111"
ExpirationTimestamp: "2017-01-28T14:35:23.3Z"
Id: "h-examplehandshakeid222"
Parties: [
{
Id: "o-exampleorgid"
Type: "ORGANIZATION"
}
{
Id: "[email protected]"
Type: "EMAIL"
}
]
RequestedTimestamp: "2017-01-13T14:35:23.3Z"
Resources: [
{
Resources: [
{
Type: "MASTER_EMAIL"
Value: "[email protected]"
}
{
Type: "MASTER_NAME"
Value: "Master Account"
}
]
Type: "ORGANIZATION"
Value: "o-exampleorgid"
}
{
Type: "EMAIL"
Value: "[email protected]"
}
{
Type: "NOTES"
Value: "This is an invitation to Anika's account to join Bill's organization."
}
]
}
]
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation ListHandshakesForOrganization {
input: ListHandshakesForOrganizationRequest
output: ListHandshakesForOrganizationResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
InvalidInputException
ServiceException
TooManyRequestsException
]
}
/// 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
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To retrieve a list of all of the child OUs in a parent root or OU"
documentation: "The following example shows how to get a list of OUs in a specified root:/n/n"
input: {
ParentId: "r-examplerootid111"
}
output: {
OrganizationalUnits: [
{
Id: "ou-examplerootid111-exampleouid111"
Arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid111"
Name: "Development"
}
{
Id: "ou-examplerootid111-exampleouid222"
Arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid222"
Name: "Production"
}
]
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation ListOrganizationalUnitsForParent {
input: ListOrganizationalUnitsForParentRequest
output: ListOrganizationalUnitsForParentResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
InvalidInputException
ParentNotFoundException
ServiceException
TooManyRequestsException
]
}
/// 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
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
///
/// In the current release, a child can have only a single parent.
///
@examples([
{
title: "To retrieve a list of all of the parents of a child OU or account"
documentation: "The following example shows how to list the root or OUs that contain account 444444444444:/n/n"
input: {
ChildId: "444444444444"
}
output: {
Parents: [
{
Id: "ou-examplerootid111-exampleouid111"
Type: "ORGANIZATIONAL_UNIT"
}
]
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation ListParents {
input: ListParentsRequest
output: ListParentsResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ChildNotFoundException
InvalidInputException
ServiceException
TooManyRequestsException
]
}
/// 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
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To retrieve a list policies in the organization"
documentation: "The following example shows how to get a list of service control policies (SCPs):/n/n"
input: {
Filter: "SERVICE_CONTROL_POLICY"
}
output: {
Policies: [
{
Type: "SERVICE_CONTROL_POLICY"
Name: "AllowAllS3Actions"
AwsManaged: false
Id: "p-examplepolicyid111"
Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111"
Description: "Enables account admins to delegate permissions for any S3 actions to users and roles in their accounts."
}
{
Type: "SERVICE_CONTROL_POLICY"
Name: "AllowAllEC2Actions"
AwsManaged: false
Id: "p-examplepolicyid222"
Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid222"
Description: "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts."
}
{
Type: "SERVICE_CONTROL_POLICY"
AwsManaged: true
Description: "Allows access to every operation"
Id: "p-FullAWSAccess"
Arn: "arn:aws:organizations::aws:policy/service_control_policy/p-FullAWSAccess"
Name: "FullAWSAccess"
}
]
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation ListPolicies {
input: ListPoliciesRequest
output: ListPoliciesResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
InvalidInputException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// 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
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To retrieve a list policies attached to a root, OU, or account"
documentation: "The following example shows how to get a list of all service control policies (SCPs) of the type specified by the Filter parameter, that are directly attached to an account. The returned list does not include policies that apply to the account because of inheritance from its location in an OU hierarchy:/n/n"
input: {
Filter: "SERVICE_CONTROL_POLICY"
TargetId: "444444444444"
}
output: {
Policies: [
{
Type: "SERVICE_CONTROL_POLICY"
Name: "AllowAllEC2Actions"
AwsManaged: false
Id: "p-examplepolicyid222"
Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid222"
Description: "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts."
}
]
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation ListPoliciesForTarget {
input: ListPoliciesForTargetRequest
output: ListPoliciesForTargetResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
InvalidInputException
ServiceException
TargetNotFoundException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// 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
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
///
/// Policy types can be enabled and disabled in roots. This is distinct from whether
/// they're available in the organization. When you enable all features, you make policy
/// types available for use in that organization. Individual policy types can then be
/// enabled and disabled in a root. To see the availability of a policy type in an
/// organization, use DescribeOrganization.
///
@examples([
{
title: "To retrieve a list of roots in the organization"
documentation: "The following example shows how to get the list of the roots in the current organization:/n/n"
output: {
Roots: [
{
Name: "Root"
Arn: "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111"
Id: "r-examplerootid111"
PolicyTypes: [
{
Status: "ENABLED"
Type: "SERVICE_CONTROL_POLICY"
}
]
}
]
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation ListRoots {
input: ListRootsRequest
output: ListRootsResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
InvalidInputException
ServiceException
TooManyRequestsException
]
}
/// Lists tags that are attached to the specified resource.
/// You can attach tags to the following resources in Organizations.
///
/// -
///
Amazon Web Services account
///
/// -
///
Organization root
///
/// -
///
Organizational unit (OU)
///
/// -
///
Policy (any type)
///
///
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
items: "Tags"
)
operation ListTagsForResource {
input: ListTagsForResourceRequest
output: ListTagsForResourceResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
InvalidInputException
ServiceException
TargetNotFoundException
TooManyRequestsException
]
}
/// Lists all the roots, organizational units (OUs), and accounts that the specified
/// policy is attached to.
///
/// Always check the NextToken response parameter
/// for a null value when calling a List* operation. These operations can
/// occasionally return an empty set of results even when there are more results available. The
/// NextToken response parameter value is null
/// only
/// when there are no more results to display.
///
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To retrieve a list of roots, OUs, and accounts to which a policy is attached"
documentation: "The following example shows how to get the list of roots, OUs, and accounts to which the specified policy is attached:/n/n"
input: {
PolicyId: "p-FullAWSAccess"
}
output: {
Targets: [
{
Arn: "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111"
Name: "Root"
TargetId: "r-examplerootid111"
Type: "ROOT"
}
{
Arn: "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333;"
Name: "Developer Test Account"
TargetId: "333333333333"
Type: "ACCOUNT"
}
{
Arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111"
Name: "Accounting"
TargetId: "ou-examplerootid111-exampleouid111"
Type: "ORGANIZATIONAL_UNIT"
}
]
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
pageSize: "MaxResults"
)
operation ListTargetsForPolicy {
input: ListTargetsForPolicyRequest
output: ListTargetsForPolicyResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
InvalidInputException
PolicyNotFoundException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// 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 management account.
@examples([
{
title: "To move an OU or account to another OU or the root"
documentation: "The following example shows how to move a member account from the root to an OU:/n/n"
input: {
AccountId: "333333333333"
SourceParentId: "r-examplerootid111"
DestinationParentId: "ou-examplerootid111-exampleouid111"
}
}
])
operation MoveAccount {
input: MoveAccountRequest
output: Unit
errors: [
AccessDeniedException
AccountNotFoundException
AWSOrganizationsNotInUseException
ConcurrentModificationException
DestinationParentNotFoundException
DuplicateAccountException
InvalidInputException
ServiceException
SourceParentNotFoundException
TooManyRequestsException
]
}
/// Creates or updates a resource policy.
/// You can only call this operation from the organization's management account.
operation PutResourcePolicy {
input: PutResourcePolicyRequest
output: PutResourcePolicyResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
InvalidInputException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Enables the specified member account to administer the Organizations features of the specified
/// Amazon Web Services service. It grants read-only access to Organizations service data. The account still
/// requires IAM permissions to access and administer the Amazon Web Services service.
/// You can run this action only for Amazon Web Services services that support this
/// feature. For a current list of services that support it, see the column Supports
/// Delegated Administrator in the table at Amazon Web Services Services that you can use with
/// Organizations in the Organizations User Guide.
///
/// This operation can be called only from the organization's management account.
operation RegisterDelegatedAdministrator {
input: RegisterDelegatedAdministratorRequest
output: Unit
errors: [
AccessDeniedException
AccountAlreadyRegisteredException
AccountNotFoundException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
InvalidInputException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
/// Removes the specified account from the organization.
/// The removed account becomes a standalone account that isn't a member of any
/// organization. It's no longer subject to any policies and is responsible for its own bill
/// payments. The organization's management account is no longer charged for any expenses
/// accrued by the member account after it's removed from the organization.
/// This operation can be called only from the organization's management 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 Organizations console,
/// API, or CLI commands, the information required of standalone accounts is
/// not automatically collected. For more information,
/// see Considerations before removing an account from an organization
/// in the Organizations User Guide.
///
/// -
///
The account that you want to leave must not be a delegated administrator
/// account for any Amazon Web Services service enabled for your organization. If the account
/// is a delegated administrator, you must first change the delegated
/// administrator account to another account that is remaining in the
/// organization.
///
/// -
///
After the account leaves the organization, all tags that were attached to
/// the account object in the organization are deleted. Amazon Web Services accounts outside
/// of an organization do not support tags.
///
///
///
@examples([
{
title: "To remove an account from an organization as the master account"
documentation: "The following example shows you how to remove an account from an organization:"
input: {
AccountId: "333333333333"
}
}
])
operation RemoveAccountFromOrganization {
input: RemoveAccountFromOrganizationRequest
output: Unit
errors: [
AccessDeniedException
AccountNotFoundException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
InvalidInputException
MasterCannotLeaveOrganizationException
ServiceException
TooManyRequestsException
]
}
/// Adds one or more tags to the specified resource.
/// Currently, you can attach tags to the following resources in Organizations.
///
/// -
///
Amazon Web Services account
///
/// -
///
Organization root
///
/// -
///
Organizational unit (OU)
///
/// -
///
Policy (any type)
///
///
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
operation TagResource {
input: TagResourceRequest
output: Unit
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
InvalidInputException
ServiceException
TargetNotFoundException
TooManyRequestsException
]
}
/// Removes any tags with the specified keys from the specified resource.
/// You can attach tags to the following resources in Organizations.
///
/// -
///
Amazon Web Services account
///
/// -
///
Organization root
///
/// -
///
Organizational unit (OU)
///
/// -
///
Policy (any type)
///
///
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
operation UntagResource {
input: UntagResourceRequest
output: Unit
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
InvalidInputException
ServiceException
TargetNotFoundException
TooManyRequestsException
]
}
/// Renames the specified organizational unit (OU). The ID and ARN don't change. The child
/// OUs and accounts remain in place, and any attached policies of the OU remain
/// attached.
/// This operation can be called only from the organization's management account.
@examples([
{
title: "To rename an organizational unit"
documentation: "The following example shows how to rename an OU. The output confirms the new name:/n/n"
input: {
OrganizationalUnitId: "ou-examplerootid111-exampleouid111"
Name: "AccountingOU"
}
output: {
OrganizationalUnit: {
Id: "ou-examplerootid111-exampleouid111"
Name: "AccountingOU"
Arn: "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111"
}
}
}
])
operation UpdateOrganizationalUnit {
input: UpdateOrganizationalUnitRequest
output: UpdateOrganizationalUnitResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
DuplicateOrganizationalUnitException
InvalidInputException
OrganizationalUnitNotFoundException
ServiceException
TooManyRequestsException
]
}
/// Updates an existing policy with a new name, description, or content. If you don't
/// supply any parameter, that value remains unchanged. You can't change a policy's
/// type.
/// This operation can be called only from the organization's
/// management account or by a member account that is a delegated administrator for an Amazon Web Services service.
@examples([
{
title: "To update the details of a policy"
documentation: "The following example shows how to rename a policy and give it a new description and new content. The output confirms the new name and description text:/n/n"
input: {
PolicyId: "p-examplepolicyid111"
Name: "Renamed-Policy"
Description: "This description replaces the original."
}
output: {
Policy: {
Content: "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"ec2:*\", \"Resource\": \"*\" } }"
PolicySummary: {
Id: "p-examplepolicyid111"
AwsManaged: false
Arn: "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111"
Description: "This description replaces the original."
Name: "Renamed-Policy"
Type: "SERVICE_CONTROL_POLICY"
}
}
}
}
])
operation UpdatePolicy {
input: UpdatePolicyRequest
output: UpdatePolicyResponse
errors: [
AccessDeniedException
AWSOrganizationsNotInUseException
ConcurrentModificationException
ConstraintViolationException
DuplicatePolicyException
InvalidInputException
MalformedPolicyDocumentException
PolicyChangesInProgressException
PolicyNotFoundException
ServiceException
TooManyRequestsException
UnsupportedAPIEndpointException
]
}
@input
structure AcceptHandshakeRequest {
/// 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 lowercase letters or digits.
@required
HandshakeId: HandshakeId
}
@output
structure AcceptHandshakeResponse {
/// A structure that contains details about the accepted handshake.
Handshake: Handshake
}
/// You don't have permissions to perform the requested operation. The user or role that
/// is making the request must have at least one IAM permissions policy attached that
/// grants the required permissions. For more information, see Access Management in the
/// IAM User Guide.
@error("client")
@httpError(403)
structure AccessDeniedException {
Message: ExceptionMessage
}
/// The operation that you attempted requires you to have the
/// iam:CreateServiceLinkedRole for
/// organizations.amazonaws.com permission so that Organizations can create the
/// required service-linked role. You don't have that permission.
@error("client")
@httpError(403)
structure AccessDeniedForDependencyException {
Message: ExceptionMessage
Reason: AccessDeniedForDependencyExceptionReason
}
/// Contains information about an Amazon Web Services account that is a member of an
/// organization.
structure Account {
/// The unique identifier (ID) of the account.
/// The regex pattern for an account ID string requires exactly 12
/// digits.
Id: AccountId
/// The Amazon Resource Name (ARN) of the account.
/// For more information about ARNs in Organizations, see ARN
/// Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
Arn: AccountArn
/// The email address associated with the Amazon Web Services account.
/// The regex pattern for this parameter is a string of characters that represents a
/// standard internet email address.
Email: Email
/// 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.
Name: AccountName
/// The status of the account in the organization.
Status: AccountStatus
/// The method by which the account joined the organization.
JoinedMethod: AccountJoinedMethod
/// The date the account became a part of the organization.
JoinedTimestamp: Timestamp
}
/// You attempted to close an account that is already closed.
@error("client")
@httpError(409)
structure AccountAlreadyClosedException {
Message: ExceptionMessage
}
/// The specified account is already a delegated administrator for this Amazon Web Services
/// service.
@error("client")
@httpError(409)
structure AccountAlreadyRegisteredException {
Message: ExceptionMessage
}
/// We can't find an Amazon Web Services account with the AccountId that you specified, or
/// the account whose credentials you used to make this request isn't a member of an
/// organization.
@error("client")
@httpError(404)
structure AccountNotFoundException {
Message: ExceptionMessage
}
/// The specified account is not a delegated administrator for this Amazon Web Services service.
@error("client")
@httpError(409)
structure AccountNotRegisteredException {
Message: ExceptionMessage
}
/// You can't invite an existing account to your organization until you verify that you
/// own the email address associated with the management account. For more information, see
/// Email address
/// verification in the Organizations User Guide.
@error("client")
@httpError(403)
structure AccountOwnerNotVerifiedException {
Message: ExceptionMessage
}
/// This account is already a member of an organization. An account can belong to only one
/// organization at a time.
@error("client")
@httpError(409)
structure AlreadyInOrganizationException {
Message: ExceptionMessage
}
@input
structure AttachPolicyRequest {
/// 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 lowercase or uppercase letters, digits, or the underscore character (_).
@required
PolicyId: PolicyId
/// 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 lowercase letters or
/// digits.
///
/// -
///
/// Account - A string that consists of exactly 12 digits.
///
/// -
///
/// Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32
/// lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second
/// "-" dash and from 8 to 32 additional lowercase letters or digits.
///
///
@required
TargetId: PolicyTargetId
}
/// 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.
@error("client")
@httpError(404)
structure AWSOrganizationsNotInUseException {
Message: ExceptionMessage
}
@input
structure CancelHandshakeRequest {
/// 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 lowercase letters or digits.
@required
HandshakeId: HandshakeId
}
@output
structure CancelHandshakeResponse {
/// A structure that contains details about the handshake that you canceled.
Handshake: Handshake
}
/// Contains a list of child entities, either OUs or accounts.
structure Child {
/// The unique identifier (ID) of this child entity.
/// The regex pattern for a child ID string requires one of the
/// following:
///
/// -
///
/// Account - A string that consists of exactly 12 digits.
///
/// -
///
/// Organizational unit (OU) - A string that begins with
/// "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that
/// contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional
/// lowercase letters or digits.
///
///
Id: ChildId
/// The type of this child entity.
Type: ChildType
}
/// We can't find an organizational unit (OU) or Amazon Web Services account with the
/// ChildId that you specified.
@error("client")
@httpError(404)
structure ChildNotFoundException {
Message: ExceptionMessage
}
@input
structure CloseAccountRequest {
/// Retrieves the Amazon Web Services account Id for the current CloseAccount API request.
///
@required
AccountId: AccountId
}
/// The target of the operation is currently being modified by a different request. Try
/// again later.
@error("client")
@httpError(409)
structure ConcurrentModificationException {
Message: ExceptionMessage
}
/// The request failed because it conflicts with the current state of the specified
/// resource.
@error("client")
@httpError(409)
structure ConflictException {
Message: ExceptionMessage
}
/// Performing this operation violates a minimum or maximum value limit. For example,
/// attempting to remove the last service control policy (SCP) from an OU or root, inviting
/// or creating too many accounts to the organization, or attaching too many policies to an
/// account, OU, or root. This exception includes a reason that contains additional
/// information about the violated limit:
///
/// Some of the reasons in the following list might not be applicable to this specific
/// API or operation.
///
///
/// -
///
ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management
/// account from the organization. You can't remove the management account. Instead,
/// after you remove all member accounts, delete the organization itself.
///
/// -
///
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an
/// account from the organization that doesn't yet have enough information to exist
/// as a standalone account. This account requires you to first complete phone
/// verification. Follow the steps at Removing a member account from your organization in the
/// Organizations User Guide.
///
/// -
///
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of
/// accounts that you can create in one day.
///
/// -
///
ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your
/// account isn't fully active. You must complete the account setup before you
/// create an organization.
///
/// -
///
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number
/// of accounts in an organization. If you need more accounts, contact Amazon Web Services Support to
/// request an increase in your limit.
/// Or the number of invitations that you tried to send would cause you to exceed
/// the limit of accounts in your organization. Send fewer invitations or contact
/// Amazon Web Services Support to request an increase in the number of accounts.
///
/// Deleted and closed accounts still count toward your limit.
///
///
/// If you get this exception when running a command immediately after
/// creating the organization, wait one hour and try again. After an hour, if
/// the command continues to fail with this error, contact Amazon Web Services Support.
///
///
/// -
///
CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot
/// register a suspended account as a delegated administrator.
///
/// -
///
CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register
/// the management account of the organization as a delegated administrator for an
/// Amazon Web Services service integrated with Organizations. You can designate only a member account as a
/// delegated administrator.
///
/// -
///
CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management
/// account. To close the management account for the organization, you must first
/// either remove or close all member accounts in the organization. Follow standard
/// account closure process using root credentials.
///
/// -
///
CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an
/// account that is registered as a delegated administrator for a service integrated
/// with your organization. To complete this operation, you must first deregister
/// this account as a delegated administrator.
///
/// -
///
CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the
/// past 30 days.
///
/// -
///
CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of
/// accounts that you can close at a time.
///
/// -
///
CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an
/// organization in the specified region, you must enable all features mode.
///
/// -
///
DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an
/// Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has
/// a delegated administrator. To complete this operation, you must first deregister
/// any existing delegated administrators for this service.
///
/// -
///
EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for
/// a limited period of time. You must resubmit the request and generate a new
/// verfication code.
///
/// -
///
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of
/// handshakes that you can send in one day.
///
/// -
///
INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported
/// payment method is associated with the account. Amazon Web Services does not support cards
/// issued by financial institutions in Russia or Belarus. For more information, see
/// Managing your
/// Amazon Web Services payments.
///
/// -
///
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in
/// this organization, you first must migrate the organization's management account
/// to the marketplace that corresponds to the management account's address. 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_BUSINESS_LICENSE: Applies only to the Amazon Web Services /> Regions
/// in China. To create an organization, the master must have a valid business
/// license. For more information, contact customer support.
///
/// -
///
MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must
/// first provide a valid contact address and phone number for the management
/// account. Then try the operation again.
///
/// -
///
MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the
/// management account must have an associated account in the Amazon Web Services GovCloud
/// (US-West) Region. For more information, see Organizations
/// in the
/// Amazon Web Services GovCloud User Guide.
///
/// -
///
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with
/// this management account, you first must associate a valid payment instrument,
/// such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in
/// the Organizations User Guide.
///
/// -
///
MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to
/// register more delegated administrators than allowed for the service principal.
///
///
/// -
///
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number
/// of policies of a certain type that can be attached to an entity at one
/// time.
///
/// -
///
MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this
/// resource.
///
/// -
///
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with
/// this member account, you first must associate a valid payment instrument, such
/// as a credit card, with the account. For more information, see Considerations before removing an account from an organization in
/// the Organizations User Guide.
///
/// -
///
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy
/// from an entity that would cause the entity to have fewer than the minimum number
/// of policies of a certain type required.
///
/// -
///
ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation
/// that requires the organization to be configured to support all features. An
/// organization that supports only consolidated billing features can't perform this
/// operation.
///
/// -
///
OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many
/// levels deep.
///
/// -
///
OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you
/// can have in an organization.
///
/// -
///
POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger
/// than the maximum size.
///
/// -
///
POLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of policies
/// that you can have in an organization.
///
/// -
///
SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated
/// administrator before you enabled service access. Call the
/// EnableAWSServiceAccess API first.
///
/// -
///
TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags
/// that are not compliant with the tag policy requirements for this account.
///
/// -
///
WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, there is a waiting
/// period before you can remove it from the organization. If you get an error that
/// indicates that a wait period is required, try again in a few days.
///
///
@error("client")
@httpError(409)
structure ConstraintViolationException {
Message: ExceptionMessage
Reason: ConstraintViolationExceptionReason
}
@input
structure CreateAccountRequest {
/// The email address of the owner to assign to the new member account. This email address
/// must not already be associated with another Amazon Web Services account. You must use a valid email
/// address to complete account creation.
/// The rules for a valid email address:
///
/// -
///
The address must be a minimum of 6 and a maximum of 64 characters long.
///
/// -
///
All characters must be 7-bit ASCII characters.
///
/// -
///
There must be one and only one @ symbol, which separates the local name from
/// the domain name.
///
/// -
///
The local name can't contain any of the following characters:
/// whitespace, " ' ( ) < > [ ] : ; , \ | % &
///
/// -
///
The local name can't begin with a dot (.)
///
/// -
///
The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen
/// (-), or dot (.)
///
/// -
///
The domain name can't begin or end with a hyphen (-) or dot (.)
///
/// -
///
The domain name must contain at least one dot
///
///
/// You can't access the root user of the account or remove an account that was created
/// with an invalid email address.
@required
Email: Email
/// The friendly name of the member account.
@required
AccountName: CreateAccountName
/// The name of an IAM role that Organizations automatically preconfigures in the new member
/// account. This role trusts the management account, allowing users in the management
/// account to assume the role, as permitted by the management account administrator. The
/// role has administrator permissions in the new member account.
/// If you don't specify this parameter, the role name defaults to
/// OrganizationAccountAccessRole.
/// For more information about how to use this role to access the member account, see the
/// following links:
///
/// -
///
/// Creating the OrganizationAccountAccessRole in an invited member
/// account in the Organizations User Guide
///
///
/// -
///
Steps 2 and 3 in IAM Tutorial:
/// Delegate access across Amazon Web Services accounts using IAM roles in the
/// IAM User Guide
///
///
///
/// The regex pattern that
/// is used to validate this parameter. The pattern can include uppercase
/// letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-
RoleName: RoleName
/// If set to ALLOW, the new account enables IAM users to access account
/// billing information if they have the required permissions. If set
/// to DENY, only the root user of the new account can access account billing
/// information. For more information, see About IAM
/// access to the Billing and Cost Management console in the
/// Amazon Web Services Billing and Cost Management User Guide.
/// If you don't specify this parameter, the value defaults to ALLOW, and
/// IAM users and roles with the required permissions can access billing information for
/// the new account.
IamUserAccessToBilling: IAMUserAccessToBilling
/// A list of tags that you want to attach to the newly created account. For each tag in
/// the list, you must specify both a tag key and a value. You can set the value to an empty
/// string, but you can't set it to null. For more information about tagging,
/// see Tagging Organizations
/// resources in the Organizations User Guide.
///
/// If any one of the tags is not valid or if you exceed the maximum allowed number of
/// tags for an account, then the entire request fails and the account is not
/// created.
///
Tags: Tags
}
@output
structure CreateAccountResponse {
/// A structure that contains details about the request to create an account. This
/// response structure might not be fully populated when you first receive it because
/// account creation is an asynchronous process. You can pass the returned
/// CreateAccountStatus ID as a parameter to DescribeCreateAccountStatus to get status about the progress of the
/// request at later times. You can also check the CloudTrail log for the
/// CreateAccountResult event. For more information, see Logging and monitoring in Organizations in the
/// Organizations User Guide.
CreateAccountStatus: CreateAccountStatus
}
/// Contains the status about a CreateAccount or CreateGovCloudAccount request to create an Amazon Web Services account or an Amazon Web Services
/// GovCloud (US) account in an organization.
structure CreateAccountStatus {
/// The unique identifier (ID) that references this request. You get this value from the
/// response of the initial CreateAccount request to create the
/// account.
/// The regex pattern for a create account request ID string
/// requires "car-" followed by from 8 to 32 lowercase letters or digits.
Id: CreateAccountRequestId
/// The account name given to the account when it was created.
AccountName: CreateAccountName
/// The status of the asynchronous request to create an Amazon Web Services account.
State: CreateAccountState
/// The date and time that the request was made for the account creation.
RequestedTimestamp: Timestamp
/// The date and time that the account was created and the request completed.
CompletedTimestamp: Timestamp
/// 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.
AccountId: AccountId
/// If the account was created successfully, the unique identifier (ID) of the new account
/// in the Amazon Web Services GovCloud (US) Region.
GovCloudAccountId: AccountId
/// If the request failed, a description of the reason for the failure.
///
/// -
///
ACCOUNT_LIMIT_EXCEEDED: The account couldn't be created because you reached
/// the limit on the number of accounts in your organization.
///
/// -
///
CONCURRENT_ACCOUNT_MODIFICATION: You already submitted a request with the same
/// information.
///
/// -
///
EMAIL_ALREADY_EXISTS: The account could not be created because another Amazon Web Services
/// account with that email address already exists.
///
/// -
///
FAILED_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization
/// failed to receive business license validation.
///
/// -
///
GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the Amazon Web Services GovCloud (US) Region
/// could not be created because this Region already includes an account with that
/// email address.
///
/// -
///
IDENTITY_INVALID_BUSINESS_VALIDATION: The Amazon Web Services account that owns your
/// organization can't complete business license validation because it doesn't have
/// valid identity data.
///
/// -
///
INVALID_ADDRESS: The account could not be created because the address you
/// provided is not valid.
///
/// -
///
INVALID_EMAIL: The account could not be created because the email address you
/// provided is not valid.
///
/// -
///
INVALID_PAYMENT_INSTRUMENT: The Amazon Web Services account that owns your organization does
/// not have a supported payment method associated with the account. Amazon Web Services does not
/// support cards issued by financial institutions in Russia or Belarus. For more
/// information, see Managing your
/// Amazon Web Services payments.
///
/// -
///
INTERNAL_FAILURE: The account could not be created because of an internal
/// failure. Try again later. If the problem persists, contact Amazon Web Services Customer
/// Support.
///
/// -
///
MISSING_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization has
/// not received Business Validation.
///
/// -
///
MISSING_PAYMENT_INSTRUMENT: You must configure the management account with a
/// valid payment method, such as a credit card.
///
/// -
///
PENDING_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization is
/// still in the process of completing business license validation.
///
/// -
///
UNKNOWN_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization has
/// an unknown issue with business license validation.
///
///
FailureReason: CreateAccountFailureReason
}
/// We can't find an create account request with the CreateAccountRequestId
/// that you specified.
@error("client")
@httpError(404)
structure CreateAccountStatusNotFoundException {
Message: ExceptionMessage
}
@input
structure CreateGovCloudAccountRequest {
/// Specifies the email address of the owner to assign to the new member account in the
/// commercial Region. This email address must not already be associated with another
/// Amazon Web Services account. You must use a valid email address to complete account creation.
/// The rules for a valid email address:
///
/// -
///
The address must be a minimum of 6 and a maximum of 64 characters long.
///
/// -
///
All characters must be 7-bit ASCII characters.
///
/// -
///
There must be one and only one @ symbol, which separates the local name from
/// the domain name.
///
/// -
///
The local name can't contain any of the following characters:
/// whitespace, " ' ( ) < > [ ] : ; , \ | % &
///
/// -
///
The local name can't begin with a dot (.)
///
/// -
///
The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen
/// (-), or dot (.)
///
/// -
///
The domain name can't begin or end with a hyphen (-) or dot (.)
///
/// -
///
The domain name must contain at least one dot
///
///
/// You can't access the root user of the account or remove an account that was created
/// with an invalid email address. Like all request parameters for
/// CreateGovCloudAccount, the request for the email address for the Amazon Web Services
/// GovCloud (US) account originates from the commercial Region, not from the Amazon Web Services GovCloud
/// (US) Region.
@required
Email: Email
/// The friendly name of the member account.
/// The account name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or
/// dot (.) You can't separate characters with a dash (–).
@required
AccountName: CreateAccountName
/// (Optional)
/// The name of an IAM role that Organizations automatically preconfigures in the new member
/// accounts in both the Amazon Web Services GovCloud (US) Region and in the commercial Region. This role
/// trusts the management account, allowing users in the management account to assume the
/// role, as permitted by the management account administrator. The role has administrator
/// permissions in the new member account.
/// If you don't specify this parameter, the role name defaults to
/// OrganizationAccountAccessRole.
/// For more information about how to use this role to access the member account, see the
/// following links:
///
/// -
///
/// Creating the OrganizationAccountAccessRole in an invited member
/// account in the Organizations User Guide
///
///
/// -
///
Steps 2 and 3 in IAM Tutorial:
/// Delegate access across Amazon Web Services accounts using IAM roles in the
/// IAM User Guide
///
///
///
/// The regex pattern that
/// is used to validate this parameter. The pattern can include uppercase
/// letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-
RoleName: RoleName
/// If set to ALLOW, the new linked account in the commercial Region enables
/// IAM users to access account billing information if they have the
/// required permissions. If set to DENY, only the root user of the new account
/// can access account billing information. For more information, see About IAM
/// access to the Billing and Cost Management console in the
/// Amazon Web Services Billing and Cost Management User Guide.
/// If you don't specify this parameter, the value defaults to ALLOW, and
/// IAM users and roles with the required permissions can access billing information for
/// the new account.
IamUserAccessToBilling: IAMUserAccessToBilling
/// A list of tags that you want to attach to the newly created account. These tags are
/// attached to the commercial account associated with the GovCloud account, and not to the
/// GovCloud account itself. To add tags to the actual GovCloud account, call the TagResource operation in the GovCloud region after the new GovCloud
/// account exists.
/// For each tag in the list, you must specify both a tag key and a value. You can set the
/// value to an empty string, but you can't set it to null. For more
/// information about tagging, see Tagging Organizations resources in the
/// Organizations User Guide.
///
/// If any one of the tags is not valid or if you exceed the maximum allowed number of
/// tags for an account, then the entire request fails and the account is not
/// created.
///
Tags: Tags
}
@output
structure CreateGovCloudAccountResponse {
CreateAccountStatus: CreateAccountStatus
}
@input
structure CreateOrganizationalUnitRequest {
/// The unique identifier (ID) of the parent root or OU that you want to create the new OU
/// in.
/// The regex pattern for a parent ID string requires one of the
/// following:
///
/// -
///
/// Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or
/// digits.
///
/// -
///
/// Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32
/// lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second
/// "-" dash and from 8 to 32 additional lowercase letters or digits.
///
///
@required
ParentId: ParentId
/// The friendly name to assign to the new OU.
@required
Name: OrganizationalUnitName
/// A list of tags that you want to attach to the newly created OU. For each tag in the
/// list, you must specify both a tag key and a value. You can set the value to an empty
/// string, but you can't set it to null. For more information about tagging,
/// see Tagging Organizations
/// resources in the Organizations User Guide.
///
/// If any one of the tags is not valid or if you exceed the allowed number of tags
/// for an OU, then the entire request fails and the OU is not created.
///
Tags: Tags
}
@output
structure CreateOrganizationalUnitResponse {
/// A structure that contains details about the newly created OU.
OrganizationalUnit: OrganizationalUnit
}
@input
structure CreateOrganizationRequest {
/// Specifies the feature set supported by the new organization. Each feature set supports
/// different levels of functionality.
///
/// -
///
/// CONSOLIDATED_BILLING: All member accounts have their bills
/// consolidated to and paid by the management account. For more information, see
/// Consolidated billing in the
/// Organizations User Guide.
/// The consolidated billing feature subset isn't available for organizations in
/// the Amazon Web Services GovCloud (US) Region.
///
/// -
///
/// ALL: In addition to all the features supported by the
/// consolidated billing feature set, the management account can also apply any
/// policy type to any member account in the organization. For more information, see
/// All
/// features in the Organizations User Guide.
///
///
FeatureSet: OrganizationFeatureSet
}
@output
structure CreateOrganizationResponse {
/// A structure that contains details about the newly created organization.
Organization: Organization
}
@input
structure CreatePolicyRequest {
/// The policy text content to add to the new policy. The text that you supply must adhere
/// to the rules of the policy type you specify in the Type parameter.
@required
Content: PolicyContent
/// An optional description to assign to the policy.
@required
Description: PolicyDescription
/// 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.
@required
Name: PolicyName
/// The type of policy to create. You can specify one of the following values:
///
/// -
///
/// AISERVICES_OPT_OUT_POLICY
///
///
/// -
///
/// BACKUP_POLICY
///
///
/// -
///
/// SERVICE_CONTROL_POLICY
///
///
/// -
///
/// TAG_POLICY
///
///
///
@required
Type: PolicyType
/// A list of tags that you want to attach to the newly created policy. For each tag in
/// the list, you must specify both a tag key and a value. You can set the value to an empty
/// string, but you can't set it to null. For more information about tagging,
/// see Tagging Organizations
/// resources in the Organizations User Guide.
///
/// If any one of the tags is not valid or if you exceed the allowed number of tags
/// for a policy, then the entire request fails and the policy is not created.
///
Tags: Tags
}
@output
structure CreatePolicyResponse {
/// A structure that contains details about the newly created policy.
Policy: Policy
}
@input
structure DeclineHandshakeRequest {
/// 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 lowercase letters or digits.
@required
HandshakeId: HandshakeId
}
@output
structure DeclineHandshakeResponse {
/// A structure that contains details about the declined handshake. The state is updated
/// to show the value DECLINED.
Handshake: Handshake
}
/// Contains information about the delegated administrator.
structure DelegatedAdministrator {
/// The unique identifier (ID) of the delegated administrator's account.
Id: AccountId
/// The Amazon Resource Name (ARN) of the delegated administrator's account.
Arn: AccountArn
/// The email address that is associated with the delegated administrator's Amazon Web Services
/// account.
Email: Email
/// The friendly name of the delegated administrator's account.
Name: AccountName
/// The status of the delegated administrator's account in the organization.
Status: AccountStatus
/// The method by which the delegated administrator's account joined the
/// organization.
JoinedMethod: AccountJoinedMethod
/// The date when the delegated administrator's account became a part of the
/// organization.
JoinedTimestamp: Timestamp
/// The date when the account was made a delegated administrator.
DelegationEnabledDate: Timestamp
}
/// Contains information about the Amazon Web Services service for which the account is a delegated
/// administrator.
structure DelegatedService {
/// The name of an Amazon Web Services service that can request an operation for the specified service.
/// This is typically in the form of a URL, such as:
///
/// servicename.amazonaws.com.
ServicePrincipal: ServicePrincipal
/// The date that the account became a delegated administrator for this service.
DelegationEnabledDate: Timestamp
}
@input
structure DeleteOrganizationalUnitRequest {
/// 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 lowercase letters or digits (the ID of the root that contains the
/// OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters
/// or digits.
@required
OrganizationalUnitId: OrganizationalUnitId
}
@input
structure DeletePolicyRequest {
/// 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 lowercase or uppercase letters, digits, or the underscore character (_).
@required
PolicyId: PolicyId
}
@input
structure DeregisterDelegatedAdministratorRequest {
/// The account ID number of the member account in the organization that you want to
/// deregister as a delegated administrator.
@required
AccountId: AccountId
/// The service principal name of an Amazon Web Services service for which the account is a delegated
/// administrator.
/// Delegated administrator privileges are revoked for only the specified Amazon Web Services service
/// from the member account. If the specified service is the only service for which the
/// member account is a delegated administrator, the operation also revokes Organizations read action
/// permissions.
@required
ServicePrincipal: ServicePrincipal
}
@input
structure DescribeAccountRequest {
/// The unique identifier (ID) of the Amazon Web Services account that you want information about. You
/// can get the ID from the ListAccounts or ListAccountsForParent operations.
/// The regex pattern for an account ID string requires exactly 12
/// digits.
@required
AccountId: AccountId
}
@output
structure DescribeAccountResponse {
/// A structure that contains information about the requested account.
Account: Account
}
@input
structure DescribeCreateAccountStatusRequest {
/// Specifies the Id value that uniquely identifies the
/// CreateAccount request. You can get the value from the
/// CreateAccountStatus.Id response in an earlier CreateAccount request, or from the ListCreateAccountStatus operation.
/// The regex pattern for a create account request ID string
/// requires "car-" followed by from 8 to 32 lowercase letters or digits.
@required
CreateAccountRequestId: CreateAccountRequestId
}
@output
structure DescribeCreateAccountStatusResponse {
/// A structure that contains the current status of an account creation request.
CreateAccountStatus: CreateAccountStatus
}
@input
structure DescribeEffectivePolicyRequest {
/// The type of policy that you want information about. You can specify one of the
/// following values:
///
/// -
///
/// AISERVICES_OPT_OUT_POLICY
///
///
/// -
///
/// BACKUP_POLICY
///
///
/// -
///
/// TAG_POLICY
///
///
///
@required
PolicyType: EffectivePolicyType
/// When you're signed in as the management account, specify the ID of the account that
/// you want details about. Specifying an organization root or organizational unit (OU) as
/// the target is not supported.
TargetId: PolicyTargetId
}
@output
structure DescribeEffectivePolicyResponse {
/// The contents of the effective policy.
EffectivePolicy: EffectivePolicy
}
@input
structure DescribeHandshakeRequest {
/// 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 lowercase letters or digits.
@required
HandshakeId: HandshakeId
}
@output
structure DescribeHandshakeResponse {
/// A structure that contains information about the specified handshake.
Handshake: Handshake
}
@input
structure DescribeOrganizationalUnitRequest {
/// 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 lowercase letters or digits (the ID of the root that contains the
/// OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters
/// or digits.
@required
OrganizationalUnitId: OrganizationalUnitId
}
@output
structure DescribeOrganizationalUnitResponse {
/// A structure that contains details about the specified OU.
OrganizationalUnit: OrganizationalUnit
}
@output
structure DescribeOrganizationResponse {
/// A structure that contains information about the organization.
///
/// The AvailablePolicyTypes part of the response is deprecated, and you
/// shouldn't use it in your apps. It doesn't include any policy type supported by Organizations
/// other than SCPs. To determine which policy types are enabled in your organization,
/// use the
/// ListRoots
/// operation.
///
Organization: Organization
}
@input
structure DescribePolicyRequest {
/// 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 lowercase or uppercase letters, digits, or the underscore character (_).
@required
PolicyId: PolicyId
}
@output
structure DescribePolicyResponse {
/// A structure that contains details about the specified policy.
Policy: Policy
}
@output
structure DescribeResourcePolicyResponse {
/// A structure that contains details about the resource policy.
ResourcePolicy: ResourcePolicy
}
/// We can't find the destination container (a root or OU) with the ParentId
/// that you specified.
@error("client")
@httpError(404)
structure DestinationParentNotFoundException {
Message: ExceptionMessage
}
@input
structure DetachPolicyRequest {
/// 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 lowercase or uppercase letters, digits, or the underscore character (_).
@required
PolicyId: PolicyId
/// The unique identifier (ID) of the root, OU, or account that you want to detach the
/// policy from. You can get the ID from the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts
/// operations.
/// The regex pattern for a target ID string requires one of the
/// following:
///
/// -
///
/// Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or
/// digits.
///
/// -
///
/// Account - A string that consists of exactly 12 digits.
///
/// -
///
/// Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32
/// lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second
/// "-" dash and from 8 to 32 additional lowercase letters or digits.
///
///
@required
TargetId: PolicyTargetId
}
@input
structure DisableAWSServiceAccessRequest {
/// The service principal name of the Amazon Web Services service for which you want to disable
/// integration with your organization. This is typically in the form of a URL, such as
///
/// service-abbreviation.amazonaws.com.
@required
ServicePrincipal: ServicePrincipal
}
@input
structure DisablePolicyTypeRequest {
/// 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 lowercase letters or digits.
@required
RootId: RootId
/// The policy type that you want to disable in this root. You can specify one of the
/// following values:
///
/// -
///
/// AISERVICES_OPT_OUT_POLICY
///
///
/// -
///
/// BACKUP_POLICY
///
///
/// -
///
/// SERVICE_CONTROL_POLICY
///
///
/// -
///
/// TAG_POLICY
///
///
///
@required
PolicyType: PolicyType
}
@output
structure DisablePolicyTypeResponse {
/// A structure that shows the root with the updated list of enabled policy types.
Root: Root
}
/// That account is already present in the specified destination.
@error("client")
@httpError(409)
structure DuplicateAccountException {
Message: ExceptionMessage
}
/// 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.
@error("client")
@httpError(409)
structure DuplicateHandshakeException {
Message: ExceptionMessage
}
/// An OU with the same name already exists.
@error("client")
@httpError(409)
structure DuplicateOrganizationalUnitException {
Message: ExceptionMessage
}
/// The selected policy is already attached to the specified target.
@error("client")
@httpError(409)
structure DuplicatePolicyAttachmentException {
Message: ExceptionMessage
}
/// A policy with the same name already exists.
@error("client")
@httpError(409)
structure DuplicatePolicyException {
Message: ExceptionMessage
}
/// Contains rules to be applied to the affected accounts. The effective policy is the
/// aggregation of any policies the account inherits, plus any policy directly attached to
/// the account.
structure EffectivePolicy {
/// The text content of the policy.
PolicyContent: PolicyContent
/// The time of the last update to this policy.
LastUpdatedTimestamp: Timestamp
/// The account ID of the policy target.
TargetId: PolicyTargetId
/// The policy type.
PolicyType: EffectivePolicyType
}
/// If you ran this action on the management account, this policy type is not enabled. If
/// you ran the action on a member account, the account doesn't have an effective policy of
/// this type. Contact the administrator of your organization about attaching a policy of
/// this type to the account.
@error("client")
structure EffectivePolicyNotFoundException {
Message: ExceptionMessage
}
@input
structure EnableAllFeaturesRequest {}
@output
structure EnableAllFeaturesResponse {
/// A structure that contains details about the handshake created to support this request
/// to enable all features in the organization.
Handshake: Handshake
}
@input
structure EnableAWSServiceAccessRequest {
/// The service principal name of the Amazon Web Services service for which you want to enable
/// integration with your organization. This is typically in the form of a URL, such as
///
/// service-abbreviation.amazonaws.com.
@required
ServicePrincipal: ServicePrincipal
}
/// A structure that contains details of a service principal that represents an Amazon Web Services
/// service that is enabled to integrate with Organizations.
structure EnabledServicePrincipal {
/// The name of the service principal. This is typically in the form of a URL, such as:
///
/// servicename.amazonaws.com.
ServicePrincipal: ServicePrincipal
/// The date that the service principal was enabled for integration with Organizations.
DateEnabled: Timestamp
}
@input
structure EnablePolicyTypeRequest {
/// 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 lowercase letters or digits.
@required
RootId: RootId
/// The policy type that you want to enable. You can specify one of the following
/// values:
///
/// -
///
/// AISERVICES_OPT_OUT_POLICY
///
///
/// -
///
/// BACKUP_POLICY
///
///
/// -
///
/// SERVICE_CONTROL_POLICY
///
///
/// -
///
/// TAG_POLICY
///
///
///
@required
PolicyType: PolicyType
}
@output
structure EnablePolicyTypeResponse {
/// A structure that shows the root with the updated list of enabled policy types.
Root: Root
}
/// Organizations couldn't perform the operation because your organization hasn't finished
/// initializing. This can take up to an hour. Try again later. If after one hour you
/// continue to receive this error, contact Amazon Web Services Support.
@error("client")
@httpError(409)
structure FinalizingOrganizationException {
Message: ExceptionMessage
}
/// Contains information that must be exchanged to securely establish a relationship
/// between two accounts (an originator and a
/// recipient). For example, when a management 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, DECLINED, or EXPIRED show up in
/// lists for only 30 days after entering that state After that they are deleted.
structure Handshake {
/// 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 lowercase letters or digits.
Id: HandshakeId
/// The Amazon Resource Name (ARN) of a handshake.
/// For more information about ARNs in Organizations, see ARN
/// Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
Arn: HandshakeArn
/// Information about the two accounts that are participating in the handshake.
Parties: HandshakeParties
/// 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).
///
///
State: HandshakeState
/// The date and time that the handshake request was made.
RequestedTimestamp: Timestamp
/// 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.
ExpirationTimestamp: Timestamp
/// 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 management 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 management account to only invited member
/// accounts. Created accounts do not receive this because those accounts were
/// created by the organization's management 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
/// management account and signals the master that it can finalize the process to
/// enable all features.
///
///
Action: ActionType
/// Additional information that is needed to process the handshake.
Resources: HandshakeResources
}
/// The specified handshake is already in the requested state. For example, you can't
/// accept a handshake that was already accepted.
@error("client")
@httpError(409)
structure HandshakeAlreadyInStateException {
Message: ExceptionMessage
}
/// The requested operation would violate the constraint identified in the reason
/// code.
///
/// Some of the reasons in the following list might not be applicable to this specific
/// API or operation:
///
///
/// -
///
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number
/// of accounts in an organization. Note that deleted and closed accounts still
/// count toward your limit.
///
/// If you get this exception immediately after creating the organization,
/// wait one hour and try again. If after an hour it continues to fail with this
/// error, contact Amazon Web Services
/// Support.
///
///
/// -
///
ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the
/// invited account is already a member of an organization.
///
/// -
///
HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of
/// handshakes that you can send in one day.
///
/// -
///
INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You can't issue new invitations to
/// join an organization while it's in the process of enabling all features. You can
/// resume inviting accounts after you finalize the process when all accounts have
/// agreed to the change.
///
/// -
///
ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid
/// because the organization has already enabled all features.
///
/// -
///
ORGANIZATION_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION: The handshake request
/// is invalid because the organization has already started the process to enable
/// all features.
///
/// -
///
ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the
/// account is from a different marketplace than the accounts in the organization.
/// For example, accounts with India addresses must be associated with the AISPL
/// marketplace. All accounts in an organization must be from the same
/// marketplace.
///
/// -
///
ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change
/// the membership of an account too quickly after its previous change.
///
/// -
///
PAYMENT_INSTRUMENT_REQUIRED: You can't complete the operation with an account
/// that doesn't have a payment instrument, such as a credit card, associated with
/// it.
///
///
@error("client")
@httpError(409)
structure HandshakeConstraintViolationException {
Message: ExceptionMessage
Reason: HandshakeConstraintViolationExceptionReason
}
/// Specifies the criteria that are used to select the handshakes for the
/// operation.
structure HandshakeFilter {
/// Specifies the type of handshake action.
/// If you specify ActionType, you cannot also specify
/// ParentHandshakeId.
ActionType: ActionType
/// 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 lowercase letters or digits.
ParentHandshakeId: HandshakeId
}
/// We can't find a handshake with the HandshakeId that you specified.
@error("client")
@httpError(404)
structure HandshakeNotFoundException {
Message: ExceptionMessage
}
/// Identifies a participant in a handshake.
structure HandshakeParty {
/// The unique identifier (ID) for the party.
/// The regex pattern for handshake ID string requires "h-"
/// followed by from 8 to 32 lowercase letters or digits.
@required
Id: HandshakePartyId
/// The type of party.
@required
Type: HandshakePartyType
}
/// Contains additional data that is needed to process a handshake.
structure HandshakeResource {
/// 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.
Value: HandshakeResourceValue
/// The type of information being passed, specifying how the value is to be interpreted by
/// the other party:
///
/// -
///
/// ACCOUNT - Specifies an Amazon Web Services 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
/// management account. Included as information about an organization.
///
/// -
///
/// OWNER_NAME - Specifies the name associated with the management
/// account. Included as information about an organization.
///
/// -
///
/// NOTES - Additional text provided by the handshake initiator and
/// intended for the recipient to read.
///
///
Type: HandshakeResourceType
/// When needed, contains an additional array of HandshakeResource
/// objects.
Resources: HandshakeResources
}
/// 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.
@error("client")
@httpError(409)
structure InvalidHandshakeTransitionException {
Message: ExceptionMessage
}
/// The requested operation failed because you provided invalid values for one or more of
/// the request parameters. This exception includes a reason that contains additional
/// information about the violated limit:
///
/// Some of the reasons in the following list might not be applicable to this specific
/// API or operation.
///
///
/// -
///
DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same
/// entity.
///
/// -
///
IMMUTABLE_POLICY: You specified a policy that is managed by Amazon Web Services and can't be
/// modified.
///
/// -
///
INPUT_REQUIRED: You must include a value for all required parameters.
///
/// -
///
INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the
/// invited account owner.
///
/// -
///
INVALID_ENUM: You specified an invalid value.
///
/// -
///
INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.
///
/// -
///
INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid
/// characters.
///
/// -
///
INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least
/// one invalid value.
///
/// -
///
INVALID_PAGINATION_TOKEN: Get the value for the NextToken
/// parameter from the response to a previous call of the operation.
///
/// -
///
INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account,
/// organization, or email) as a party.
///
/// -
///
INVALID_PATTERN: You provided a value that doesn't match the required
/// pattern.
///
/// -
///
INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match
/// the required pattern.
///
/// -
///
INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name
/// can't begin with the reserved prefix AWSServiceRoleFor.
///
/// -
///
INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name
/// (ARN) for the organization.
///
/// -
///
INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
///
/// -
///
INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag.
/// You can’t add, edit, or delete system tag keys because they're reserved for
/// Amazon Web Services use. System tags don’t count against your tags per resource limit.
///
/// -
///
MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the
/// operation.
///
/// -
///
MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than
/// allowed.
///
/// -
///
MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value
/// than allowed.
///
/// -
///
MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than
/// allowed.
///
/// -
///
MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value
/// than allowed.
///
/// -
///
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between
/// entities in the same root.
///
/// -
///
TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target
/// entity.
///
/// -
///
UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't
/// recognized.
///
///
@error("client")
@httpError(400)
structure InvalidInputException {
Message: ExceptionMessage
Reason: InvalidInputExceptionReason
}
@input
structure InviteAccountToOrganizationRequest {
/// The identifier (ID) of the Amazon Web Services account that you want to invite to join your
/// organization. This is a JSON object that contains the following elements:
///
/// { "Type": "ACCOUNT", "Id": "<
/// account id
/// number
/// >" }
///
/// If you use the CLI, you can submit this as a single string, similar to the following
/// example:
///
/// --target Id=123456789012,Type=ACCOUNT
///
/// If you specify "Type": "ACCOUNT", you must provide the Amazon Web Services account ID
/// number as the Id. If you specify "Type": "EMAIL", you must
/// specify the email address that is associated with the account.
///
/// --target [email protected],Type=EMAIL
///
@required
Target: HandshakeParty
/// Additional information that you want to include in the generated email to the
/// recipient account owner.
Notes: HandshakeNotes
/// A list of tags that you want to attach to the account when it becomes a member of the
/// organization. For each tag in the list, you must specify both a tag key and a value. You
/// can set the value to an empty string, but you can't set it to null. For
/// more information about tagging, see Tagging Organizations resources in the
/// Organizations User Guide.
///
/// Any tags in the request are checked for compliance with any applicable tag
/// policies when the request is made. The request is rejected if the tags in the
/// request don't match the requirements of the policy at that time. Tag policy
/// compliance is
/// not
/// checked
/// again when the invitation is accepted and the tags are actually attached to the
/// account. That means that if the tag policy changes between the invitation and the
/// acceptance, then that tags could potentially be non-compliant.
///
///
/// If any one of the tags is not valid or if you exceed the allowed number of tags
/// for an account, then the entire request fails and invitations are not sent.
///
Tags: Tags
}
@output
structure InviteAccountToOrganizationResponse {
/// A structure that contains details about the handshake that is created to support this
/// invitation request.
Handshake: Handshake
}
@input
structure ListAccountsForParentRequest {
/// The unique identifier (ID) for the parent root or organization unit (OU) whose
/// accounts you want to list.
@required
ParentId: ParentId
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListAccountsForParentResponse {
/// A list of the accounts in the specified root or OU.
Accounts: Accounts
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListAccountsRequest {
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListAccountsResponse {
/// A list of objects in the organization.
Accounts: Accounts
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListAWSServiceAccessForOrganizationRequest {
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListAWSServiceAccessForOrganizationResponse {
/// A list of the service principals for the services that are enabled to integrate with
/// your organization. Each principal is a structure that includes the name and the date
/// that it was enabled for integration with Organizations.
EnabledServicePrincipals: EnabledServicePrincipals
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListChildrenRequest {
/// The unique identifier (ID) for the parent root or OU whose children you want to
/// list.
/// The regex pattern for a parent ID string requires one of the
/// following:
///
/// -
///
/// Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or
/// digits.
///
/// -
///
/// Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32
/// lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second
/// "-" dash and from 8 to 32 additional lowercase letters or digits.
///
///
@required
ParentId: ParentId
/// Filters the output to include only the specified child type.
@required
ChildType: ChildType
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListChildrenResponse {
/// The list of children of the specified parent container.
Children: Children
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListCreateAccountStatusRequest {
/// A list of one or more states that you want included in the response. If this parameter
/// isn't present, all requests are included in the response.
States: CreateAccountStates
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListCreateAccountStatusResponse {
/// 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.
CreateAccountStatuses: CreateAccountStatuses
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListDelegatedAdministratorsRequest {
/// Specifies a service principal name. If specified, then the operation lists the
/// delegated administrators only for the specified service.
/// If you don't specify a service principal, the operation lists all delegated
/// administrators for all services in your organization.
ServicePrincipal: ServicePrincipal
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListDelegatedAdministratorsResponse {
/// The list of delegated administrators in your organization.
DelegatedAdministrators: DelegatedAdministrators
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListDelegatedServicesForAccountRequest {
/// The account ID number of a delegated administrator account in the organization.
@required
AccountId: AccountId
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListDelegatedServicesForAccountResponse {
/// The services for which the account is a delegated administrator.
DelegatedServices: DelegatedServices
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListHandshakesForAccountRequest {
/// 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_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 ParentHandshakeId to see only the
/// handshakes that were generated by that parent request.
Filter: HandshakeFilter
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListHandshakesForAccountResponse {
/// A list of Handshake objects with details about each of the
/// handshakes that is associated with the specified account.
Handshakes: Handshakes
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListHandshakesForOrganizationRequest {
/// 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.
Filter: HandshakeFilter
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListHandshakesForOrganizationResponse {
/// A list of Handshake objects with details about each of the
/// handshakes that are associated with an organization.
Handshakes: Handshakes
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListOrganizationalUnitsForParentRequest {
/// 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 lowercase letters or
/// digits.
///
/// -
///
/// Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32
/// lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second
/// "-" dash and from 8 to 32 additional lowercase letters or digits.
///
///
@required
ParentId: ParentId
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListOrganizationalUnitsForParentResponse {
/// A list of the OUs in the specified root or parent OU.
OrganizationalUnits: OrganizationalUnits
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListParentsRequest {
/// The unique identifier (ID) of the OU or account whose parent containers you want to
/// list. Don't specify a root.
/// The regex pattern for a child ID string requires one of the
/// following:
///
/// -
///
/// Account - A string that consists of exactly 12 digits.
///
/// -
///
/// Organizational unit (OU) - A string that begins with
/// "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that
/// contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional
/// lowercase letters or digits.
///
///
@required
ChildId: ChildId
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListParentsResponse {
/// A list of parents for the specified child account or OU.
Parents: Parents
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListPoliciesForTargetRequest {
/// 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 lowercase letters or
/// digits.
///
/// -
///
/// Account - A string that consists of exactly 12 digits.
///
/// -
///
/// Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32
/// lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second
/// "-" dash and from 8 to 32 additional lowercase letters or digits.
///
///
@required
TargetId: PolicyTargetId
/// The type of policy that you want to include in the returned list. You must specify one
/// of the following values:
///
/// -
///
/// AISERVICES_OPT_OUT_POLICY
///
///
/// -
///
/// BACKUP_POLICY
///
///
/// -
///
/// SERVICE_CONTROL_POLICY
///
///
/// -
///
/// TAG_POLICY
///
///
///
@required
Filter: PolicyType
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListPoliciesForTargetResponse {
/// The list of policies that match the criteria in the request.
Policies: Policies
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListPoliciesRequest {
/// Specifies the type of policy that you want to include in the response. You must
/// specify one of the following values:
///
/// -
///
/// AISERVICES_OPT_OUT_POLICY
///
///
/// -
///
/// BACKUP_POLICY
///
///
/// -
///
/// SERVICE_CONTROL_POLICY
///
///
/// -
///
/// TAG_POLICY
///
///
///
@required
Filter: PolicyType
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListPoliciesResponse {
/// A list of policies that match the filter criteria in the request. The output list
/// doesn't include the policy contents. To see the content for a policy, see DescribePolicy.
Policies: Policies
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListRootsRequest {
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListRootsResponse {
/// A list of roots that are defined in an organization.
Roots: Roots
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListTagsForResourceRequest {
/// The ID of the resource with the tags to list.
/// You can specify any of the following taggable resources.
///
/// -
///
Amazon Web Services account – specify the account ID number.
///
/// -
///
Organizational unit – specify the OU ID that begins with ou- and
/// looks similar to: ou-1a2b-34uvwxyz
///
///
///
/// -
///
Root – specify the root ID that begins with r- and looks similar
/// to: r-1a2b
///
///
///
/// -
///
Policy – specify the policy ID that begins with p- andlooks
/// similar to: p-12abcdefg3
///
///
///
///
@required
ResourceId: TaggableResourceId
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
}
@output
structure ListTagsForResourceResponse {
/// The tags that are assigned to the resource.
Tags: Tags
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
@input
structure ListTargetsForPolicyRequest {
/// The unique identifier (ID) of the policy whose attachments you want to know.
/// The regex pattern for a policy ID string requires "p-" followed
/// by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
@required
PolicyId: PolicyId
/// The parameter for receiving additional results if you receive a
/// NextToken response in a previous request. A NextToken response
/// indicates that more output is available. Set this parameter to the value of the previous
/// call's NextToken response to indicate where the output should continue
/// from.
NextToken: NextToken
/// The total number of results that you want included on each page of 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.
MaxResults: MaxResults
}
@output
structure ListTargetsForPolicyResponse {
/// A list of structures, each of which contains details about one of the entities to
/// which the specified policy is attached.
Targets: PolicyTargets
/// If present, indicates that more output is available than is
/// included in the current response. Use this value in the NextToken request parameter
/// in a subsequent call to the operation to get the next part of the output. You should repeat this
/// until the NextToken response element comes back as null.
NextToken: NextToken
}
/// The provided policy document doesn't meet the requirements of the specified policy
/// type. For example, the syntax might be incorrect. For details about service control
/// policy syntax, see SCP syntax in the
/// Organizations User Guide.
@error("client")
@httpError(400)
structure MalformedPolicyDocumentException {
Message: ExceptionMessage
}
/// You can't remove a management account from an organization. If you want the management
/// account to become a member account in another organization, you must first delete the
/// current organization of the management account.
@error("client")
@httpError(409)
structure MasterCannotLeaveOrganizationException {
Message: ExceptionMessage
}
@input
structure MoveAccountRequest {
/// The unique identifier (ID) of the account that you want to move.
/// The regex pattern for an account ID string requires exactly 12
/// digits.
@required
AccountId: AccountId
/// 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 lowercase letters or
/// digits.
///
/// -
///
/// Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32
/// lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second
/// "-" dash and from 8 to 32 additional lowercase letters or digits.
///
///
@required
SourceParentId: ParentId
/// 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 lowercase letters or
/// digits.
///
/// -
///
/// Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32
/// lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second
/// "-" dash and from 8 to 32 additional lowercase letters or digits.
///
///
@required
DestinationParentId: ParentId
}
/// 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 .
structure Organization {
/// The unique identifier (ID) of an organization.
/// The regex pattern for an organization ID string requires "o-"
/// followed by from 10 to 32 lowercase letters or digits.
Id: OrganizationId
/// The Amazon Resource Name (ARN) of an organization.
/// For more information about ARNs in Organizations, see ARN
/// Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
Arn: OrganizationArn
/// Specifies the functionality that currently is available to the organization. If set to
/// "ALL", then all features are enabled and policies can be applied to accounts in the
/// organization. If set to "CONSOLIDATED_BILLING", then only consolidated billing
/// functionality is available. For more information, see Enabling all features
/// in your organization in the Organizations User Guide.
FeatureSet: OrganizationFeatureSet
/// The Amazon Resource Name (ARN) of the account that is designated as the management
/// account for the organization.
/// For more information about ARNs in Organizations, see ARN
/// Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
MasterAccountArn: AccountArn
/// The unique identifier (ID) of the management account of an organization.
/// The regex pattern for an account ID string requires exactly 12
/// digits.
MasterAccountId: AccountId
/// The email address that is associated with the Amazon Web Services account that is designated as the
/// management account for the organization.
MasterAccountEmail: Email
///
/// Do not use. This field is deprecated and doesn't provide complete information
/// about the policies in your organization.
///
/// To determine the policies that are enabled and available for use in your organization,
/// use the ListRoots operation instead.
AvailablePolicyTypes: PolicyTypes
}
/// Contains details about an organizational unit (OU). An OU is a container of Amazon Web Services
/// accounts within a root of an organization. Policies that are attached to an OU apply to
/// all accounts contained in that OU and in any child OUs.
structure OrganizationalUnit {
/// 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 lowercase letters or digits (the ID of the root that contains the
/// OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters
/// or digits.
Id: OrganizationalUnitId
/// The Amazon Resource Name (ARN) of this OU.
/// For more information about ARNs in Organizations, see ARN
/// Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
Arn: OrganizationalUnitArn
/// 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.
Name: OrganizationalUnitName
}
/// 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.
@error("client")
@httpError(409)
structure OrganizationalUnitNotEmptyException {
Message: ExceptionMessage
}
/// We can't find an OU with the OrganizationalUnitId that you
/// specified.
@error("client")
@httpError(404)
structure OrganizationalUnitNotFoundException {
Message: ExceptionMessage
}
/// The organization isn't empty. To delete an organization, you must first remove all
/// accounts except the management account.
@error("client")
@httpError(409)
structure OrganizationNotEmptyException {
Message: ExceptionMessage
}
/// Contains information about either a root or an organizational unit (OU) that can
/// contain OUs or accounts in an organization.
structure Parent {
/// The unique identifier (ID) of the parent entity.
/// The regex pattern for a parent ID string requires one of the
/// following:
///
/// -
///
/// Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or
/// digits.
///
/// -
///
/// Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32
/// lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second
/// "-" dash and from 8 to 32 additional lowercase letters or digits.
///
///
Id: ParentId
/// The type of the parent entity.
Type: ParentType
}
/// We can't find a root or OU with the ParentId that you specified.
@error("client")
@httpError(404)
structure ParentNotFoundException {
Message: ExceptionMessage
}
/// 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.
structure Policy {
/// A structure that contains additional details about the policy.
PolicySummary: PolicySummary
/// The text content of the policy.
Content: PolicyContent
}
/// Changes to the effective policy are in progress, and its contents can't be returned.
/// Try the operation again later.
@error("client")
structure PolicyChangesInProgressException {
Message: ExceptionMessage
}
/// The policy is attached to one or more entities. You must detach it from all roots,
/// OUs, and accounts before performing this operation.
@error("client")
@httpError(409)
structure PolicyInUseException {
Message: ExceptionMessage
}
/// The policy isn't attached to the specified target in the specified root.
@error("client")
@httpError(409)
structure PolicyNotAttachedException {
Message: ExceptionMessage
}
/// We can't find a policy with the PolicyId that you specified.
@error("client")
@httpError(404)
structure PolicyNotFoundException {
Message: ExceptionMessage
}
/// Contains information about a policy, but does not include the content. To see the
/// content of a policy, see DescribePolicy.
structure PolicySummary {
/// The unique identifier (ID) of the policy.
/// The regex pattern for a policy ID string requires "p-" followed
/// by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
Id: PolicyId
/// The Amazon Resource Name (ARN) of the policy.
/// For more information about ARNs in Organizations, see ARN
/// Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
Arn: PolicyArn
/// 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.
Name: PolicyName
/// The description of the policy.
Description: PolicyDescription
/// The type of policy.
Type: PolicyType
/// A boolean value that indicates whether the specified policy is an Amazon Web Services managed
/// policy. If true, then you can attach the policy to roots, OUs, or accounts, but you
/// cannot edit it.
AwsManaged: AwsManagedPolicy = false
}
/// Contains information about a root, OU, or account that a policy is attached to.
structure PolicyTargetSummary {
/// The unique identifier (ID) of the policy target.
/// The regex pattern for a target ID string requires one of the
/// following:
///
/// -
///
/// Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or
/// digits.
///
/// -
///
/// Account - A string that consists of exactly 12 digits.
///
/// -
///
/// Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32
/// lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second
/// "-" dash and from 8 to 32 additional lowercase letters or digits.
///
///
TargetId: PolicyTargetId
/// The Amazon Resource Name (ARN) of the policy target.
/// For more information about ARNs in Organizations, see ARN
/// Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
Arn: GenericArn
/// 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.
Name: TargetName
/// The type of the policy target.
Type: TargetType
}
/// The specified policy type is already enabled in the specified root.
@error("client")
@httpError(409)
structure PolicyTypeAlreadyEnabledException {
Message: ExceptionMessage
}
/// You can't use the specified policy type with the feature set currently enabled for
/// this organization. For example, you can enable SCPs only after you enable all features
/// in the organization. For more information, see Managing
/// Organizations policiesin the Organizations User Guide.
@error("client")
@httpError(409)
structure PolicyTypeNotAvailableForOrganizationException {
Message: ExceptionMessage
}
/// The specified policy type isn't currently enabled in this root. You can't attach
/// policies of the specified type to entities in a root until you enable that type in the
/// root. For more information, see Enabling all features
/// in your organization in the Organizations User Guide.
@error("client")
@httpError(409)
structure PolicyTypeNotEnabledException {
Message: ExceptionMessage
}
/// Contains information about a policy type and its status in the associated root.
structure PolicyTypeSummary {
/// The name of the policy type.
Type: PolicyType
/// 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.
Status: PolicyTypeStatus
}
@input
structure PutResourcePolicyRequest {
/// If provided, the new content for the resource policy. The text must be correctly
/// formatted JSON that complies with the syntax for the resource policy's type. For more
/// information, see SCP syntax in the
/// Organizations User Guide.
@required
Content: ResourcePolicyContent
/// A list of tags that you want to attach to the newly created resource policy. For each
/// tag in the list, you must specify both a tag key and a value. You can set the value to
/// an empty string, but you can't set it to null. For more information about
/// tagging, see Tagging
/// Organizations resources in the Organizations User Guide.
///
/// Calls with tags apply to the initial creation of the resource policy, otherwise an
/// exception is thrown. If any one of the tags is not valid or if you exceed the
/// allowed number of tags for the resource policy, then the entire request fails and
/// the resource policy is not created.
///
Tags: Tags
}
@output
structure PutResourcePolicyResponse {
/// A structure that contains details about the resource policy.
ResourcePolicy: ResourcePolicy
}
@input
structure RegisterDelegatedAdministratorRequest {
/// The account ID number of the member account in the organization to register as a
/// delegated administrator.
@required
AccountId: AccountId
/// The service principal of the Amazon Web Services service for which you want to make the member
/// account a delegated administrator.
@required
ServicePrincipal: ServicePrincipal
}
@input
structure RemoveAccountFromOrganizationRequest {
/// 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.
@required
AccountId: AccountId
}
/// A structure that contains details about a resource policy.
structure ResourcePolicy {
/// A structure that contains resource policy ID and Amazon Resource Name (ARN).
ResourcePolicySummary: ResourcePolicySummary
/// The policy text of the resource policy.
Content: ResourcePolicyContent
}
/// We can't find a resource policy request with the parameter that you specified.
@error("client")
@httpError(404)
structure ResourcePolicyNotFoundException {
Message: ExceptionMessage
}
/// A structure that contains resource policy ID and Amazon Resource Name (ARN).
structure ResourcePolicySummary {
/// The unique identifier (ID) of the resource policy.
Id: ResourcePolicyId
/// The Amazon Resource Name (ARN) of the resource policy.
Arn: ResourcePolicyArn
}
/// Contains details about a root. A root is a top-level parent node in the hierarchy of
/// an organization that can contain organizational units (OUs) and accounts.
/// The root contains every Amazon Web Services account in the
/// organization.
structure Root {
/// The unique identifier (ID) for the root.
/// The regex pattern for a root ID string requires "r-" followed by
/// from 4 to 32 lowercase letters or digits.
Id: RootId
/// The Amazon Resource Name (ARN) of the root.
/// For more information about ARNs in Organizations, see ARN
/// Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
Arn: RootArn
/// 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.
Name: RootName
/// 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.
///
PolicyTypes: PolicyTypes
}
/// We can't find a root with the RootId that you specified.
@error("client")
@httpError(404)
structure RootNotFoundException {
Message: ExceptionMessage
}
/// Organizations can't complete your request because of an internal service error. Try again
/// later.
@error("server")
@httpError(500)
structure ServiceException {
Message: ExceptionMessage
}
/// We can't find a source root or OU with the ParentId that you
/// specified.
@error("client")
@httpError(404)
structure SourceParentNotFoundException {
Message: ExceptionMessage
}
/// A custom key-value pair associated with a resource within your organization.
/// You can attach tags to any of the following organization resources.
///
/// -
///
Amazon Web Services account
///
/// -
///
Organizational unit (OU)
///
/// -
///
Organization root
///
/// -
///
Policy
///
///
structure Tag {
/// The key identifier, or name, of the tag.
@required
Key: TagKey
/// The string value that's associated with the key of the tag. You can set the value of a
/// tag to an empty string, but you can't set the value of a tag to null.
@required
Value: TagValue
}
@input
structure TagResourceRequest {
/// The ID of the resource to add a tag to.
/// You can specify any of the following taggable resources.
///
/// -
///
Amazon Web Services account – specify the account ID number.
///
/// -
///
Organizational unit – specify the OU ID that begins with ou- and
/// looks similar to: ou-1a2b-34uvwxyz
///
///
///
/// -
///
Root – specify the root ID that begins with r- and looks similar
/// to: r-1a2b
///
///
///
/// -
///
Policy – specify the policy ID that begins with p- andlooks
/// similar to: p-12abcdefg3
///
///
///
///
@required
ResourceId: TaggableResourceId
/// A list of tags to add to the specified resource.
/// For each tag in the list, you must specify both a tag key and a value. The value can
/// be an empty string, but you can't set it to null.
///
/// If any one of the tags is not valid or if you exceed the maximum allowed number of
/// tags for a resource, then the entire request fails.
///
@required
Tags: Tags
}
/// We can't find a root, OU, account, or policy with the TargetId that you
/// specified.
@error("client")
@httpError(404)
structure TargetNotFoundException {
Message: ExceptionMessage
}
/// You have sent too many requests in too short a period of time. The quota helps protect
/// against denial-of-service attacks. Try again later.
/// For information about quotas that affect Organizations, see Quotas for Organizations in the
/// Organizations User Guide.
@error("client")
@httpError(429)
structure TooManyRequestsException {
Type: ExceptionType
Message: ExceptionMessage
}
/// This action isn't available in the current Amazon Web Services Region.
@error("client")
@httpError(403)
structure UnsupportedAPIEndpointException {
Message: ExceptionMessage
}
@input
structure UntagResourceRequest {
/// The ID of the resource to remove a tag from.
/// You can specify any of the following taggable resources.
///
/// -
///
Amazon Web Services account – specify the account ID number.
///
/// -
///
Organizational unit – specify the OU ID that begins with ou- and
/// looks similar to: ou-1a2b-34uvwxyz
///
///
///
/// -
///
Root – specify the root ID that begins with r- and looks similar
/// to: r-1a2b
///
///
///
/// -
///
Policy – specify the policy ID that begins with p- andlooks
/// similar to: p-12abcdefg3
///
///
///
///
@required
ResourceId: TaggableResourceId
/// The list of keys for tags to remove from the specified resource.
@required
TagKeys: TagKeys
}
@input
structure UpdateOrganizationalUnitRequest {
/// 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 lowercase letters or digits (the ID of the root that contains the
/// OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters
/// or digits.
@required
OrganizationalUnitId: OrganizationalUnitId
/// 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.
Name: OrganizationalUnitName
}
@output
structure UpdateOrganizationalUnitResponse {
/// A structure that contains the details about the specified OU, including its new
/// name.
OrganizationalUnit: OrganizationalUnit
}
@input
structure UpdatePolicyRequest {
/// 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 lowercase or uppercase letters, digits, or the underscore character (_).
@required
PolicyId: PolicyId
/// 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.
Name: PolicyName
/// If provided, the new description for the policy.
Description: PolicyDescription
/// If provided, the new content for the policy. The text must be correctly formatted JSON
/// that complies with the syntax for the policy's type. For more information, see SCP
/// syntax in the Organizations User Guide.
Content: PolicyContent
}
@output
structure UpdatePolicyResponse {
/// A structure that contains details about the updated policy, showing the requested
/// changes.
Policy: Policy
}
list Accounts {
member: Account
}
list Children {
member: Child
}
list CreateAccountStates {
member: CreateAccountState
}
list CreateAccountStatuses {
member: CreateAccountStatus
}
list DelegatedAdministrators {
member: DelegatedAdministrator
}
list DelegatedServices {
member: DelegatedService
}
list EnabledServicePrincipals {
member: EnabledServicePrincipal
}
list HandshakeParties {
member: HandshakeParty
}
list HandshakeResources {
member: HandshakeResource
}
list Handshakes {
member: Handshake
}
list OrganizationalUnits {
member: OrganizationalUnit
}
list Parents {
member: Parent
}
list Policies {
member: PolicySummary
}
list PolicyTargets {
member: PolicyTargetSummary
}
list PolicyTypes {
member: PolicyTypeSummary
}
list Roots {
member: Root
}
list TagKeys {
member: TagKey
}
list Tags {
member: Tag
}
enum AccessDeniedForDependencyExceptionReason {
ACCESS_DENIED_DURING_CREATE_SERVICE_LINKED_ROLE
}
@pattern("^arn:aws:organizations::\\d{12}:account\\/o-[a-z0-9]{10,32}\\/\\d{12}$")
string AccountArn
@length(
min: 0
max: 12
)
@pattern("^\\d{12}$")
string AccountId
enum AccountJoinedMethod {
INVITED
CREATED
}
@length(
min: 1
max: 128
)
@pattern("^[\\s\\S]*$")
@sensitive
string AccountName
enum AccountStatus {
ACTIVE
SUSPENDED
PENDING_CLOSURE
}
enum ActionType {
INVITE_ACCOUNT_TO_ORGANIZATION = "INVITE"
ENABLE_ALL_FEATURES
APPROVE_ALL_FEATURES
ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE
}
@default(false)
boolean AwsManagedPolicy
@length(
min: 0
max: 100
)
@pattern("^(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$")
string ChildId
enum ChildType {
ACCOUNT
ORGANIZATIONAL_UNIT
}
enum ConstraintViolationExceptionReason {
ACCOUNT_NUMBER_LIMIT_EXCEEDED
HANDSHAKE_RATE_LIMIT_EXCEEDED
OU_NUMBER_LIMIT_EXCEEDED
OU_DEPTH_LIMIT_EXCEEDED
POLICY_NUMBER_LIMIT_EXCEEDED
POLICY_CONTENT_LIMIT_EXCEEDED
MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED
MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED
ACCOUNT_CANNOT_LEAVE_ORGANIZATION
ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA
ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION
MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED
MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED
ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED
MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE
MASTER_ACCOUNT_MISSING_CONTACT_INFO
MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED
ORGANIZATION_NOT_IN_ALL_FEATURES_MODE
CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION
EMAIL_VERIFICATION_CODE_EXPIRED
WAIT_PERIOD_ACTIVE
MAX_TAG_LIMIT_EXCEEDED
TAG_POLICY_VIOLATION
MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED
CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR
CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG
DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE
MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE
CANNOT_CLOSE_MANAGEMENT_ACCOUNT
CLOSE_ACCOUNT_QUOTA_EXCEEDED
CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED
SERVICE_ACCESS_NOT_ENABLED
INVALID_PAYMENT_INSTRUMENT
ACCOUNT_CREATION_NOT_COMPLETE
}
enum CreateAccountFailureReason {
ACCOUNT_LIMIT_EXCEEDED
EMAIL_ALREADY_EXISTS
INVALID_ADDRESS
INVALID_EMAIL
CONCURRENT_ACCOUNT_MODIFICATION
INTERNAL_FAILURE
GOVCLOUD_ACCOUNT_ALREADY_EXISTS
MISSING_BUSINESS_VALIDATION
FAILED_BUSINESS_VALIDATION
PENDING_BUSINESS_VALIDATIONv = "PENDING_BUSINESS_VALIDATION"
INVALID_IDENTITY_FOR_BUSINESS_VALIDATION
UNKNOWN_BUSINESS_VALIDATION
MISSING_PAYMENT_INSTRUMENT
INVALID_PAYMENT_INSTRUMENT
UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED
}
@length(
min: 1
max: 50
)
@pattern("^[\\u0020-\\u007E]+$")
@sensitive
string CreateAccountName
@length(
min: 0
max: 36
)
@pattern("^car-[a-z0-9]{8,32}$")
string CreateAccountRequestId
enum CreateAccountState {
IN_PROGRESS
SUCCEEDED
FAILED
}
enum EffectivePolicyType {
TAG_POLICY
BACKUP_POLICY
AISERVICES_OPT_OUT_POLICY
}
@length(
min: 6
max: 64
)
@pattern("^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$")
@sensitive
string Email
string ExceptionMessage
string ExceptionType
@pattern("^arn:aws:organizations::.+:.+$")
string GenericArn
@pattern("^arn:aws:organizations::\\d{12}:handshake\\/o-[a-z0-9]{10,32}\\/[a-z_]{1,32}\\/h-[0-9a-z]{8,32}$")
string HandshakeArn
enum HandshakeConstraintViolationExceptionReason {
ACCOUNT_NUMBER_LIMIT_EXCEEDED
HANDSHAKE_RATE_LIMIT_EXCEEDED
ALREADY_IN_AN_ORGANIZATION
ORGANIZATION_ALREADY_HAS_ALL_FEATURES
ORGANIZATION_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION
INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES
PAYMENT_INSTRUMENT_REQUIRED
ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD
ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED
MANAGEMENT_ACCOUNT_EMAIL_NOT_VERIFIED
}
@length(
min: 0
max: 34
)
@pattern("^h-[0-9a-z]{8,32}$")
string HandshakeId
@length(
min: 0
max: 1024
)
@pattern("^[\\s\\S]*$")
@sensitive
string HandshakeNotes
@length(
min: 1
max: 64
)
@pattern("^[\\s\\S]*$")
@sensitive
string HandshakePartyId
enum HandshakePartyType {
ACCOUNT
ORGANIZATION
EMAIL
}
enum HandshakeResourceType {
ACCOUNT
ORGANIZATION
ORGANIZATION_FEATURE_SET
EMAIL
MASTER_EMAIL
MASTER_NAME
NOTES
PARENT_HANDSHAKE
}
@sensitive
string HandshakeResourceValue
enum HandshakeState {
REQUESTED
OPEN
CANCELED
ACCEPTED
DECLINED
EXPIRED
}
enum IAMUserAccessToBilling {
ALLOW
DENY
}
enum InvalidInputExceptionReason {
INVALID_PARTY_TYPE_TARGET
INVALID_SYNTAX_ORGANIZATION = "INVALID_SYNTAX_ORGANIZATION_ARN"
INVALID_SYNTAX_POLICY = "INVALID_SYNTAX_POLICY_ID"
INVALID_ENUM
INVALID_ENUM_POLICY_TYPE
INVALID_LIST_MEMBER
MAX_LENGTH_EXCEEDED
MAX_VALUE_EXCEEDED
MIN_LENGTH_EXCEEDED
MIN_VALUE_EXCEEDED
IMMUTABLE_POLICY
INVALID_PATTERN
INVALID_PATTERN_TARGET_ID
INPUT_REQUIRED
INVALID_PAGINATION_TOKEN = "INVALID_NEXT_TOKEN"
MAX_FILTER_LIMIT_EXCEEDED = "MAX_LIMIT_EXCEEDED_FILTER"
MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS
INVALID_FULL_NAME_TARGET
UNRECOGNIZED_SERVICE_PRINCIPAL
INVALID_ROLE_NAME
INVALID_SYSTEM_TAGS_PARAMETER
DUPLICATE_TAG_KEY
TARGET_NOT_SUPPORTED
INVALID_EMAIL_ADDRESS_TARGET
INVALID_RESOURCE_POLICY_JSON
UNSUPPORTED_ACTION_IN_RESOURCE_POLICY
UNSUPPORTED_POLICY_TYPE_IN_RESOURCE_POLICY
UNSUPPORTED_RESOURCE_IN_RESOURCE_POLICY
}
@range(
min: 1
max: 20
)
integer MaxResults
@length(
min: 0
max: 100000
)
@pattern("^[\\s\\S]*$")
string NextToken
@pattern("^arn:aws:organizations::\\d{12}:ou\\/o-[a-z0-9]{10,32}\\/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}$")
string OrganizationalUnitArn
@length(
min: 0
max: 68
)
@pattern("^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$")
string OrganizationalUnitId
@length(
min: 1
max: 128
)
@pattern("^[\\s\\S]*$")
string OrganizationalUnitName
@pattern("^arn:aws:organizations::\\d{12}:organization\\/o-[a-z0-9]{10,32}$")
string OrganizationArn
enum OrganizationFeatureSet {
ALL
CONSOLIDATED_BILLING
}
@pattern("^o-[a-z0-9]{10,32}$")
string OrganizationId
@length(
min: 0
max: 100
)
@pattern("^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$")
string ParentId
enum ParentType {
ROOT
ORGANIZATIONAL_UNIT
}
@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})$")
string PolicyArn
@length(
min: 1
max: 1000000
)
@pattern("^[\\s\\S]*$")
string PolicyContent
@length(
min: 0
max: 512
)
@pattern("^[\\s\\S]*$")
string PolicyDescription
@length(
min: 0
max: 130
)
@pattern("^p-[0-9a-zA-Z_]{8,128}$")
string PolicyId
@length(
min: 1
max: 128
)
@pattern("^[\\s\\S]*$")
string PolicyName
@length(
min: 0
max: 100
)
@pattern("^(r-[0-9a-z]{4,32})|(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$")
string PolicyTargetId
enum PolicyType {
SERVICE_CONTROL_POLICY
TAG_POLICY
BACKUP_POLICY
AISERVICES_OPT_OUT_POLICY
}
enum PolicyTypeStatus {
ENABLED
PENDING_ENABLE
PENDING_DISABLE
}
@pattern("^arn:[a-z0-9][a-z0-9-.]{0,62}:organizations::\\d{12}:resourcepolicy\\/o-[a-z0-9]{10,32}\\/rp-[0-9a-zA-Z_]{4,128}$")
string ResourcePolicyArn
@length(
min: 1
max: 40000
)
@pattern("^[\\s\\S]*$")
string ResourcePolicyContent
@length(
min: 0
max: 131
)
@pattern("^rp-[0-9a-zA-Z_]{4,128}$")
string ResourcePolicyId
@length(
min: 0
max: 64
)
@pattern("^[\\w+=,.@-]{1,64}$")
string RoleName
@pattern("^arn:aws:organizations::\\d{12}:root\\/o-[a-z0-9]{10,32}\\/r-[0-9a-z]{4,32}$")
string RootArn
@length(
min: 0
max: 34
)
@pattern("^r-[0-9a-z]{4,32}$")
string RootId
@length(
min: 1
max: 128
)
string RootName
@length(
min: 1
max: 128
)
@pattern("^[\\w+=,.@-]*$")
string ServicePrincipal
@length(
min: 0
max: 130
)
@pattern("^(r-[0-9a-z]{4,32})|(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})|(^p-[0-9a-zA-Z_]{8,128})|(^rp-[0-9a-zA-Z_]{4,128})$")
string TaggableResourceId
@length(
min: 1
max: 128
)
@pattern("^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$")
string TagKey
@length(
min: 0
max: 256
)
@pattern("^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$")
string TagValue
@length(
min: 1
max: 128
)
string TargetName
enum TargetType {
ACCOUNT
ORGANIZATIONAL_UNIT
ROOT
}
timestamp Timestamp