IoTEvents / Client / list_alarm_model_versions

list_alarm_model_versions#

IoTEvents.Client.list_alarm_model_versions(**kwargs)#

Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.

See also: AWS API Documentation

Request Syntax

response = client.list_alarm_model_versions(
    alarmModelName='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • alarmModelName (string) –

    [REQUIRED]

    The name of the alarm model.

  • 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

{
    'alarmModelVersionSummaries': [
        {
            'alarmModelName': 'string',
            'alarmModelArn': 'string',
            'alarmModelVersion': 'string',
            'roleArn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1),
            'status': 'ACTIVE'|'ACTIVATING'|'INACTIVE'|'FAILED',
            'statusMessage': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • alarmModelVersionSummaries (list) –

      A list that summarizes each alarm model version.

      • (dict) –

        Contains a summary of an alarm model version.

        • alarmModelName (string) –

          The name of the alarm model.

        • alarmModelArn (string) –

          The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference .

        • alarmModelVersion (string) –

          The version of the alarm model.

        • roleArn (string) –

          The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference .

        • creationTime (datetime) –

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

        • lastUpdateTime (datetime) –

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

        • status (string) –

          The status of the alarm model. The status can be one of the following values:

          • ACTIVE - The alarm model is active and it’s ready to evaluate data.

          • ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.

          • INACTIVE - The alarm model is inactive, so it isn’t ready to evaluate data. Check your alarm model information and update the alarm model.

          • FAILED - You couldn’t create or update the alarm model. Check your alarm model information and try again.

        • statusMessage (string) –

          Contains information about the status of the alarm model version.

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

  • IoTEvents.Client.exceptions.ThrottlingException

  • IoTEvents.Client.exceptions.InternalFailureException

  • IoTEvents.Client.exceptions.ServiceUnavailableException