Amazonka.SNS.SetSMSAttributes

Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.

You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Publishing to a mobile phone in the Amazon SNS Developer Guide.

To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action.

Creating a Request

data SetSMSAttributes

The input for the SetSMSAttributes action.

See: newSetSMSAttributes smart constructor.

Constructors

SetSMSAttributes'

Fields

• attributes :: HashMap Text Text

  The default settings for sending SMS messages from your Amazon Web Services account. You can set values for the following attribute names:

  MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.

  Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.

  By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.

  DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.

  DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.

  DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.

  DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:

  • Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
  • Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.

  UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your Amazon Web Services account:

  • Time that the message was published (in UTC)
  • Message ID
  • Destination phone number
  • Message type
  • Delivery status
  • Message price (in USD)
  • Part number (a message is split into multiple parts if it is too long for a single message)
  • Total number of parts

  To receive the report, the bucket must have a policy that allows the Amazon SNS service principal to perform the s3:PutObject and s3:GetBucketLocation actions.

  For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.

Instances

ToHeaders SetSMSAttributes

Defined in Amazonka.SNS.SetSMSAttributes

Methods

toHeaders :: SetSMSAttributes -> [Header]

ToPath SetSMSAttributes

Defined in Amazonka.SNS.SetSMSAttributes

Methods

toPath :: SetSMSAttributes -> ByteString

ToQuery SetSMSAttributes

Defined in Amazonka.SNS.SetSMSAttributes

Methods

toQuery :: SetSMSAttributes -> QueryString

AWSRequest SetSMSAttributes

Defined in Amazonka.SNS.SetSMSAttributes

Associated Types

type AWSResponse SetSMSAttributes

Methods

request :: (Service -> Service) -> SetSMSAttributes -> Request SetSMSAttributes

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SetSMSAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetSMSAttributes)))

Generic SetSMSAttributes

Defined in Amazonka.SNS.SetSMSAttributes

Associated Types

type Rep SetSMSAttributes :: Type -> Type

Methods

from :: SetSMSAttributes -> Rep SetSMSAttributes x

to :: Rep SetSMSAttributes x -> SetSMSAttributes

Read SetSMSAttributes

Defined in Amazonka.SNS.SetSMSAttributes

Methods

readsPrec :: Int -> ReadS SetSMSAttributes

readList :: ReadS [SetSMSAttributes]

readPrec :: ReadPrec SetSMSAttributes

readListPrec :: ReadPrec [SetSMSAttributes]

Show SetSMSAttributes

Defined in Amazonka.SNS.SetSMSAttributes

Methods

showsPrec :: Int -> SetSMSAttributes -> ShowS

show :: SetSMSAttributes -> String

showList :: [SetSMSAttributes] -> ShowS

NFData SetSMSAttributes

Defined in Amazonka.SNS.SetSMSAttributes

Methods

rnf :: SetSMSAttributes -> ()

Eq SetSMSAttributes

Defined in Amazonka.SNS.SetSMSAttributes

Methods

(==) :: SetSMSAttributes -> SetSMSAttributes -> Bool

(/=) :: SetSMSAttributes -> SetSMSAttributes -> Bool

Hashable SetSMSAttributes

Defined in Amazonka.SNS.SetSMSAttributes

Methods

hashWithSalt :: Int -> SetSMSAttributes -> Int

hash :: SetSMSAttributes -> Int

type AWSResponse SetSMSAttributes

Defined in Amazonka.SNS.SetSMSAttributes

type AWSResponse SetSMSAttributes = SetSMSAttributesResponse

type Rep SetSMSAttributes

Defined in Amazonka.SNS.SetSMSAttributes

type Rep SetSMSAttributes = D1 ('MetaData "SetSMSAttributes" "Amazonka.SNS.SetSMSAttributes" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "SetSMSAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))

newSetSMSAttributes :: SetSMSAttributes

Create a value of SetSMSAttributes with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

SetSMSAttributes, setSMSAttributes_attributes - The default settings for sending SMS messages from your Amazon Web Services account. You can set values for the following attribute names:

MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.

Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.

By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.

DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.

DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.

DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.

DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:

• Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
• Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.

UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your Amazon Web Services account:

• Time that the message was published (in UTC)
• Message ID
• Destination phone number
• Message type
• Delivery status
• Message price (in USD)
• Part number (a message is split into multiple parts if it is too long for a single message)
• Total number of parts

To receive the report, the bucket must have a policy that allows the Amazon SNS service principal to perform the s3:PutObject and s3:GetBucketLocation actions.

For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.

Request Lenses

setSMSAttributes_attributes :: Lens' SetSMSAttributes (HashMap Text Text)

The default settings for sending SMS messages from your Amazon Web Services account. You can set values for the following attribute names:

MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.

Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.

By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.

DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.

DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.

DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.

DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:

• Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
• Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.

UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your Amazon Web Services account:

• Time that the message was published (in UTC)
• Message ID
• Destination phone number
• Message type
• Delivery status
• Message price (in USD)
• Part number (a message is split into multiple parts if it is too long for a single message)
• Total number of parts

To receive the report, the bucket must have a policy that allows the Amazon SNS service principal to perform the s3:PutObject and s3:GetBucketLocation actions.

For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.

Destructuring the Response

data SetSMSAttributesResponse

The response for the SetSMSAttributes action.

See: newSetSMSAttributesResponse smart constructor.

Constructors

SetSMSAttributesResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic SetSMSAttributesResponse

Defined in Amazonka.SNS.SetSMSAttributes

Associated Types

type Rep SetSMSAttributesResponse :: Type -> Type

Methods

from :: SetSMSAttributesResponse -> Rep SetSMSAttributesResponse x

to :: Rep SetSMSAttributesResponse x -> SetSMSAttributesResponse

Read SetSMSAttributesResponse

Defined in Amazonka.SNS.SetSMSAttributes

Methods

readsPrec :: Int -> ReadS SetSMSAttributesResponse

readList :: ReadS [SetSMSAttributesResponse]

readPrec :: ReadPrec SetSMSAttributesResponse

readListPrec :: ReadPrec [SetSMSAttributesResponse]

Show SetSMSAttributesResponse

Defined in Amazonka.SNS.SetSMSAttributes

Methods

showsPrec :: Int -> SetSMSAttributesResponse -> ShowS

show :: SetSMSAttributesResponse -> String

showList :: [SetSMSAttributesResponse] -> ShowS

NFData SetSMSAttributesResponse

Defined in Amazonka.SNS.SetSMSAttributes

Methods

rnf :: SetSMSAttributesResponse -> ()

Eq SetSMSAttributesResponse

Defined in Amazonka.SNS.SetSMSAttributes

Methods

(==) :: SetSMSAttributesResponse -> SetSMSAttributesResponse -> Bool

(/=) :: SetSMSAttributesResponse -> SetSMSAttributesResponse -> Bool

type Rep SetSMSAttributesResponse

Defined in Amazonka.SNS.SetSMSAttributes

type Rep SetSMSAttributesResponse = D1 ('MetaData "SetSMSAttributesResponse" "Amazonka.SNS.SetSMSAttributes" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "SetSMSAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSetSMSAttributesResponse

Arguments

:: Int

$sel:httpStatus:SetSMSAttributesResponse'

-> SetSMSAttributesResponse

Create a value of SetSMSAttributesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:SetSMSAttributesResponse', setSMSAttributesResponse_httpStatus - The response's http status code.

Response Lenses

setSMSAttributesResponse_httpStatus :: Lens' SetSMSAttributesResponse Int

The response's http status code.