Skip to content

SnsAction

Source code in docs_src/capo_iot/types/sns_action.py 
14
15
16
17
18
19
20
class SnsAction(TypedDict, closed=True):
    target_arn: "capo_iot.types.aws_arn.AwsArn"
    """<p>The ARN of the SNS topic.</p>"""
    role_arn: "capo_iot.types.aws_arn.AwsArn"
    """<p>The ARN of the IAM role that grants access.</p>"""
    message_format: NotRequired["capo_iot.types.message_format.MessageFormat"]
    """<p>(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 <a href="https://docs.aws.amazon.com/sns/latest/dg/json-formats.html">https://docs.aws.amazon.com/sns/latest/dg/json-formats.html</a> refer to their official documentation.</p>"""

message_format instance-attribute 

message_format: NotRequired[MessageFormat]

(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.

role_arn instance-attribute 

role_arn: AwsArn

The ARN of the IAM role that grants access.

target_arn instance-attribute 

target_arn: AwsArn

The ARN of the SNS topic.