enrollment_status

Creates, updates, deletes, gets or lists an enrollment_status resource.

Overview

Name	enrollment_status
Type	Resource
Id	aws.cost_optimization_hub.enrollment_status

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
update_enrollment_status	update	region, status		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 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

UPDATE examples

update_enrollment_status

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

UPDATE aws.cost_optimization_hub.enrollment_status
SET 
status = '{{ status }}',
includeMemberAccounts = {{ includeMemberAccounts }}
WHERE 
region = '{{ region }}' --required
AND status = '{{ status }}' --required
RETURNING
status;