You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#message_formatString

The message format of the message to publish. Optional. 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 http://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

Returns:

  • (String)


3013
3014
3015
3016
3017
3018
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3013

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

#role_arnString

The ARN of the IAM role that grants access.

Returns:

  • (String)


3013
3014
3015
3016
3017
3018
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3013

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

#target_arnString

The ARN of the SNS topic.

Returns:

  • (String)


3013
3014
3015
3016
3017
3018
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3013

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