ComputeOptimizerAutomation / Paginator / ListAutomationEvents

ListAutomationEvents

class ComputeOptimizerAutomation.Paginator.ListAutomationEvents

paginator = client.get_paginator('list_automation_events')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'AccountId'|'ResourceType'|'EventType'|'EventStatus',
            'values': [
                'string',
            ]
        },
    ],
    startTimeInclusive=datetime(2015, 1, 1),
    endTimeExclusive=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• 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

{
    '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) –

    A token to resume pagination.