MediaLive / Client / list_alerts

list_alerts

MediaLive.Client.list_alerts(**kwargs)

List the alerts for a channel with optional filtering based on alert state.

See also: AWS API Documentation

Request Syntax

response = client.list_alerts(
    ChannelId='string',
    MaxResults=123,
    NextToken='string',
    StateFilter='string'
)
Parameters:

  • ChannelId (string) – [REQUIRED] The unique ID of the channel

  • MaxResults (integer) – The maximum number of items to return

  • NextToken (string) – The next pagination token

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) – List of alerts

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

      • (dict) – An alert on a channel

        • AlertType (string) – The type of the alert

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

        • Id (string) – The unique ID for this alert instance

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

        • PipelineId (string) – The ID of the pipeline this alert is associated with

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

        • State (string) – The state of the alert

    • NextToken (string) – The token to use to retrieve the next page of results

Exceptions

  • MediaLive.Client.exceptions.BadRequestException

  • MediaLive.Client.exceptions.InternalServerErrorException

  • MediaLive.Client.exceptions.ForbiddenException

  • MediaLive.Client.exceptions.BadGatewayException

  • MediaLive.Client.exceptions.NotFoundException

  • MediaLive.Client.exceptions.GatewayTimeoutException

  • MediaLive.Client.exceptions.TooManyRequestsException