UpdateEnrollmentStatus
Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service.
If the account is a management account or delegated administrator of an organization, this action can also be used to enroll member accounts of the organization.
You must have the appropriate permissions to opt in to Cost Optimization Hub and to view its recommendations. When you opt in, Cost Optimization Hub automatically creates a service-linked role in your account to access its data.
Request Syntax
{
"includeMemberAccounts": boolean,
"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.
- includeMemberAccounts
-
Indicates whether to enroll member accounts of the organization if the account is the management account or delegated administrator.
Type: Boolean
Required: No
- status
-
Sets the account status.
Type: String
Valid Values:
Active | InactiveRequired: Yes
Response Syntax
{
"status": "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.
- status
-
The enrollment status of the account.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to use this operation with the given parameters.
HTTP Status Code: 400
- InternalServerException
-
An error on the server occurred during the processing of your request. Try again later.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
