CloudWatchApplicationSignals / Paginator / ListServiceLevelObjectiveExclusionWindows

ListServiceLevelObjectiveExclusionWindows

class CloudWatchApplicationSignals.Paginator.ListServiceLevelObjectiveExclusionWindows

paginator = client.get_paginator('list_service_level_objective_exclusion_windows')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchApplicationSignals.Client.list_service_level_objective_exclusion_windows().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• Id (string) –

  [REQUIRED]

  The ID of the SLO to list exclusion windows for.

• 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

{
    'ExclusionWindows': [
        {
            'Window': {
                'DurationUnit': 'MINUTE'|'HOUR'|'DAY'|'MONTH',
                'Duration': 123
            },
            'StartTime': datetime(2015, 1, 1),
            'RecurrenceRule': {
                'Expression': 'string'
            },
            'Reason': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • ExclusionWindows (list) –

    A list of exclusion windows configured for the SLO.

    • (dict) –

      The core SLO time window exclusion object that includes Window, StartTime, RecurrenceRule, and Reason.

      • Window (dict) –

        The SLO time window exclusion .

        • DurationUnit (string) –

          The unit of time for the exclusion window duration. Valid values: MINUTE, HOUR, DAY, MONTH.

        • Duration (integer) –

          The number of time units for the exclusion window length.

      • StartTime (datetime) –

        The start of the SLO time window exclusion. Defaults to current time if not specified.

      • RecurrenceRule (dict) –

        The recurrence rule for the SLO time window exclusion. Supports both cron and rate expressions.

        • Expression (string) –

          A cron or rate expression that specifies the schedule for the exclusion window.

      • Reason (string) –

        A description explaining why this time period should be excluded from SLO calculations.