AWS Elemental MediaLive

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

See also: AWS API Documentation

Request Syntax

client.list_multiplex_alerts(
    MaxResults=123,
    MultiplexId='string',
    NextToken='string',
    StateFilter='string'
)

type MaxResults:

integer

param MaxResults:

The maximum number of items to return

type MultiplexId:

string

param MultiplexId:

[REQUIRED] The unique ID of the multiplex

type NextToken:

string

param NextToken:

The next pagination token

type StateFilter:

string

param StateFilter:

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.

rtype:

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 multiplex

    • (dict) -- An alert on a multiplex

      • 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

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

See also: AWS API Documentation

Request Syntax

client.list_cluster_alerts(
    ClusterId='string',
    MaxResults=123,
    NextToken='string',
    StateFilter='string'
)

type ClusterId:

string

param ClusterId:

[REQUIRED] The unique ID of the cluster

type MaxResults:

integer

param MaxResults:

The maximum number of items to return

type NextToken:

string

param NextToken:

The next pagination token

type StateFilter:

string

param StateFilter:

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.

rtype:

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

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

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

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

See also: AWS API Documentation

Request Syntax

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

type ChannelId:

string

param ChannelId:

[REQUIRED] The unique ID of the channel

type MaxResults:

integer

param MaxResults:

The maximum number of items to return

type NextToken:

string

param NextToken:

The next pagination token

type StateFilter:

string

param StateFilter:

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.

rtype:

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