accounts
Creates, updates, deletes, gets or lists an accounts resource.
Overview
| Name | accounts |
| Type | Resource |
| Id | aws.pinpoint_email.accounts |
Fields
The following fields are returned by SELECT queries:
- get_account
| Name | Datatype | Description |
|---|---|---|
dedicated_ip_auto_warmup_enabled | boolean | Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account. |
enforcement_status | string | The reputation status of your Amazon Pinpoint account. The status can be one of the following: HEALTHY – There are no reputation-related issues that currently impact your account. PROBATION – We've identified some issues with your Amazon Pinpoint account. We're placing your account under review while you work on correcting these issues. SHUTDOWN – Your account's ability to send email is currently paused because of an issue with the email sent from your account. When you correct the issue, you can contact us and request that your account's ability to send email is resumed. |
production_access_enabled | boolean | Indicates whether or not your account has production access in the current AWS Region. If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1. If the value is true, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case. |
send_quota | object | An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region. |
sending_enabled | boolean | Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_account | select | region | Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region. | |
put_account_dedicated_ip_warmup_attributes | replace | region | Enable or disable the automatic warm-up feature for dedicated IP addresses. | |
put_account_sending_attributes | exec | region | Enable or disable the ability of your account to send email. |
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
- get_account
Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
SELECT
dedicated_ip_auto_warmup_enabled,
enforcement_status,
production_access_enabled,
send_quota,
sending_enabled
FROM aws.pinpoint_email.accounts
WHERE region = '{{ region }}' -- required
;
REPLACE examples
- put_account_dedicated_ip_warmup_attributes
Enable or disable the automatic warm-up feature for dedicated IP addresses.
REPLACE aws.pinpoint_email.accounts
SET
AutoWarmupEnabled = {{ AutoWarmupEnabled }}
WHERE
region = '{{ region }}' --required;
Lifecycle Methods
- put_account_sending_attributes
Enable or disable the ability of your account to send email.
EXEC aws.pinpoint_email.accounts.put_account_sending_attributes
@region='{{ region }}' --required
@@json=
'{
"SendingEnabled": {{ SendingEnabled }}
}'
;