deliverability_dashboard_options
Creates, updates, deletes, gets or lists a deliverability_dashboard_options resource.
Overview
| Name | deliverability_dashboard_options |
| Type | Resource |
| Id | aws.pinpoint_email.deliverability_dashboard_options |
Fields
The following fields are returned by SELECT queries:
- get_deliverability_dashboard_options
| Name | Datatype | Description |
|---|---|---|
account_status | string | The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month. (ACTIVE, PENDING_EXPIRATION, DISABLED) |
active_subscribed_domains | array | An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month. |
dashboard_enabled | boolean | Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is true, the dashboard is enabled. |
pending_expiration_subscribed_domains | array | An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month. |
subscription_expiry_date | string (date-time) | The date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_deliverability_dashboard_options | select | region | Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing. | |
put_deliverability_dashboard_option | replace | region, DashboardEnabled | Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing. |
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_deliverability_dashboard_options
Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
SELECT
account_status,
active_subscribed_domains,
dashboard_enabled,
pending_expiration_subscribed_domains,
subscription_expiry_date
FROM aws.pinpoint_email.deliverability_dashboard_options
WHERE region = '{{ region }}' -- required
;
REPLACE examples
- put_deliverability_dashboard_option
Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
REPLACE aws.pinpoint_email.deliverability_dashboard_options
SET
DashboardEnabled = {{ DashboardEnabled }},
SubscribedDomains = '{{ SubscribedDomains }}'
WHERE
region = '{{ region }}' --required
AND DashboardEnabled = {{ DashboardEnabled }} --required;