CostOptimizationHub / Client / update_enrollment_status

update_enrollment_status#

CostOptimizationHub.Client.update_enrollment_status(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.update_enrollment_status(
    status='Active'|'Inactive',
    includeMemberAccounts=True|False
)
Parameters:

  • status (string) –

    [REQUIRED]

    Sets the account status.

  • includeMemberAccounts (boolean) – Indicates whether to enroll member accounts of the organization if the account is the management account or delegated administrator.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'string'
}

Response Structure

  • (dict) –

    • status (string) –

      The enrollment status of the account.

Exceptions

  • CostOptimizationHub.Client.exceptions.ValidationException

  • CostOptimizationHub.Client.exceptions.InternalServerException

  • CostOptimizationHub.Client.exceptions.AccessDeniedException

  • CostOptimizationHub.Client.exceptions.ThrottlingException