Class: Aws::IoT::Types::SnsAction

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

Overview

Note:

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

{
  target_arn: "AwsArn", # required
  role_arn: "AwsArn", # required
  message_format: "RAW", # accepts RAW, JSON
}

Describes an action to publish to an Amazon SNS topic.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#message_format ⇒ String

(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

Returns:

  • (String) 


16286
16287
16288
16289
16290
16291
16292
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16286

class SnsAction < Struct.new(
  :target_arn,
  :role_arn,
  :message_format)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of the IAM role that grants access.

Returns:

  • (String) 


16286
16287
16288
16289
16290
16291
16292
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16286

class SnsAction < Struct.new(
  :target_arn,
  :role_arn,
  :message_format)
  SENSITIVE = []
  include Aws::Structure
end

#target_arn ⇒ String

The ARN of the SNS topic.

Returns:

  • (String) 


16286
16287
16288
16289
16290
16291
16292
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16286

class SnsAction < Struct.new(
  :target_arn,
  :role_arn,
  :message_format)
  SENSITIVE = []
  include Aws::Structure
end