| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoT::SnsAction; | ||
| 3 | use Moose; | ||
| 4 | has MessageFormat => (is => 'ro', isa => 'Str', request_name => 'messageFormat', traits => ['NameInRequest']); | ||
| 5 | has RoleArn => (is => 'ro', isa => 'Str', request_name => 'roleArn', traits => ['NameInRequest'], required => 1); | ||
| 6 | has TargetArn => (is => 'ro', isa => 'Str', request_name => 'targetArn', traits => ['NameInRequest'], required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::IoT::SnsAction | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::IoT::SnsAction object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { MessageFormat => $value, ..., TargetArn => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoT::SnsAction object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->MessageFormat | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Describes an action to publish to an Amazon SNS topic. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 MessageFormat => Str | ||
| 44 | |||
| 45 | (Optional) The message format of the message to publish. Accepted | ||
| 46 | values are "JSON" and "RAW". The default value of the attribute is | ||
| 47 | "RAW". SNS uses this setting to determine if the payload should be | ||
| 48 | parsed and relevant platform-specific bits of the payload should be | ||
| 49 | extracted. To read more about SNS message formats, see | ||
| 50 | https://docs.aws.amazon.com/sns/latest/dg/json-formats.html | ||
| 51 | (https://docs.aws.amazon.com/sns/latest/dg/json-formats.html) refer to | ||
| 52 | their official documentation. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> RoleArn => Str | ||
| 56 | |||
| 57 | The ARN of the IAM role that grants access. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> TargetArn => Str | ||
| 61 | |||
| 62 | The ARN of the SNS topic. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head1 SEE ALSO | ||
| 67 | |||
| 68 | This class forms part of L<Paws>, describing an object used in L<Paws::IoT> | ||
| 69 | |||
| 70 | =head1 BUGS and CONTRIBUTIONS | ||
| 71 | |||
| 72 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 73 | |||
| 74 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 75 | |||
| 76 | =cut | ||
| 77 |