[ aws . lookoutmetrics ]
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
See ‘aws help’ for descriptions of global parameters.
describe-alert
--alert-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--alert-arn
(string)
The ARN of the alert to describe.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Alert -> (structure)
Contains information about an alert.
Action -> (structure)
Action that will be triggered when there is an alert.
SNSConfiguration -> (structure)
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.
LambdaConfiguration -> (structure)
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 -> (timestamp)
The time at which the alert was last modified.
CreationTime -> (timestamp)
The time at which the alert was created.