Class: Aws::IoTEvents::Types::NotificationAction

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotevents/types.rb

Overview

Note:

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

{
  action: { # required
    lambda_action: {
      function_arn: "AmazonResourceName", # required
      payload: {
        content_expression: "ContentExpression", # required
        type: "STRING", # required, accepts STRING, JSON
      },
    },
  },
  sms_configurations: [
    {
      sender_id: "SMSSenderId",
      additional_message: "NotificationAdditionalMessage",
      recipients: [ # required
        {
          sso_identity: {
            identity_store_id: "IdentityStoreId", # required
            user_id: "SSOReferenceId",
          },
        },
      ],
    },
  ],
  email_configurations: [
    {
      from: "FromEmail", # required
      content: {
        subject: "EmailSubject",
        additional_message: "NotificationAdditionalMessage",
      },
      recipients: { # required
        to: [
          {
            sso_identity: {
              identity_store_id: "IdentityStoreId", # required
              user_id: "SSOReferenceId",
            },
          },
        ],
      },
    },
  ],
}

Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ Types::NotificationTargetActions

Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the [AWS Lambda function provided by AWS IoT Events].

[1]: docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html

Returns:



4512
4513
4514
4515
4516
4517
4518
 
# File 'lib/aws-sdk-iotevents/types.rb', line 4512

class NotificationAction < Struct.new(
  :action,
  :sms_configurations,
  :email_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#email_configurations ⇒ Array<Types::EmailConfiguration>

Contains the configuration information of email notifications.

Returns:



4512
4513
4514
4515
4516
4517
4518
 
# File 'lib/aws-sdk-iotevents/types.rb', line 4512

class NotificationAction < Struct.new(
  :action,
  :sms_configurations,
  :email_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#sms_configurations ⇒ Array<Types::SMSConfiguration>

Contains the configuration information of SMS notifications.

Returns:



4512
4513
4514
4515
4516
4517
4518
 
# File 'lib/aws-sdk-iotevents/types.rb', line 4512

class NotificationAction < Struct.new(
  :action,
  :sms_configurations,
  :email_configurations)
  SENSITIVE = []
  include Aws::Structure
end