ComputeOptimizerAutomation / Client / get_automation_event

get_automation_event¶

ComputeOptimizerAutomation.Client.get_automation_event(**kwargs)¶

Retrieves details about a specific automation event.

Request Syntax

response = client.get_automation_event(
    eventId='string'
)

Parameters:

eventId (string) –

[REQUIRED]

The ID of the automation event to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'eventId': 'string',
    'eventDescription': 'string',
    'eventType': 'SnapshotAndDeleteUnattachedEbsVolume'|'UpgradeEbsVolumeType',
    'eventStatus': 'Ready'|'InProgress'|'Complete'|'Failed'|'Cancelled'|'RollbackReady'|'RollbackInProgress'|'RollbackComplete'|'RollbackFailed',
    'eventStatusReason': 'string',
    'resourceArn': 'string',
    'resourceId': 'string',
    'recommendedActionId': 'string',
    'accountId': 'string',
    'region': 'string',
    'ruleId': 'string',
    'resourceType': 'EbsVolume',
    'createdTimestamp': datetime(2015, 1, 1),
    'completedTimestamp': datetime(2015, 1, 1),
    'estimatedMonthlySavings': {
        'currency': 'string',
        'beforeDiscountSavings': 123.0,
        'afterDiscountSavings': 123.0,
        'savingsEstimationMode': 'BeforeDiscount'|'AfterDiscount'
    }
}

Response Structure

(dict) –
- eventId (string) –
  
  The ID of the automation event to retrieve.
- eventDescription (string) –
  
  A description of the automation event.
- eventType (string) –
  
  The type of automation event.
- eventStatus (string) –
  
  The current status of the automation event.
- eventStatusReason (string) –
  
  The reason for the current event status.
- resourceArn (string) –
  
  The Amazon Resource Name (ARN) of the resource affected by the automation event.
- resourceId (string) –
  
  The ID of the resource affected by the automation event.
- recommendedActionId (string) –
  
  The ID of the recommended action associated with this automation event.
- accountId (string) –
  
  The Amazon Web Services account ID associated with the automation event.
- region (string) –
  
  The Amazon Web Services Region where the automation event occurred.
- ruleId (string) –
  
  The ID of the automation rule that triggered this event.
- resourceType (string) –
  
  The type of resource affected by the automation event.
- createdTimestamp (datetime) –
  
  The timestamp when the automation event was created.
- completedTimestamp (datetime) –
  
  The timestamp when the automation event completed.
- estimatedMonthlySavings (dict) –
  
  Contains information about estimated monthly cost savings.
  - currency (string) –
    
    The currency of the estimated savings.
  - beforeDiscountSavings (float) –
    
    The estimated monthly savings before applying any discounts.
  - afterDiscountSavings (float) –
    
    The estimated monthly savings after applying any discounts.
  - savingsEstimationMode (string) –
    
    The mode used to calculate savings, either BeforeDiscount or AfterDiscount.

Exceptions

ComputeOptimizerAutomation.Client.exceptions.InvalidParameterValueException
ComputeOptimizerAutomation.Client.exceptions.ForbiddenException
ComputeOptimizerAutomation.Client.exceptions.OptInRequiredException
ComputeOptimizerAutomation.Client.exceptions.ThrottlingException
ComputeOptimizerAutomation.Client.exceptions.ResourceNotFoundException
ComputeOptimizerAutomation.Client.exceptions.AccessDeniedException
ComputeOptimizerAutomation.Client.exceptions.InternalServerException
ComputeOptimizerAutomation.Client.exceptions.ServiceUnavailableException