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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SnsAction as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

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) —

    (Optional) The message format of the message to publish.

#role_arn ⇒ String

The ARN of the IAM role that grants access.

Returns:

  • (String) —

    The ARN of the IAM role that grants access.

#target_arn ⇒ String

The ARN of the SNS topic.

Returns:

  • (String) —

    The ARN of the SNS topic.