View a markdown version of this page

PutOrganizationEnrollmentConfiguration - AWS Compute Optimizer

PutOrganizationEnrollmentConfiguration

Creates or updates an organization enrollment configuration. The organization enrollment configuration sets the organization rule mode on the specified account, organizational unit (OU), or organization root and enables Automation for affected member accounts that have opted in to Compute Optimizer, including accounts that join later. Changes on an OU or the organization root can take up to 5 minutes. Organization enrollment configurations take precedence over settings made by AssociateAccounts and DisassociateAccounts. You must specify at least one configuration in the request.

Note

Only the management account or a delegated administrator can perform this action.

Organization enrollment configurations can't be created for the management account.

Request Syntax

{ "clientToken": "string", "organizationRuleMode": "string", "target": { ... } }

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.

clientToken

A unique identifier to ensure idempotency of the request.

Type: String

Pattern: [a-zA-Z0-9_-]{1,64}

Required: No

organizationRuleMode

The organization rule mode to set on the target. An organization enrollment configuration with either AnyAllowed or NoneAllowed enables Automation for affected member accounts. AnyAllowed permits organization rules to apply to those accounts, while NoneAllowed doesn't.

Type: String

Valid Values: AnyAllowed | NoneAllowed

Required: No

target

The account, organizational unit (OU), or organization root on which to create or update the organization enrollment configuration. You can't specify the management account.

Type: OrganizationTarget object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

Response Elements

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

Errors

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

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

ConflictException

The request conflicts with a concurrent change to the same resource. Retry the request.

HTTP Status Code: 409

ForbiddenException

You are not authorized to perform this action.

HTTP Status Code: 403

IdempotencyTokenInUseException

The specified client token is already in use.

HTTP Status Code: 409

IdempotentParameterMismatchException

Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.

HTTP Status Code: 409

InternalServerException

An internal error occurred while processing the request.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400

OptInRequiredException

The account must be opted in to Compute Optimizer Automation before performing this action.

HTTP Status Code: 403

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also

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