ComputeOptimizerAutomation / Client / list_automation_events

list_automation_events¶

ComputeOptimizerAutomation.Client.list_automation_events(**kwargs)¶

Lists automation events based on specified filters. You can retrieve events that were created within the past year.

Request Syntax

response = client.list_automation_events(
    filters=[
        {
            'name': 'AccountId'|'ResourceType'|'EventType'|'EventStatus',
            'values': [
                'string',
            ]
        },
    ],
    startTimeInclusive=datetime(2015, 1, 1),
    endTimeExclusive=datetime(2015, 1, 1),
    maxResults=123,
    nextToken='string'
)

Parameters:

filters (list) –
The filters to apply to the list of automation events.
- (dict) –
  
  A filter to apply when listing automation events.
  - name (string) – [REQUIRED]
    
    The name of the filter to apply.
  - values (list) – [REQUIRED]
    
    The values to use for the specified filter.
    - (string) –
startTimeInclusive (datetime) – The start of the time range to query for events.
endTimeExclusive (datetime) – The end of the time range to query for events.
maxResults (integer) – The maximum number of results to return in a single call.
nextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'automationEvents': [
        {
            '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'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- automationEvents (list) –
  
  The list of automation events that match the specified criteria.
  - (dict) –
    
    Contains information about an automation event.
    - eventId (string) –
      
      The unique identifier for the automation event.
    - 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) –
      
      The estimated monthly cost savings associated with this automation event.
      - 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.
- nextToken (string) –
  
  The token to use to retrieve the next page of results.

Exceptions

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