accounts

Creates, updates, deletes, gets or lists an accounts resource.

Overview

Name	accounts
Type	Resource
Id	aws.sesv2.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.
details	object	An object that defines your account details.
enforcement_status	string	The reputation status of your Amazon SES 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 potential issues with your Amazon SES 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.
pricing_attributes	object	The pricing attributes that apply to your Amazon SES account, including the currently active pricing plan and any scheduled change.
production_access_enabled	boolean	Indicates whether or not your account has production access in the current Amazon Web Services 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. 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 SES account in the current Amazon Web Services Region.
sending_enabled	boolean	Indicates whether or not email sending is enabled for your Amazon SES account in the current Amazon Web Services Region.
suppression_attributes	object	An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.
vdm_attributes	object	The VDM attributes that apply to your Amazon SES account.

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 SES account in the current Amazon Web Services Region.
put_account_details	replace	region, MailType, WebsiteURL		Update your Amazon SES account details.
put_account_pricing_attributes	replace	region, Plan		Set the pricing plan for your Amazon SES account. Use this operation to choose a billing plan that packages multiple Amazon SES features at a single rate.
put_account_vdm_attributes	replace	region, VdmAttributes		Update your Amazon SES account VDM attributes. You can execute this operation no more than once per second.
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.
put_account_suppression_attributes	exec	region		Change the settings for the account-level suppression list.

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 SES account in the current Amazon Web Services Region.

SELECT
dedicated_ip_auto_warmup_enabled,
details,
enforcement_status,
pricing_attributes,
production_access_enabled,
send_quota,
sending_enabled,
suppression_attributes,
vdm_attributes
FROM aws.sesv2.accounts
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_account_details

Update your Amazon SES account details.

REPLACE aws.sesv2.accounts
SET 
MailType = '{{ MailType }}',
WebsiteURL = '{{ WebsiteURL }}',
ContactLanguage = '{{ ContactLanguage }}',
UseCaseDescription = '{{ UseCaseDescription }}',
AdditionalContactEmailAddresses = '{{ AdditionalContactEmailAddresses }}',
ProductionAccessEnabled = {{ ProductionAccessEnabled }}
WHERE 
region = '{{ region }}' --required
AND MailType = '{{ MailType }}' --required
AND WebsiteURL = '{{ WebsiteURL }}' --required;

put_account_pricing_attributes

Set the pricing plan for your Amazon SES account. Use this operation to choose a billing plan that packages multiple Amazon SES features at a single rate.

REPLACE aws.sesv2.accounts
SET 
Plan = '{{ Plan }}'
WHERE 
region = '{{ region }}' --required
AND Plan = '{{ Plan }}' --required;

put_account_vdm_attributes

Update your Amazon SES account VDM attributes. You can execute this operation no more than once per second.

REPLACE aws.sesv2.accounts
SET 
VdmAttributes = '{{ VdmAttributes }}'
WHERE 
region = '{{ region }}' --required
AND VdmAttributes = '{{ VdmAttributes }}' --required;

put_account_dedicated_ip_warmup_attributes

Enable or disable the automatic warm-up feature for dedicated IP addresses.

REPLACE aws.sesv2.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.sesv2.accounts.put_account_sending_attributes 
@region='{{ region }}' --required 
@@json=
'{
"SendingEnabled": {{ SendingEnabled }}
}'
;

put_account_suppression_attributes

Change the settings for the account-level suppression list.

EXEC aws.sesv2.accounts.put_account_suppression_attributes 
@region='{{ region }}' --required 
@@json=
'{
"SuppressedReasons": "{{ SuppressedReasons }}", 
"ValidationAttributes": "{{ ValidationAttributes }}"
}'
;