ComputeOptimizerAutomation / Client / list_automation_event_steps

list_automation_event_steps¶

ComputeOptimizerAutomation.Client.list_automation_event_steps(**kwargs)¶

Lists the steps for a specific automation event. You can only list steps for events created within the past year.

Request Syntax

response = client.list_automation_event_steps(
    eventId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

eventId (string) –
[REQUIRED]

The ID of the automation event.
maxResults (integer) – The maximum number of automation event steps to return in a single response. Valid range is 1-1000.
nextToken (string) – A token used for pagination to retrieve the next set of results when the response is truncated.

Return type:

dict

Returns:

Response Syntax

{
    'automationEventSteps': [
        {
            'eventId': 'string',
            'stepId': 'string',
            'stepType': 'CreateEbsSnapshot'|'DeleteEbsVolume'|'ModifyEbsVolume'|'CreateEbsVolume',
            'stepStatus': 'Ready'|'InProgress'|'Complete'|'Failed',
            'resourceId': 'string',
            'startTimestamp': 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) –
- automationEventSteps (list) –
  
  The list of steps for the specified automation event.
  - (dict) –
    
    Contains information about a step in an automation event.
    - eventId (string) –
      
      The ID of the automation event this step belongs to.
    - stepId (string) –
      
      The unique identifier for this step.
    - stepType (string) –
      
      The type of step.
    - stepStatus (string) –
      
      The current status of the step.
    - resourceId (string) –
      
      The unique identifier of the resource being acted upon in this step.
    - startTimestamp (datetime) –
      
      The timestamp when this automation event step started execution.
    - completedTimestamp (datetime) –
      
      The timestamp when this automation event step completed execution.
    - 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.
- nextToken (string) –
  
  A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.

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