ComputeOptimizerAutomation / Paginator / ListAutomationEventSteps

ListAutomationEventSteps

class ComputeOptimizerAutomation.Paginator.ListAutomationEventSteps

paginator = client.get_paginator('list_automation_event_steps')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ComputeOptimizerAutomation.Client.list_automation_event_steps().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    eventId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• eventId (string) –

  [REQUIRED]

  The ID of the automation event.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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 to resume pagination.