AWS ses: Add Tenants tab and tenant filtering to VDM dashboard docs
Summary
Documents a new Tenants tab in the SES Virtual Deliverability Manager dashboard, including tenant-level metrics, tenant filtering/compare, drill-down behavior, CSV export, tenant name search in Messages, and a MessageInsightsDataSource export example filtering by TenantName.
Security assessment
The change is purely a feature/documentation update describing tenant-level deliverability metrics and export filtering; it introduces no authentication, encryption, credential, or vulnerability-fix content.
Evidence
+ 10. Choose the **Tenants** tab to display the **Tenants** table.
Diff
diff --git a/ses/latest/dg/vdm-dashboard.md b/ses/latest/dg/vdm-dashboard.md index 942e5039f..e1fd30699 100644 --- a//ses/latest/dg/vdm-dashboard.md +++ b//ses/latest/dg/vdm-dashboard.md @@ -11 +11 @@ Using the dashboard (console)Accessing metric data (AWS CLI)Filtering and export -The dashboard offers high level views of your account’s deliverability program, such as easy to read cards and time series graphs that show deliverability and reputation through open/click and delivery rates and bounce/complaint stats. The dashboard also offers a more detailed view, enabling you to drill down to more detailed specific table data when there’s an issue that's tied to a particular ISP, sending identity, or configuration set that's associated with an email campaign. +The dashboard offers high level views of your account’s deliverability program, such as easy to read cards and time series graphs that show deliverability and reputation through open/click and delivery rates and bounce/complaint stats. The dashboard also offers a more detailed view, enabling you to drill down to more detailed specific table data when there’s an issue that's tied to a particular ISP, sending identity, configuration set, or tenant that's associated with an email campaign. @@ -76 +76 @@ Show moreShow less - 4. The cards, time series graphs, and all of the drill-down tables, _Accounts statistics_ , _ISP_ , _Sending identities_ , and _Configuration sets_ , display metric totals calculated from the date range entered, and use the metric math described in How dashboard metrics are calculated. + 4. The cards, time series graphs, and all of the drill-down tables, _Accounts statistics_ , _ISP_ , _Sending identities_ , _Configuration sets_ , and _Tenants_ , display metric totals calculated from the date range entered, and use the metric math described in How dashboard metrics are calculated. @@ -136 +136,25 @@ Show moreShow less - 10. Choose the **Messages** tab to display the **Messages** table. + 10. Choose the **Tenants** tab to display the **Tenants** table. + +###### Note + +The **Tenants** tab is only applicable if you're managing your email sending through tenants. For more information, see [Tenants](./tenants.html). + + * This table displays metrics for _Send volume_ , _Delivered_ , _Transient & Permanent bounces_, _Complaints_ , _Opens & Clicks_ for each of your tenants as calculated from the date range entered. + + * To filter specific tenants, inside the _Compare tenants_ search box, choose the corresponding check box for each tenant to include. You can also use the sending status filter to list tenants that share a sending status. + + * To drill-down on a specific tenant, choose its name in the **Tenant** column. + + * Cards will appear displaying _Delivery rate_ , _Complaints_ , _Transient & Permanent bounces_, _Open & Click rates_ for the selected tenant as calculated from the date range entered. + + * The time series graphs will refresh displaying all the metrics for the selected tenant as calculated from the date range entered. + + * An ISP table will be displayed listing all the ISPs the tenant sent mail to with metrics given for each ISP as calculated from the date range entered. + + * Tables will be displayed listing the sending identities and configuration sets associated with the tenant, and any reputation findings for the tenant. + + * To create a local `.csv` file of the data you're currently viewing in this table, select its **Export** button. + +Show moreShow less + + 11. Choose the **Messages** tab to display the **Messages** table. @@ -142 +166 @@ This is an interactive table that provides a way for you to search and find your - * In the _Search messages_ field you can filter on _Recipient_ , _From address_ , _Subject line_ , _ISP_ , _Engagement event_ , _Delivery event_ , and _Message ID_ — the following properties apply: + * In the _Search messages_ field you can filter on _Recipient_ , _From address_ , _Subject line_ , _ISP_ , _Tenant name_ , _Engagement event_ , _Delivery event_ , and _Message ID_ — the following properties apply: @@ -360,0 +385,25 @@ If your filtered search returns more than 10,000 messages, the 10,000 messages i + * In this example, the input file is using [`MessageInsightsDataSource`](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_MessageInsightsDataSource.html) parameters to filter on messages sent by the tenant named "example-tenant" that had a last delivery event of "DELIVERY", and a .csv format specified for the output file: + + { + "ExportDataSource": { + "MessageInsightsDataSource": { + "StartDate": "2023-07-01T00:00:00", + "EndDate": "2023-07-10T00:00:00", + "Include": { + "TenantName": [ + "example-tenant" + ], + "LastDeliveryEvent": [ + "DELIVERY" + ] + } + } + }, + "ExportDestination": { + "DataFormat": "CSV" + } + } + + + +