Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateEnrollmentConfiguration

Updates your account’s Compute Optimizer Automation enrollment configuration.

Request Syntax


{
   "clientToken": "string",
   "status": "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.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.

Type: String

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

Required: No

status

The desired enrollment status.

Active - Enables the Automation feature for your account.
Inactive - Disables the Automation feature for your account and stops all of your automation rules. If you opt in again later, all rules will be inactive, and you must enable the rules you want to run. You must wait at least 24 hours after opting out to opt in again.

Note

The Pending and Failed options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.

If you are a member account, your account must be disassociated from your organization’s management account before you can disable Automation. Contact your administrator to make this change.

Type: String

Valid Values: Active | Inactive | Pending | Failed

Required: Yes

Response Syntax


{
   "lastUpdatedTimestamp": number,
   "status": "string",
   "statusReason": "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.

lastUpdatedTimestamp

The timestamp when the enrollment configuration was last updated.

Type: Timestamp

status

The updated enrollment status.

Type: String

Valid Values: Active | Inactive | Pending | Failed

statusReason

The reason for the updated enrollment status.

Type: String

Errors

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

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 400

ForbiddenException

You are not authorized to perform this action.

HTTP Status Code: 400

IdempotencyTokenInUseException

The specified client token is already in use.

HTTP Status Code: 400

IdempotentParameterMismatchException

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

HTTP Status Code: 400

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

NotManagementAccountException

The operation can only be performed by a management account.

HTTP Status Code: 400

OptInRequiredException

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

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400