Class: Aws::LookoutMetrics::Types::CreateAlertRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb

Overview

Note:

When making an API call, you may pass CreateAlertRequest data as a hash:

{
  alert_name: "AlertName", # required
  alert_sensitivity_threshold: 1, # required
  alert_description: "AlertDescription",
  anomaly_detector_arn: "Arn", # required
  action: { # required
    sns_configuration: {
      role_arn: "Arn", # required
      sns_topic_arn: "Arn", # required
    },
    lambda_configuration: {
      role_arn: "Arn", # required
      lambda_arn: "Arn", # required
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionTypes::Action

Action that will be triggered when there is an alert.

Returns:



603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 603

class CreateAlertRequest < Struct.new(
  :alert_name,
  :alert_sensitivity_threshold,
  :alert_description,
  :anomaly_detector_arn,
  :action,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#alert_descriptionString

A description of the alert.

Returns:

  • (String)


603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 603

class CreateAlertRequest < Struct.new(
  :alert_name,
  :alert_sensitivity_threshold,
  :alert_description,
  :anomaly_detector_arn,
  :action,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#alert_nameString

The name of the alert.

Returns:

  • (String)


603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 603

class CreateAlertRequest < Struct.new(
  :alert_name,
  :alert_sensitivity_threshold,
  :alert_description,
  :anomaly_detector_arn,
  :action,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#alert_sensitivity_thresholdInteger

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

Returns:

  • (Integer)


603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 603

class CreateAlertRequest < Struct.new(
  :alert_name,
  :alert_sensitivity_threshold,
  :alert_description,
  :anomaly_detector_arn,
  :action,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#anomaly_detector_arnString

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

Returns:

  • (String)


603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 603

class CreateAlertRequest < Struct.new(
  :alert_name,
  :alert_sensitivity_threshold,
  :alert_description,
  :anomaly_detector_arn,
  :action,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

A list of tags to apply to the alert.

Returns:

  • (Hash<String,String>)


603
604
605
606
607
608
609
610
611
612
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 603

class CreateAlertRequest < Struct.new(
  :alert_name,
  :alert_sensitivity_threshold,
  :alert_description,
  :anomaly_detector_arn,
  :action,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end