GetAutomationEvent
Retrieves details about a specific automation event.
Request Syntax
{
"eventId": "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.
- eventId
-
The ID of the automation event to retrieve.
Type: String
Pattern:
[0-9A-Za-z]{16}Required: Yes
Response Syntax
{
"accountId": "string",
"completedTimestamp": number,
"createdTimestamp": number,
"estimatedMonthlySavings": {
"afterDiscountSavings": number,
"beforeDiscountSavings": number,
"currency": "string",
"savingsEstimationMode": "string"
},
"eventDescription": "string",
"eventId": "string",
"eventStatus": "string",
"eventStatusReason": "string",
"eventType": "string",
"recommendedActionId": "string",
"region": "string",
"resourceArn": "string",
"resourceId": "string",
"resourceType": "string",
"ruleId": "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.
- accountId
-
The AWS account ID associated with the automation event.
Type: String
Pattern:
[0-9]{12} - completedTimestamp
-
The timestamp when the automation event completed.
Type: Timestamp
- createdTimestamp
-
The timestamp when the automation event was created.
Type: Timestamp
- estimatedMonthlySavings
-
Contains information about estimated monthly cost savings.
Type: EstimatedMonthlySavings object
- eventDescription
-
A description of the automation event.
Type: String
- eventId
-
The ID of the automation event to retrieve.
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 - eventStatusReason
-
The reason for the current event status.
Type: String
- eventType
-
The type of automation event.
Type: String
Valid Values:
SnapshotAndDeleteUnattachedEbsVolume | UpgradeEbsVolumeType - recommendedActionId
-
The ID of the recommended action associated with this automation event.
Type: String
Pattern:
[0-9A-Za-z]{16} - region
-
The AWS Region where the automation event occurred.
Type: String
- resourceArn
-
The Amazon Resource Name (ARN) of the resource affected by the automation event.
Type: String
Pattern:
arn:aws[a-z0-9-]*:[a-z0-9-]+:[a-z0-9-]*:[0-9]{0,12}:[a-zA-Z0-9/_.-]+ - resourceId
-
The ID of the resource affected by the automation event.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9_.-]+ - resourceType
-
The type of resource affected by the automation event.
Type: String
Valid Values:
EbsVolume - ruleId
-
The ID of the automation rule that triggered this event.
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
- 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
- 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:
