ComputeOptimizerAutomation / Client / update_enrollment_configuration

update_enrollment_configuration

ComputeOptimizerAutomation.Client.update_enrollment_configuration(**kwargs)

Updates your account’s Compute Optimizer Automation enrollment configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_enrollment_configuration(
    status='Active'|'Inactive'|'Pending'|'Failed',
    clientToken='string'
)

Parameters:

• status (string) –

  [REQUIRED]

  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.

• clientToken (string) –

  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.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'Active'|'Inactive'|'Pending'|'Failed',
    'statusReason': 'string',
    'lastUpdatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • status (string) –

    The updated enrollment status.

  • statusReason (string) –

    The reason for the updated enrollment status.

  • lastUpdatedTimestamp (datetime) –

    The timestamp when the enrollment configuration was last updated.

Exceptions

• ComputeOptimizerAutomation.Client.exceptions.InvalidParameterValueException

• ComputeOptimizerAutomation.Client.exceptions.ForbiddenException

• ComputeOptimizerAutomation.Client.exceptions.OptInRequiredException

• ComputeOptimizerAutomation.Client.exceptions.IdempotentParameterMismatchException

• ComputeOptimizerAutomation.Client.exceptions.ResourceNotFoundException

• ComputeOptimizerAutomation.Client.exceptions.ThrottlingException

• ComputeOptimizerAutomation.Client.exceptions.AccessDeniedException

• ComputeOptimizerAutomation.Client.exceptions.InternalServerException

• ComputeOptimizerAutomation.Client.exceptions.NotManagementAccountException

• ComputeOptimizerAutomation.Client.exceptions.ServiceUnavailableException

• ComputeOptimizerAutomation.Client.exceptions.IdempotencyTokenInUseException