« blib/lib/Paws/SNS/SetEndpointAttributes.pm
↑ Summary
blib/lib/Paws/SNS/SetSMSAttributesResponse.pm »
| 1 | |||
| 2 | package Paws::SNS::SetSMSAttributes; | ||
| 3 | use Moose; | ||
| 4 | has Attributes => (is => 'ro', isa => 'Paws::SNS::MapStringToString', traits => ['NameInRequest'], request_name => 'attributes' , required => 1); | ||
| 5 | |||
| 6 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::SNS> | ||
| 18 | |||
| 19 | =head1 DESCRIPTION | ||
| 20 | |||
| 21 | This class represents the parameters used for calling the method SetSMSAttributes on the | ||
| 22 | L<Amazon Simple Notification Service|Paws::SNS> 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 | =head1 SYNOPSIS | ||
| 28 | |||
| 29 | my $sns = Paws->service('SNS'); | ||
| 30 | my $SetSMSAttributesResponse = $sns->SetSMSAttributes( | ||
| 31 | Attributes => { 'MyString' => 'MyString', }, | ||
| 32 | |||
| 33 | ); | ||
| 34 | |||
| 35 | 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. | ||
| 36 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/sns/SetSMSAttributes> | ||
| 37 | |||
| 38 | =head1 ATTRIBUTES | ||
| 39 | |||
| 40 | |||
| 41 | =head2 B<REQUIRED> Attributes => L<Paws::SNS::MapStringToString> | ||
| 42 | |||
| 43 | The default settings for sending SMS messages from your account. You | ||
| 44 | can set values for the following attribute names: | ||
| 45 | |||
| 46 | C<MonthlySpendLimit> E<ndash> The maximum amount in USD that you are | ||
| 47 | willing to spend each month to send SMS messages. When Amazon SNS | ||
| 48 | determines that sending an SMS message would incur a cost that exceeds | ||
| 49 | this limit, it stops sending SMS messages within minutes. | ||
| 50 | |||
| 51 | Amazon SNS stops sending SMS messages within minutes of the limit being | ||
| 52 | crossed. During that interval, if you continue to send SMS messages, | ||
| 53 | you will incur costs that exceed your limit. | ||
| 54 | |||
| 55 | By default, the spend limit is set to the maximum allowed by Amazon | ||
| 56 | SNS. If you want to raise the limit, submit an SNS Limit Increase case | ||
| 57 | (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sns). | ||
| 58 | For B<New limit value>, enter your desired monthly spend limit. In the | ||
| 59 | B<Use Case Description> field, explain that you are requesting an SMS | ||
| 60 | monthly spend limit increase. | ||
| 61 | |||
| 62 | C<DeliveryStatusIAMRole> E<ndash> The ARN of the IAM role that allows | ||
| 63 | Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For | ||
| 64 | each SMS message that you send, Amazon SNS writes a log that includes | ||
| 65 | the message price, the success or failure status, the reason for | ||
| 66 | failure (if the message failed), the message dwell time, and other | ||
| 67 | information. | ||
| 68 | |||
| 69 | C<DeliveryStatusSuccessSamplingRate> E<ndash> The percentage of | ||
| 70 | successful SMS deliveries for which Amazon SNS will write logs in | ||
| 71 | CloudWatch Logs. The value can be an integer from 0 - 100. For example, | ||
| 72 | to write logs only for failed deliveries, set this value to C<0>. To | ||
| 73 | write logs for 10% of your successful deliveries, set it to C<10>. | ||
| 74 | |||
| 75 | C<DefaultSenderID> E<ndash> A string, such as your business brand, that | ||
| 76 | is displayed as the sender on the receiving device. Support for sender | ||
| 77 | IDs varies by country. The sender ID can be 1 - 11 alphanumeric | ||
| 78 | characters, and it must contain at least one letter. | ||
| 79 | |||
| 80 | C<DefaultSMSType> E<ndash> The type of SMS message that you will send | ||
| 81 | by default. You can assign the following values: | ||
| 82 | |||
| 83 | =over | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<Promotional> E<ndash> (Default) Noncritical messages, such as | ||
| 88 | marketing messages. Amazon SNS optimizes the message delivery to incur | ||
| 89 | the lowest cost. | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | C<Transactional> E<ndash> Critical messages that support customer | ||
| 94 | transactions, such as one-time passcodes for multi-factor | ||
| 95 | authentication. Amazon SNS optimizes the message delivery to achieve | ||
| 96 | the highest reliability. | ||
| 97 | |||
| 98 | =back | ||
| 99 | |||
| 100 | C<UsageReportS3Bucket> E<ndash> The name of the Amazon S3 bucket to | ||
| 101 | receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS | ||
| 102 | will deliver a usage report as a CSV file to the bucket. The report | ||
| 103 | includes the following information for each SMS message that was | ||
| 104 | successfully delivered by your account: | ||
| 105 | |||
| 106 | =over | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | Time that the message was published (in UTC) | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | Message ID | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | Destination phone number | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | Message type | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | Delivery status | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | Message price (in USD) | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | Part number (a message is split into multiple parts if it is too long | ||
| 135 | for a single message) | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | Total number of parts | ||
| 140 | |||
| 141 | =back | ||
| 142 | |||
| 143 | To receive the report, the bucket must have a policy that allows the | ||
| 144 | Amazon SNS service principal to perform the C<s3:PutObject> and | ||
| 145 | C<s3:GetBucketLocation> actions. | ||
| 146 | |||
| 147 | For an example bucket policy and usage report, see Monitoring SMS | ||
| 148 | Activity (https://docs.aws.amazon.com/sns/latest/dg/sms_stats.html) in | ||
| 149 | the I<Amazon SNS Developer Guide>. | ||
| 150 | |||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head1 SEE ALSO | ||
| 155 | |||
| 156 | This class forms part of L<Paws>, documenting arguments for method SetSMSAttributes in L<Paws::SNS> | ||
| 157 | |||
| 158 | =head1 BUGS and CONTRIBUTIONS | ||
| 159 | |||
| 160 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 161 | |||
| 162 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 163 | |||
| 164 | =cut | ||
| 165 |