DisablePolicyType

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 AWS 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. AWS recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.

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

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

Request Syntax

{
   "PolicyType": "string",
   "RootId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

PolicyType

The policy type that you want to disable in this root. You can specify one of the following values:

• SERVICE_CONTROL_POLICY

• RESOURCE_CONTROL_POLICY

• BACKUP_POLICY

• TAG_POLICY

• CHATBOT_POLICY

• AISERVICES_OPT_OUT_POLICY

Type: String

Valid Values: SERVICE_CONTROL_POLICY | RESOURCE_CONTROL_POLICY | TAG_POLICY | BACKUP_POLICY | AISERVICES_OPT_OUT_POLICY | CHATBOT_POLICY

Required: Yes

RootId

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.

Type: String

Length Constraints: Maximum length of 34.

Pattern: ^r-[0-9a-z]{4,32}$

Required: Yes

Response Syntax

{
   "Root": { 
      "Arn": "string",
      "Id": "string",
      "Name": "string",
      "PolicyTypes": [ 
         { 
            "Status": "string",
            "Type": "string"
         }
      ]
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Root

A structure that shows the root with the updated list of enabled policy types.

Type: Root object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 400

AWSOrganizationsNotInUseException

Your account isn't a member of an organization. To make this request, you must use the credentials of an account that belongs to an organization.

HTTP Status Code: 400

ConcurrentModificationException

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

HTTP Status Code: 400

ConstraintViolationException

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

Note

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

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

• ACCOUNT_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 AWS Support to request an increase in your limit.

  Or the number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations or contact AWS Support to request an increase in the number of accounts.

  Note

  Deleted and closed accounts still count toward your limit.

  Important

  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 AWS 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 AWS 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 AWS account as a delegated administrator for an AWS 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. AWS does not support cards issued by financial institutions in Russia or Belarus. For more information, see Managing your AWS payments.

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

• MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the AWS 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 AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

• MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this 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 AWS 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 AWS 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 AWS account, you must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

HTTP Status Code: 400

InvalidInputException

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

Note

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 AWS 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_PRINCIPAL: You specified an invalid principal element in the policy.

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

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

• INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

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

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

• MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.

• MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.

• MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.

• MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.

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

• NON_DETACHABLE_POLICY: You can't detach this AWS Managed Policy.

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

HTTP Status Code: 400

PolicyChangesInProgressException

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

HTTP Status Code: 400

PolicyTypeNotEnabledException

The specified policy type isn't currently enabled in this root. You can't attach policies of the specified type to entities in a root until you enable that type in the root. For more information, see Enabling all features in your organization in the AWS Organizations User Guide.

HTTP Status Code: 400

RootNotFoundException

We can't find a root with the RootId that you specified.

HTTP Status Code: 400

ServiceException

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

HTTP Status Code: 500

TooManyRequestsException

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

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

HTTP Status Code: 400

UnsupportedAPIEndpointException

This action isn't available in the current AWS Region.

HTTP Status Code: 400

Examples

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.

Example

This example illustrates one usage of DisablePolicyType.

Sample Request

POST / HTTP/1.1
X-Amz-Target: AWSOrganizationsV20161128.DisablePolicyType

{ "RootId": "r-examplerootid111", "PolicyType": "SERVICE_CONTROL_POLICY" }

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json
{
  "Root": {
    "PolicyTypes": [
      {
        "Status": "ENABLED",
        "Type": "AISERVICES_OPT_OUT_POLICY"
      },
      {
        "Status": "ENABLED",
        "Type": "BACKUP_POLICY"
      },
      {
        "Status": "ENABLED",
        "Type": "TAG_POLICY"
      },
      {
        "Status": "ENABLED",
        "Type": "RESOURCE_CONTROL_POLICY"
      }
    ],
    "Name": "Root",
    "Id": "r-examplerootid111",
    "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111"
  }
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3