CloudWatchApplicationSignals / Client / list_service_level_objective_exclusion_windows

list_service_level_objective_exclusion_windows

CloudWatchApplicationSignals.Client.list_service_level_objective_exclusion_windows(**kwargs)

Retrieves all exclusion windows configured for a specific SLO.

See also: AWS API Documentation

Request Syntax

response = client.list_service_level_objective_exclusion_windows(
    Id='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • Id (string) –

    [REQUIRED]

    The ID of the SLO to list exclusion windows for.

  • MaxResults (integer) – The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used. </p>

  • NextToken (string) – Include this value, if it was returned by the previous operation, to get the next set of service level objectives. </p>

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'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      Include this value, if it was returned by the previous operation, to get the next set of service level objectives. </p>

Exceptions

  • CloudWatchApplicationSignals.Client.exceptions.ValidationException

  • CloudWatchApplicationSignals.Client.exceptions.ResourceNotFoundException

  • CloudWatchApplicationSignals.Client.exceptions.ThrottlingException