ComputeOptimizerAutomation / Client / start_automation_event

start_automation_event

ComputeOptimizerAutomation.Client.start_automation_event(**kwargs)

Initiates a one-time, on-demand automation for the specified recommended action.

Note

Management accounts and delegated administrators can only initiate recommended actions for associated member accounts. You can associate a member account using AssociateAccounts.

See also: AWS API Documentation

Request Syntax

response = client.start_automation_event(
    recommendedActionId='string',
    clientToken='string'
)

Parameters:

• recommendedActionId (string) –

  [REQUIRED]

  The ID of the recommended action to automate.

• 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

{
    'recommendedActionId': 'string',
    'eventId': 'string',
    'eventStatus': 'Ready'|'InProgress'|'Complete'|'Failed'|'Cancelled'|'RollbackReady'|'RollbackInProgress'|'RollbackComplete'|'RollbackFailed'
}

Response Structure

• (dict) –

  • recommendedActionId (string) –

    The ID of the recommended action being automated.

  • eventId (string) –

    The ID of the automation event.

  • eventStatus (string) –

    The current status of the automation event.

Exceptions

• ComputeOptimizerAutomation.Client.exceptions.InvalidParameterValueException

• ComputeOptimizerAutomation.Client.exceptions.ForbiddenException

• ComputeOptimizerAutomation.Client.exceptions.OptInRequiredException

• ComputeOptimizerAutomation.Client.exceptions.ThrottlingException

• ComputeOptimizerAutomation.Client.exceptions.IdempotentParameterMismatchException

• ComputeOptimizerAutomation.Client.exceptions.ResourceNotFoundException

• ComputeOptimizerAutomation.Client.exceptions.AccessDeniedException

• ComputeOptimizerAutomation.Client.exceptions.InternalServerException

• ComputeOptimizerAutomation.Client.exceptions.ServiceUnavailableException

• ComputeOptimizerAutomation.Client.exceptions.IdempotencyTokenInUseException

• ComputeOptimizerAutomation.Client.exceptions.ServiceQuotaExceededException