StartAutomationEvent
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.
Request Syntax
{
"clientToken": "string",
"recommendedActionId": "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.
- clientToken
-
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.
Type: String
Pattern:
[a-zA-Z0-9_-]{1,64}Required: No
- recommendedActionId
-
The ID of the recommended action to automate.
Type: String
Pattern:
[0-9A-Za-z]{16}Required: Yes
Response Syntax
{
"eventId": "string",
"eventStatus": "string",
"recommendedActionId": "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.
- eventId
-
The ID of the automation event.
Type: String
Pattern:
[0-9A-Za-z]{16} - eventStatus
-
The current status of the automation event.
Type: String
Valid Values:
Ready | InProgress | Complete | Failed | Cancelled | RollbackReady | RollbackInProgress | RollbackComplete | RollbackFailed - recommendedActionId
-
The ID of the recommended action being automated.
Type: String
Pattern:
[0-9A-Za-z]{16}
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 400
- ForbiddenException
-
You are not authorized to perform this action.
HTTP Status Code: 400
- IdempotencyTokenInUseException
-
The specified client token is already in use.
HTTP Status Code: 400
- IdempotentParameterMismatchException
-
Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.
HTTP Status Code: 400
- InternalServerException
-
An internal error occurred while processing the request.
HTTP Status Code: 500
- InvalidParameterValueException
-
One or more parameter values are not valid.
HTTP Status Code: 400
- OptInRequiredException
-
The account must be opted in to Compute Optimizer Automation before performing this action.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 400
- ServiceQuotaExceededException
-
The request would exceed service quotas.
HTTP Status Code: 400
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
