Customizing email report templates - Amazon QuickSight

Customizing email report templates

   Intended audience: System administrators and Amazon QuickSight administrators 

In Amazon QuickSight, you can customize how dashboard email reports appear and behave for account users. You can customize the sender display name (who the email says it's from), the logo, and the footer that displays in the email. You can also customize where the dashboard opens when recipients click on it in the email report. You can even include a user-friendly name in place of your custom email address, such as Sales, for the email to be from.

Before you can create a custom email report template, make sure you have the appropriate IAM permissions to create and update account customizations, including creating and updating custom email templates. If you plan to use a custom email address to send reports from, such as a company email address, make sure you also have permissions to obtain SES identity attributes. For more information about the permissions you need, and to see an example IAM policy, see IAM identity-based policies for Amazon QuickSight: customizing email report templates.

Important

All customizations apply only to the AWS Region and account that's selected in the QuickSight console.

To create a custom email report template
  1. In QuickSight, choose your user name at upper right, and then choose Manage QuickSight.

    
                        This is an image of the user menu.
  2. In the toolbar at left, choose Account customization.

  3. On the Account customization page that opens, under Email report template, choose Update.

    
                        This is an image of the account customization page.

    The Customize email template page opens with the following options for customizing dashboard reports.

    • Customizing the "Sent from" display name

    • Customizing the logo to display in the email

    • Customizing where the linked dashboard opens

    • Customizing text in the email footer

    The following sections describe each of these options. To create a custom email template that fits your business needs, follow the steps in each section. When you're finished, choose Save.

Customizing the "sent from" display name

You can customize who email reports are from by selecting a "Sent from" display name. This name displays in the "Sent from" line in email reports. You can choose to send emails from and display the QuickSight email address (the default) or a custom email address that you've verified within Amazon Simple Email Service under the same AWS account.

Before you can send email reports from a custom email address, make sure that you set up a verified SES identity for the email address. An SES identity is an email address or domain that your email is sent from. For more information, see Verifying an email address in the Amazon Simple Email Service Developer Guide.

To select a "sent from" display name
  • For Select "Sent from" display name configuration, choose one of the following options:

    • Custom email address within the Simple Email Service (SES) AWS account #111222333. – When you choose this option, you can enter an email address to display in the "Sent from" line in email reports.

      If you choose this option, QuickSight sends email reports for the email address that you provide.

      To use a custom email address, you first confirm that the email address is a verified SES identity. Then you create a custom policy for that identity using the provided authorization policy code in SES, and then verify the authorization policy in QuickSight. You can also provide a user friendly display name (optional) for the email. For more information, see following.

    • QuickSight: no-reply@quicksight.aws – When you select this option, the QuickSight no-reply email address displays in the "Sent from" line in email reports.

Configuring a custom email address for email reports

Use the following procedure to set up a custom email address within your SES account to use for QuickSight email reports.

To set up a custom email address in your SES account for QuickSight email reports
  1. For STEP 1, enter a verified SES email address in the text box, and then choose Verify.

    If the email address has been verified in your SES account, a verification message appears. If it hasn't, go to your SES account and verify the email address. For more information, see Verifying an email address in the Amazon Simple Email Service Developer Guide.

  2. For STEP 2, choose Copy authorization policy, and then do the following:

    1. Choose Go to SES.

    2. Sign in to your SES account and create a custom policy for the email address that you verified in the previous step. You can paste the authorization policy code that you copied from QuickSight in the SES policy editor.

      For more information about creating identity policies in SES, see Creating a custom policy in the Amazon Simple Email Service Developer Guide.

  3. For STEP 3, choose Verify Authorization to verify that the SES identity has authorized QuickSight to send emails on its behalf.

    If it's verified, a verification message appears.

  4. (Optional) For STEP 4, enter a user-friendly name to display in the "Sent from" line in email reports, and then choose Save.

You can choose to display the QuickSight logo in email reports or a custom logo, such as your company logo. You can also choose not to display a logo.

To choose the type of logo to display in the email
  • For Select logo type, choose one of the following options:

    • Custom logo – When you choose this option, you can upload an image to display a custom logo in your email reports. You can customize the logo header background color as well.

      The image you upload must be a JPG, JPEG, or PNG file, and can have a maximum size of 1 MB. When uploaded, the logo automatically resizes to a max height of 32 pixels.

      • To upload an image for the custom logo, choose Upload an image and choose an image file.

        Make sure that the image that you upload is a .jpg, .jpeg, or .png file. The file can have a maximum size of 1 MB. When uploaded, the logo automatically resizes to a maximum height of 32 pixels.

      • To change the header background color, choose the color picker icon, or enter a hexadecimal number in the space provided.

    • QuickSight logo – This is the default logo that displays in email reports unless specified otherwise.

    • No logo – When you choose this option, no logo is displayed in the email.

Customizing where the dashboard opens from the email

Email reports link to dashboards that recipients can view in QuickSight or your application. You can choose where the dashboard opens, or you can hide the dashboard link in the email.

To select where the dashboard opens
  • For Select where the dashboard opens, choose one of the following options:

    • Open in custom application – When you choose this option, users are redirected to your application when they click on the link to the dashboard in the email report.

      • To open the dashboard in your application, enter the URL for your application. You can use parameters in the URL. Any parameters that you add are replaced at runtime with the appropriate information. The following parameters are supported: <<$accountId>>, <<$dashboardId>>, and <<$awsRegion>>.

        For example, let's say that you enter the following URL with parameters:

        https://www.example.com/analytics?account-id=<<$accountId>>&dashboard-id=<<$dashboardId>>&region=<<$awsRegion>>.

        When the email report is sent to subscribers, QuickSight replaces the parameters with the appropriate values at runtime. The URL in the dashboard report email might be similar to the following:

        https://www.example.com/analytics?account-id=111222333&dashboard-id=28ab58b4-8b53-441c-b52b-bc475f620d7f&region=us-west-2.

      • To enter a custom call to action for the dashboard link in the email, enter text for Enter custom call to action text.

    • Open in quicksight.aws.com – When you choose this option, users are redirected to QuickSight when they click on the link to the dashboard in the email report.

    • Hide dashboard link in email – When you choose this option, a link to view the dashboard isn't shown.

To customize the text in the email footer
  • For Select footer type, choose one of the following options:

    • Custom footer – When you choose this option, you can enter a custom footer of up to 500 characters.

    • QuickSight footer – When you choose this option, the following default QuickSight footer is used.

      Sent by <dashboardowner@email.com> from AWS account <accountname>

      A link to unsubscribe is also included.

    • No footer – When you choose this option, no footer message appears in the email.

AWS CloudTrail logs

When you or someone in your account sets up an email template, the following snippet is added to the AWS CloudTrail log as part of the eventName DescribeAccountCustomization and DescribeEmailCustomizationTemplate, and the eventCategory Management.

DescribeAccountCustomization { "eventSource": "quicksight.amazonaws.com", "eventName": "DescribeAccountCustomization", "requestParameters": { "awsAccountId": "111222333", "resolved": false }, "responseElements": null, "eventCategory": "Management" } DescribeEmailCustomizationTemplate { "eventSource": "quicksight.amazonaws.com", "eventName": "DescribeEmailCustomizationTemplate", "requestParameters": { "awsAccountId": "111222333", "emailCustomizationTemplateId": "TemplateId" }, "responseElements": null, eventCategory": "Management" }

When the template is saved, the following snippets are added as part of the eventName for CreateAccountCustomization and CreateEmailCustomizationTemplate.

CreateAccountCustomization { "eventSource": "quicksight.amazonaws.com", "eventName": "CreateAccountCustomization", "requestParameters": { "accountCustomization": { "defaultEmailCustomizationTemplate": "arn:aws:quicksight:us-west-2:111222333:email-customization-template/template-id" }, "awsAccountId": "111222333" }, "responseElements": { "status": 201, "arn": "arn:aws:quicksight:us-west-2:111222333:customization/account/111222333", "awsAccountId": "111222333", "accountCustomization": { "defaultEmailCustomizationTemplate": "arn:aws:quicksight:us-west-2:111222333:email-customization-template/template-id" }, "requestId": "6b6f2ce8-584b-47cb-9f56-4273ab7061a6" }, "eventCategory": "Management" }
CreateEmailCustomizationTemplate { "eventSource": "quicksight.amazonaws.com", "eventName": "CreateEmailCustomizationTemplate", "requestParameters": { "fromEmailAddressCurrentOption": "DEFAULT", "description": "", "awsAccountId": "111222333", "emailCustomizationTemplateId": "template-id", "name": "Email Customization Template", "dashboardLinkCurrentOption": "DEFAULT", "footerCurrentOption": "DEFAULT", "logoCurrentOption": "DEFAULT" }, "responseElements": { "emailCustomizationTemplateId": "template-id", "status": 200, "requestId": "17dea6c9-7811-4ee2-9c79-00c4d376a2c2", "arn": "arn:aws:quicksight:us-west-2:111222333:email-customization-template/template-id" }, "eventCategory": "Management" }

When the template is saved, the following snippets are added as part of the eventName for UpdateAccountCustomization and UpdateEmailCustomizationTemplate.

UpdateAccountCustomization { "eventSource": "quicksight.amazonaws.com", "eventName": "UpdateAccountCustomization", "requestParameters": { "accountCustomization": { "defaultEmailCustomizationTemplate": "arn:aws:quicksight:us-west-2:111222333:email-customization-template/template-id" }, "awsAccountId": "111222333" }, "responseElements": { "status": 200, "arn": "arn:aws:quicksight:us-west-2:111222333:customization/account/111222333", "awsAccountId": "111222333", "accountCustomization": { "defaultEmailCustomizationTemplate": "arn:aws:quicksight:us-west-2:111222333:email-customization-template/template-id" }, "requestId": "6b6f2ce8-584b-47cb-9f56-4273ab7061a6" }, "eventCategory": "Management" }
UpdateEmailCustomizationTemplate { "eventSource": "quicksight.amazonaws.com", "eventName": "UpdateEmailCustomizationTemplate", "requestParameters": { "fromEmailAddressCurrentOption": "DEFAULT", "description": "", "awsAccountId": "111222333", "emailCustomizationTemplateId": "template-id", "name": "Email Customization Template", "dashboardLinkCurrentOption": "DEFAULT", "footerCurrentOption": "DEFAULT", "logoCurrentOption": "DEFAULT" }, "responseElements": { "emailCustomizationTemplateId": "template-id", "status": 200, "requestId": "17dea6c9-7811-4ee2-9c79-00c4d376a2c2", "arn": "arn:aws:quicksight:us-west-2:111222333:email-customization-template/template-id" }, "eventCategory": "Management" }