MediaLive / Paginator / ListClusterAlerts

ListClusterAlerts

class MediaLive.Paginator.ListClusterAlerts

paginator = client.get_paginator('list_cluster_alerts')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MediaLive.Client.list_cluster_alerts().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ClusterId (string) – [REQUIRED] The unique ID of the cluster

• StateFilter (string) – Specifies the set of alerts to return based on their state. SET - Return only alerts with SET state. CLEARED - Return only alerts with CLEARED state. ALL - Return all alerts.

• 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

{
    'Alerts': [
        {
            'AlertType': 'string',
            'ChannelId': 'string',
            'ClearedTimestamp': datetime(2015, 1, 1),
            'Id': 'string',
            'Message': 'string',
            'NodeId': 'string',
            'SetTimestamp': datetime(2015, 1, 1),
            'State': 'SET'|'CLEARED'
        },
    ],

}

Response Structure

• (dict) – List of alerts

  • Alerts (list) – The alerts found for this cluster

    • (dict) – An alert on a cluster

      • AlertType (string) – The type of the alert

      • ChannelId (string) – The ID of the channel this alert is associated with

      • ClearedTimestamp (datetime) – The time when the alert was cleared

      • Id (string) – The further subtype of this alert

      • Message (string) – The user facing alert message which can have more context

      • NodeId (string) – The ID of the node this alert is associated with

      • SetTimestamp (datetime) – The time when the alert was set

      • State (string) – The state of the alert