File Coverage

blib/lib/Paws/SNS/SetSMSAttributes.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

line	stmt	sub	time	code
1
2				package Paws::SNS::SetSMSAttributes;
3	1	1	618	use Moose;
	1		3
	1		12
4				has Attributes => (is => 'ro', isa => 'Paws::SNS::MapStringToString', traits => ['NameInRequest'], request_name => 'attributes' , required => 1);
5
6	1	1	7665	use MooseX::ClassAttribute;
	1		3
	1		11
7
8				class_has _api_call => (isa => 'Str', is => 'ro', default => 'SetSMSAttributes');
9				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SNS::SetSMSAttributesResponse');
10				class_has _result_key => (isa => 'Str', is => 'ro', default => 'SetSMSAttributesResult');
11				1;
12
13				### main pod documentation begin ###
14
15				=head1 NAME
16
17				Paws::SNS::SetSMSAttributes - Arguments for method SetSMSAttributes on Paws::SNS
18
19				=head1 DESCRIPTION
20
21				This class represents the parameters used for calling the method SetSMSAttributes on the
22				Amazon Simple Notification Service service. Use the attributes of this class
23				as arguments to method SetSMSAttributes.
24
25				You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetSMSAttributes.
26
27				As an example:
28
29				$service_obj->SetSMSAttributes(Att1 => $value1, Att2 => $value2, ...);
30
31				Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
32
33				=head1 ATTRIBUTES
34
35
36				=head2 B<REQUIRED> Attributes => L<Paws::SNS::MapStringToString>
37
38				The default settings for sending SMS messages from your account. You
39				can set values for the following attribute names:
40
41				C<MonthlySpendLimit> E<ndash> The maximum amount in USD that you are
42				willing to spend each month to send SMS messages. When Amazon SNS
43				determines that sending an SMS message would incur a cost that exceeds
44				this limit, it stops sending SMS messages within minutes.
45
46				Amazon SNS stops sending SMS messages within minutes of the limit being
47				crossed. During that interval, if you continue to send SMS messages,
48				you will incur costs that exceed your limit.
49
50				By default, the spend limit is set to the maximum allowed by Amazon
51				SNS. If you want to exceed the maximum, contact AWS Support or your AWS
52				sales representative for a service limit increase.
53
54				C<DeliveryStatusIAMRole> E<ndash> The ARN of the IAM role that allows
55				Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For
56				each SMS message that you send, Amazon SNS writes a log that includes
57				the message price, the success or failure status, the reason for
58				failure (if the message failed), the message dwell time, and other
59				information.
60
61				C<DeliveryStatusSuccessSamplingRate> E<ndash> The percentage of
62				successful SMS deliveries for which Amazon SNS will write logs in
63				CloudWatch Logs. The value can be an integer from 0 - 100. For example,
64				to write logs only for failed deliveries, set this value to C<0>. To
65				write logs for 10% of your successful deliveries, set it to C<10>.
66
67				C<DefaultSenderID> E<ndash> A string, such as your business brand, that
68				is displayed as the sender on the receiving device. Support for sender
69				IDs varies by country. The sender ID can be 1 - 11 alphanumeric
70				characters, and it must contain at least one letter.
71
72				C<DefaultSMSType> E<ndash> The type of SMS message that you will send
73				by default. You can assign the following values:
74
75				=over
76
77				=item *
78
79				C<Promotional> E<ndash> (Default) Noncritical messages, such as
80				marketing messages. Amazon SNS optimizes the message delivery to incur
81				the lowest cost.
82
83				=item *
84
85				C<Transactional> E<ndash> Critical messages that support customer
86				transactions, such as one-time passcodes for multi-factor
87				authentication. Amazon SNS optimizes the message delivery to achieve
88				the highest reliability.
89
90				=back
91
92				C<UsageReportS3Bucket> E<ndash> The name of the Amazon S3 bucket to
93				receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS
94				will deliver a usage report as a CSV file to the bucket. The report
95				includes the following information for each SMS message that was
96				successfully delivered by your account:
97
98				=over
99
100				=item *
101
102				Time that the message was published (in UTC)
103
104				=item *
105
106				Message ID
107
108				=item *
109
110				Destination phone number
111
112				=item *
113
114				Message type
115
116				=item *
117
118				Delivery status
119
120				=item *
121
122				Message price (in USD)
123
124				=item *
125
126				Part number (a message is split into multiple parts if it is too long
127				for a single message)
128
129				=item *
130
131				Total number of parts
132
133				=back
134
135				To receive the report, the bucket must have a policy that allows the
136				Amazon SNS service principle to perform the C<s3:PutObject> and
137				C<s3:GetBucketLocation> actions.
138
139				For an example bucket policy and usage report, see Monitoring SMS
140				Activity in the I<Amazon SNS Developer Guide>.
141
142
143
144
145				=head1 SEE ALSO
146
147				This class forms part of L<Paws>, documenting arguments for method SetSMSAttributes in L<Paws::SNS>
148
149				=head1 BUGS and CONTRIBUTIONS
150
151				The source code is located here: https://github.com/pplu/aws-sdk-perl
152
153				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
154
155				=cut
156