spend_limits
Creates, updates, deletes, gets or lists a spend_limits resource.
Overview
| Name | spend_limits |
| Type | Resource |
| Id | aws.pinpoint_sms_voice_v2.spend_limits |
Fields
The following fields are returned by SELECT queries:
- describe_spend_limits
| Name | Datatype | Description |
|---|---|---|
enforced_limit | integer (int64) | The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This value has to be less than or equal to the amount in MaxLimit. To use this custom limit, Overridden must be set to true. |
max_limit | integer (int64) | The maximum amount of money that you are able to spend to send messages each month, in US dollars. |
name | string | The name for the SpendLimit. (TEXT_MESSAGE_MONTHLY_SPEND_LIMIT, VOICE_MESSAGE_MONTHLY_SPEND_LIMIT, MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT, NOTIFY_MESSAGE_MONTHLY_SPEND_LIMIT, RCS_MESSAGE_MONTHLY_SPEND_LIMIT) |
overridden | boolean | When set to True, the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_spend_limits | select | region | Describes the current monthly spend limits for sending voice and text messages. When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS, MMS, or Voice spending quota in the End User Messaging SMS User Guide. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_spend_limits
Describes the current monthly spend limits for sending voice and text messages. When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS, MMS, or Voice spending quota in the End User Messaging SMS User Guide.
SELECT
enforced_limit,
max_limit,
name,
overridden
FROM aws.pinpoint_sms_voice_v2.spend_limits
WHERE region = '{{ region }}' -- required
;