Amazon Lookout for Metrics

2022/05/19 - Amazon Lookout for Metrics - 2 updated api methods

Changes  In this release we added SnsFormat to SNSConfiguration to support human readable alert.

CreateAlert (updated) Link ¶
Changes (request)
{'Action': {'SNSConfiguration': {'SnsFormat': 'LONG_TEXT | SHORT_TEXT | JSON'}}}

Creates an alert for an anomaly detector.

See also: AWS API Documentation

Request Syntax

client.create_alert(
    AlertName='string',
    AlertSensitivityThreshold=123,
    AlertDescription='string',
    AnomalyDetectorArn='string',
    Action={
        'SNSConfiguration': {
            'RoleArn': 'string',
            'SnsTopicArn': 'string',
            'SnsFormat': 'LONG_TEXT'|'SHORT_TEXT'|'JSON'
        },
        'LambdaConfiguration': {
            'RoleArn': 'string',
            'LambdaArn': 'string'
        }
    },
    Tags={
        'string': 'string'
    }
)
type AlertName

string

param AlertName

[REQUIRED]

The name of the alert.

type AlertSensitivityThreshold

integer

param AlertSensitivityThreshold

[REQUIRED]

An integer from 0 to 100 specifying the alert sensitivity threshold.

type AlertDescription

string

param AlertDescription

A description of the alert.

type AnomalyDetectorArn

string

param AnomalyDetectorArn

[REQUIRED]

The ARN of the detector to which the alert is attached.

type Action

dict

param Action

[REQUIRED]

Action that will be triggered when there is an alert.

  • SNSConfiguration (dict) --

    A configuration for an Amazon SNS channel.

    • RoleArn (string) -- [REQUIRED]

      The ARN of the IAM role that has access to the target SNS topic.

    • SnsTopicArn (string) -- [REQUIRED]

      The ARN of the target SNS topic.

    • SnsFormat (string) --

      The text format for alerts.

  • LambdaConfiguration (dict) --

    A configuration for an AWS Lambda channel.

    • RoleArn (string) -- [REQUIRED]

      The ARN of an IAM role that has permission to invoke the Lambda function.

    • LambdaArn (string) -- [REQUIRED]

      The ARN of the Lambda function.

type Tags

dict

param Tags

A list of tags to apply to the alert.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'AlertArn': 'string'
}

Response Structure

  • (dict) --

    • AlertArn (string) --

      The ARN of the alert.

DescribeAlert (updated) Link ¶
Changes (response)
{'Alert': {'Action': {'SNSConfiguration': {'SnsFormat': 'LONG_TEXT | '
                                                        'SHORT_TEXT | JSON'}}}}

Describes an alert.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

See also: AWS API Documentation

Request Syntax

client.describe_alert(
    AlertArn='string'
)
type AlertArn

string

param AlertArn

[REQUIRED]

The ARN of the alert to describe.

rtype

dict

returns

Response Syntax

{
    'Alert': {
        'Action': {
            'SNSConfiguration': {
                'RoleArn': 'string',
                'SnsTopicArn': 'string',
                'SnsFormat': 'LONG_TEXT'|'SHORT_TEXT'|'JSON'
            },
            'LambdaConfiguration': {
                'RoleArn': 'string',
                'LambdaArn': 'string'
            }
        },
        'AlertDescription': 'string',
        'AlertArn': 'string',
        'AnomalyDetectorArn': 'string',
        'AlertName': 'string',
        'AlertSensitivityThreshold': 123,
        'AlertType': 'SNS'|'LAMBDA',
        'AlertStatus': 'ACTIVE'|'INACTIVE',
        'LastModificationTime': datetime(2015, 1, 1),
        'CreationTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • Alert (dict) --

      Contains information about an alert.

      • Action (dict) --

        Action that will be triggered when there is an alert.

        • SNSConfiguration (dict) --

          A configuration for an Amazon SNS channel.

          • RoleArn (string) --

            The ARN of the IAM role that has access to the target SNS topic.

          • SnsTopicArn (string) --

            The ARN of the target SNS topic.

          • SnsFormat (string) --

            The text format for alerts.

        • LambdaConfiguration (dict) --

          A configuration for an AWS Lambda channel.

          • RoleArn (string) --

            The ARN of an IAM role that has permission to invoke the Lambda function.

          • LambdaArn (string) --

            The ARN of the Lambda function.

      • AlertDescription (string) --

        A description of the alert.

      • AlertArn (string) --

        The ARN of the alert.

      • AnomalyDetectorArn (string) --

        The ARN of the detector to which the alert is attached.

      • AlertName (string) --

        The name of the alert.

      • AlertSensitivityThreshold (integer) --

        The minimum severity for an anomaly to trigger the alert.

      • AlertType (string) --

        The type of the alert.

      • AlertStatus (string) --

        The status of the alert.

      • LastModificationTime (datetime) --

        The time at which the alert was last modified.

      • CreationTime (datetime) --

        The time at which the alert was created.