list_alarm_models

IoTEvents.Client.list_alarm_models(**kwargs)

Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.

See also: AWS API Documentation

Request Syntax

response = client.list_alarm_models(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The token that you can use to return the next set of results.
  • maxResults (integer) -- The maximum number of results to be returned per request.
Return type

dict

Returns

Response Syntax

{
    'alarmModelSummaries': [
        {
            'creationTime': datetime(2015, 1, 1),
            'alarmModelDescription': 'string',
            'alarmModelName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • alarmModelSummaries (list) --

      A list that summarizes each alarm model.

      • (dict) --

        Contains a summary of an alarm model.

        • creationTime (datetime) --

          The time the alarm model was created, in the Unix epoch format.

        • alarmModelDescription (string) --

          The description of the alarm model.

        • alarmModelName (string) --

          The name of the alarm model.

    • nextToken (string) --

      The token that you can use to return the next set of results, or null if there are no more results.

Exceptions

  • IoTEvents.Client.exceptions.InvalidRequestException
  • IoTEvents.Client.exceptions.ThrottlingException
  • IoTEvents.Client.exceptions.InternalFailureException
  • IoTEvents.Client.exceptions.ServiceUnavailableException