File Coverage

blib/lib/Paws/IoT/SnsAction.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


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