ComputeOptimizerAutomation / Client / list_automation_event_summaries

list_automation_event_summaries

ComputeOptimizerAutomation.Client.list_automation_event_summaries(**kwargs)

Provides a summary of automation events based on specified filters. Only events created within the past year will be included in the summary.

See also: AWS API Documentation

Request Syntax

response = client.list_automation_event_summaries(
    filters=[
        {
            'name': 'AccountId'|'ResourceType'|'EventType'|'EventStatus',
            'values': [
                'string',
            ]
        },
    ],
    startDateInclusive='string',
    endDateExclusive='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

• filters (list) –

  The filters to apply to the list of automation event summaries.

  • (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) –

• startDateInclusive (string) – The start date for filtering automation event summaries, inclusive. Events created on or after this date will be included.

• endDateExclusive (string) – The end date for filtering automation event summaries, exclusive. Events created before this date will be included.

• maxResults (integer) – The maximum number of automation event summaries 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

{
    'automationEventSummaries': [
        {
            'key': 'string',
            'dimensions': [
                {
                    'key': 'EventStatus',
                    'value': 'string'
                },
            ],
            'timePeriod': {
                'startTimeInclusive': datetime(2015, 1, 1),
                'endTimeExclusive': datetime(2015, 1, 1)
            },
            'total': {
                'automationEventCount': 123,
                'estimatedMonthlySavings': {
                    'currency': 'string',
                    'beforeDiscountSavings': 123.0,
                    'afterDiscountSavings': 123.0,
                    'savingsEstimationMode': 'BeforeDiscount'|'AfterDiscount'
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • automationEventSummaries (list) –

    The list of automation event summaries that match the specified criteria.

    • (dict) –

      A summary of automation events grouped by specified dimensions.

      • key (string) –

        The key identifier for this summary grouping.

      • dimensions (list) –

        The dimensions used to group this summary, such as event status.

        • (dict) –

          A key-value pair used to categorize and group summary data for analysis and reporting.

          • key (string) –

            The dimension key used for categorizing summary data.

          • value (string) –

            The specific value for this dimension key used in the summary grouping.

      • timePeriod (dict) –

        The time period covered by this summary, with inclusive start time and exclusive end time.

        • startTimeInclusive (datetime) –

          The start time of the period, inclusive. Events at or after this time are included.

        • endTimeExclusive (datetime) –

          The end time of the period, exclusive. Events before this time are included.

      • total (dict) –

        The aggregated totals for this summary, including event count and estimated savings.

        • automationEventCount (integer) –

          The total number of automation events in this summary group.

        • 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.AccessDeniedException

• ComputeOptimizerAutomation.Client.exceptions.InternalServerException

• ComputeOptimizerAutomation.Client.exceptions.ServiceUnavailableException