id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
amazon-quicksight-user-293 | amazon-quicksight-user.pdf | 293 | explore how RCF is used in other services, see the following: • Amazon Managed Service for Apache Flink SQL Reference: RANDOM_CUT_FOREST and RANDOM_CUT_FOREST_WITH_EXPLANATION References for machine learning and RCF 1050 Amazon QuickSight User Guide • Amazon SageMaker Developer Guide: Random Cut Forest (RCF) Algorithm. This approach is also explained in The Random Cut Forest Algorithm, a chapter in Machine Learning for Business (October 2018). Dataset requirements for using ML insights with Amazon QuickSight To begin using the machine learning capabilities of Amazon QuickSight, you need to connect to or import your data. You can use an existing Amazon QuickSight dataset or create a new one. You can directly query your SQL-compatible source, or ingest the data into SPICE. The data must have the following properties: • At least one metric (for example, sales, orders, shipped units, sign ups, and so on). • At least one category dimension (for example, product category, channel, segment, industry, and so on). Categories with NULL values are ignored. • Anomaly detection requires a minimum of 15 data points for training. For example, if the grain of your data is daily, you need at least 15 days of data. If the grain is monthly, you need at least 15 months of data. • Forecasting work best with more data. Make sure that your dataset has enough historical data for optimal results. For example, if the grain of your data is daily, you need at least 38 days of data. If the grain is monthly, you need at least 43 months of data. Following are the requirements for each time grain: • Years: 32 data points • Quarters: 35 data points • Months: 43 data points • Weeks: 35 data points • Days: 38 data points • Hours: 39 data points • Minutes: 46 data points • Seconds: 46 data points • If you want to analyze anomalies or forecasts, you also need at least one date dimension. Dataset requirements 1051 Amazon QuickSight User Guide If you don't have a dataset to get started, you can download this sample dataset: ML Insights Sample Dataset VI. After you have a dataset ready, create a new analysis from the dataset. Working with insights in Amazon QuickSight In Amazon QuickSight, you can add ready-to-use analytical computations to your analysis as widgets. You can work with insights in two ways: • Suggested insights Amazon QuickSight creates a list of suggested insights based on its interpretation of the data you put into your visuals. The list changes based on context. In other words, you can see different suggestions depending on what fields you add to your visual and what type of visual you choose. For example, if you have a time-series visualization, your insights might include period-over- period changes, anomalies, and forecasts. As you add more visualizations to your analysis, you generate more suggested insights. • Custom insights Custom insights enable you to create your own computation, using your own words to give context to the fields that appear in the widget. When you create a custom insight, you add it to the analysis, and then choose what type of calculation that you want to use. Then, you can add text and formatting to make it look how you want. You can also add more fields, calculations, and parameters. You can add any combination of suggested and custom insights to your analysis, to create the decision-making environment that best serves your purposes. Topics • Adding suggested insights • Adding custom insights to your analysis Adding suggested insights Use the following procedure to add suggested insights to your analysis. Before you begin, make sure that your dataset meets the criteria outlined in Dataset requirements for using ML insights with Amazon QuickSight. Adding insights 1052 Amazon QuickSight User Guide 1. Begin with an analysis that has a few fields added to a visual. 2. On the left, choose Insights. The Insights panel opens and displays a list of ready-to-use suggested insights. Each visual also displays a small box on its top border to display how many insights are available for that visual. You can choose this box to open the Insights panel, and it opens to whatever view you most recently had open. Scroll down to preview more insights. The insights that appear are controlled by the data type of the fields you choose to include in your visual. This list is generated each time you change your visual. If you make changes, check Insights to see what is new. To get a specific insight, see Adding custom insights to your analysis. 3. (Optional) Open the context menu with more options for one of the insights. To do this, choose the ellipses on the top right of the insight (…). Adding suggested insights 1053 Amazon QuickSight User Guide The options are different for each |
amazon-quicksight-user-294 | amazon-quicksight-user.pdf | 294 | down to preview more insights. The insights that appear are controlled by the data type of the fields you choose to include in your visual. This list is generated each time you change your visual. If you make changes, check Insights to see what is new. To get a specific insight, see Adding custom insights to your analysis. 3. (Optional) Open the context menu with more options for one of the insights. To do this, choose the ellipses on the top right of the insight (…). Adding suggested insights 1053 Amazon QuickSight User Guide The options are different for each type of insight. The options that you can interact with include the following: • Change the time series aggregation – To year, quarter, month, week, day, hour, or minute. • Analyze contributions to metrics – Choose contributors and a time frame to analyze. • Show all anomalies – Browse anomalies in this time frame. • Edit forecast – Choose forecast length, prediction interval, and seasonality. • Focus on or Exclude – Zoom in or zoom out on your dimensional data. • Show details – View more information about a recent anomaly (outlier). • Provide feedback on the usefulness of the insight in your analysis. 4. Add a suggested insight to your analysis by choosing the plus sign (+) near the insight title. Adding suggested insights 1054 Amazon QuickSight User Guide 5. (Optional) After you add an insight to your analysis, customize the narrative that you want it to display. To do this, choose the v-shaped on-visual menu, then choose Customize narrative. For more information, see Creating autonarratives with Amazon QuickSight. If your insight is for anomalies (outliers), you can also change the settings for the anomaly detection job. To do this, choose Configure anomaly. For more information, see Setting up ML-powered anomaly detection for outlier analysis. 6. (Optional) To remove the insight from your analysis, choose the v-shaped on-visual menu at the top right of the visual. Then choose Delete. Adding custom insights to your analysis If you don't want to use any of the suggested insights, you can create your own custom insight. Use the following procedure to create a custom computational insight. 1. Start with an existing analysis. On the top menu bar, choose Add+. Then choose Add Insight. A container for the new insight is added to the analysis. The following screen appears. 2. Do one of the following: • Choose the computation that you want to use from the list. As you choose each item, an example of that insight's output displays. When you find the one that you want to use, choose Select. Adding custom insights to your analysis 1055 Amazon QuickSight User Guide • Exit this screen and customize the insight manually. An unconfigured insight has a Customize insight button. Choose the button to open the Configure narrative screen. For more information on using the expression editor, see Creating autonarratives with Amazon QuickSight. Because you are initiating the creation of the insight, it's not based on an existing visual. When the insight is added to the analysis, it displays a note showing what kind of data it needs to complete your request. For example, it might ask for 1 dimension in Time. In this case, you add a dimension to the Time field well. 3. After you have the correct data, follow any remaining screen prompts to finish creating the custom insight. 4. (Optional) To remove the insight from your analysis, choose the v-shaped on-visual menu at the top right of the visual. Then choose Delete. Creating autonarratives with Amazon QuickSight An autonarrative is a natural-language summary widget that displays descriptive text instead of charts. You can embed these widgets throughout your analysis to highlight key insights and callouts. You don't have to sift through the visual, drilling down, comparing values, and rechecking ideas to extract a conclusion. You also don't have to try to understand what the data means, or discuss different interpretations with your colleagues. Instead, you can extrapolate the conclusion from the data, and display it in the analysis, stated plainly. A single interpretation can be shared by everyone. Amazon QuickSight automatically interprets the charts and tables in your dashboard and provides a number of suggested insights in natural language. The suggested insights that you can choose from are ready-made and come with words, calculations, and functions. But you can change them if you want to. You can also design your own. As the author of the dashboard, you have complete flexibility to customize the computations and language for your needs. You can use narratives to effectively tell the story of your data in plain language. Note Narratives are separate from machine learning. They only use ML if you add forecast or anomaly (outlier) computations to them. Autonarratives 1056 User Guide |
amazon-quicksight-user-295 | amazon-quicksight-user.pdf | 295 | provides a number of suggested insights in natural language. The suggested insights that you can choose from are ready-made and come with words, calculations, and functions. But you can change them if you want to. You can also design your own. As the author of the dashboard, you have complete flexibility to customize the computations and language for your needs. You can use narratives to effectively tell the story of your data in plain language. Note Narratives are separate from machine learning. They only use ML if you add forecast or anomaly (outlier) computations to them. Autonarratives 1056 User Guide Amazon QuickSight Topics • Insights that include autonarratives • Use the narrative expression editor • The expression editor workspace • Adding URLs • Working with autonarrative computations Insights that include autonarratives When you are adding an insight, also known as an autonarrative, to your analysis, you can choose from the following templates. In the following list, they are defined by example. Each definition includes a list of the minimum required fields for the autonarrative to work. If you are using only the suggested insights on the Insights tab, choose the appropriate fields to get an insight to show up in the suggested insights list. For more information on customizing autonarratives, see Working with autonarrative computations. • Bottom ranked – For example, the bottom three states by sales revenue. Requires that you have at least one dimension in the Categories field well. • Bottom movers – For example, the bottom three products sold, by sales revenue. Requires that you have at least one dimension in the Time field well and at least one dimension in the Categories field well. • Forecast (ML-powered insight) – For example, "Total sales are forecasted to be $58,613 for Jan 2016." Requires that you have at least one dimension in the Time field well. • Growth rate – For example, "The 3-month compounded growth rate for sales is 22.23%." Requires that you have at least one dimension in the Time field well. • Maximum – For example, "Highest month is Nov 2014 with sales of $112,326." Requires that you have at least one dimension in the Time field well. • Metric comparison – For example, "Total sales for Dec 2014 is $90,474, 10% higher than target of $81,426." Requires that you have at least one dimension in the Time field well and at least two measures in the Values field well. • Minimum – For example, "Lowest month is Feb 2011 with sales of $4,810." Requires that you have at least one dimension in the Time field well. Insights that include autonarratives 1057 Amazon QuickSight User Guide • Anomaly detection (ML-powered insight) – For example, top three outliers and their contributing drivers for total sales on January 3, 2019. Requires that you have at least one dimension in the Time field well, at least one measure in the Values field well, and at least one dimension in the Categories field well. • Period over period – For example, "Total sales for Nov 2014 increased by 44.39% ($34,532) from $77,793 to $112,326." Requires that you have at least one dimension in the Time field well. • Period to date – For example, "Year-to-date sales for Nov 30, 2014 increased by 25.87% ($132,236) from $511,236 to $643,472." Requires that you have at least one dimension in the Time field well. • Top ranked – For example, top three states by sales revenue. Requires that you have at least one dimension in the Categories field well. • Top movers – For example, top products by sales revenue for November 2014. Requires that you have at least one dimension in the Time field well and at least one dimension in the Categories field well. • Total aggregation – For example, "Total revenue is $2,297,200." Requires that you have at least one dimension in the Time field well and at least one measure in the Values field well. • Unique values – For example, "There are 793 unique values in Customer_IDs." Requires that you have at least one dimension in the Categories field well. Use the narrative expression editor The following walkthrough shows an example of how to customize a narrative. For this example, we use a period over period computation type. 1. Begin with an existing analysis. Add a period over period insight to it. The easiest way to do this is to choose the + icon, then Add insight, then choose a type of insight from the list. To learn what type of computational insights you can add as autonarratives, see Insights that include autonarratives. After you choose a type of insight, choose Select to create the widget. To create an empty narrative, close this screen without choosing a template. To follow this example, choose Period over period. If |
amazon-quicksight-user-296 | amazon-quicksight-user.pdf | 296 | For this example, we use a period over period computation type. 1. Begin with an existing analysis. Add a period over period insight to it. The easiest way to do this is to choose the + icon, then Add insight, then choose a type of insight from the list. To learn what type of computational insights you can add as autonarratives, see Insights that include autonarratives. After you choose a type of insight, choose Select to create the widget. To create an empty narrative, close this screen without choosing a template. To follow this example, choose Period over period. If you had a visual selected when you added the insight, the field wells have preconfigured fields for the date, metric, and category. These come from the visualization that you chose when you created the insight. You can customize the fields as needed. Use the narrative expression editor 1058 Amazon QuickSight User Guide You can only customize a narrative for a new or existing insight (text-based) widget. You can't add one to an existing visual (chart based), because it's a different type of widget. 2. Edit the narrative in the expressions editor by choosing the on-visual menu, then choosing Customize narrative. The following screen appears, filling the entire browser window except for the Amazon QuickSight menu. In this context, Computations are predefined calculations (period-over-period, period-to- date, growth rate, max, min, top movers, and so on) that you can reference in your template to describe your data. Currently, Amazon QuickSight supports 13 different types of computations that you can add to your insight. In this example, PeriodOverPeriod is added by default because we chose the Period Over Period template from the suggested insights panel. 3. Choose Add computation at bottom right to add a new computation, and then choose one from the list. For this walkthrough, choose Growth rate, and then choose Next. 4. Configure the computation by choosing the number of periods that you want to compute over. The default is four, and that works for our example. Optionally, you can change the name of the computation at the top of the screen. However, for our purposes, leave the name unchanged. Note The computation names that you create are unique within the insight. You can reference multiple computations of the same type in your narrative template. For example, suppose that you have two metrics, sales revenue and units sold. You can create growth rate computations for each metric if they have different names. Use the narrative expression editor 1059 Amazon QuickSight User Guide However, anomaly computations aren't compatible with any other computation type in the same widget. Anomaly detection must exist in an insight by itself. To use other computations in the same analysis, put them into insights separate from anomalies. To proceed, choose Add. 5. 6. Expand Computations on the right. The computations that are part of the narrative display in the list. In this case, it's PeriodOverPeriod and GrowthRate. In the workspace, add the following text after the final period: Compounded growth rate for the last, then add a space. 7. Next, to add the computation leave your cursor after the space after the word last. On the right, under GrowthRate, choose the expression named timePeriods (click only once to add it). Doing this inserts the expression GrowthRate.timePeriods, which is the number of periods you set in the configuration for GrowthRate. 8. Complete the sentence with days is (a space before and afterwards), and add the expression GrowthRate.compoundedGrowthRate.formattedValue, followed by a period (.). Choose the expression from the list, rather than typing it in. However, you can edit the contents of the expression after you add it. Use the narrative expression editor 1060 Amazon QuickSight Note User Guide The formattedValue expression returns a string that is formatted based on the formatting applied for the metric on the field. To perform metric math, use value instead, which returns the raw value as an integer or decimal. 9. Add a conditional statement and formatting. Place your cursor at the end of the template, after the formattedValue expression. Add a space if necessary. On the Edit narrative menu bar, choose Insert code, and then choose Inline IF from the list. An expression block opens. 10. With the expression block open, choose GrowthRate, compoundedGrowthRate, value from the expression list. Enter >0 at the end of the expression. Choose Save. Don't move your cursor yet. A prompt appears for the conditional content; enter better than expected! Then select the text you just entered, and use the formatting toolbar at the top to turn it green and bold. 11. Add another expression block for the case when the growth rate wasn't that great by repeating the previous step. But this time, make it <0 and enter the text worse than expected. Make it red instead |
amazon-quicksight-user-297 | amazon-quicksight-user.pdf | 297 | block opens. 10. With the expression block open, choose GrowthRate, compoundedGrowthRate, value from the expression list. Enter >0 at the end of the expression. Choose Save. Don't move your cursor yet. A prompt appears for the conditional content; enter better than expected! Then select the text you just entered, and use the formatting toolbar at the top to turn it green and bold. 11. Add another expression block for the case when the growth rate wasn't that great by repeating the previous step. But this time, make it <0 and enter the text worse than expected. Make it red instead of green. 12. Choose Save. The customized narrative that we just created should look similar to the following. The expression editor provides you with a sophisticated tool to customize your narratives. You can also reference the parameters you create for your analysis or dashboard, and use a set of built-in functions for further customization. Tip To create an empty narrative, add an insight using the + icon and then Add insights. But instead of choosing a template, simply close the screen. Use the narrative expression editor 1061 Amazon QuickSight User Guide The best way to get started with customizing narratives is to use the existing templates to learn the syntax. The expression editor workspace Use the expression editor to customize a narrative to best fit your business needs. The information below provides an overview of the expression editor workspace and lists all menu options that can be configured for your narrative. For a walkthrough that shows you how to create a custom narrative, see Use the narrative expression editor. The following screenshot shows a new blank narrative. In this image, the browser window is smaller than usual, so you can see the icons on the menu bar. You can maximize the browser to make the editor as large as your screen. On the right side of the screen, there's a list of items that you can add to the narrative: • Computations – Use this to choose from the computations that are available in this insight. You can expand this list. • Parameters – Use this to choose from the parameters that exist in your analysis. You can expand this list. • Functions – Use this to choose from functions that you can add to a narrative. You can expand this list. The expression editor workspace 1062 Amazon QuickSight User Guide • Add computation – Use this button to create another computation. New computations appear in the Computations list, ready to add to the insight. At the bottom of the narrative expression editor, there's a preview of the narrative that updates as you work. This area also shows an alert if you introduce an error into the narrative or if the narrative is empty. To see a preview of ML-powered insights like anomaly detection or forecasting, run your insight calculation at least once before customizing the narrative. Editing tools are located across the top of the screen. They offer the following options: • Insert code – You can insert the following code blocks from this menu: • Expressions – Add a free-form expression. • Inline IF – Add an IF statement that displays inline with the existing block of text. • Inline FOR – Add a FOR statement that displays inline with the existing block of text. • Block IF – Add an IF statement that displays in a separate block of text. • Block FOR – Add a FOR statement that displays in a separate block of text. The IF and FOR statements enable you to create content that is conditionally formatted. For example, you might add a block IF statement, then configure it to compare an integer to a value from a calculation. To do this, you use the following steps, also demonstrated in Use the narrative expression editor: 1. Open the calculations menu at right, and choose one of the blue highlighted items from one of the calculations. Doing this adds the item to the narrative. 2. Click once on the item to open it. 3. Enter the comparison that you want to make. The expression looks something like this: PeriodOverPeriod.currentMetricValue.value>0. 4. Save this expression in the pop-up editor, which prompts you for Conditional content. 5. Enter what you want to display in the insight, and format it as you want it to appear. Or if you prefer, you can add an image or a URL—or add a URL to an image. • Paragraph – This menu offers options for changes to the font size: • H1 Large header • H2 Header • H3 Small header • ¶1 Large paragraph The expression editor workspace 1063 Amazon QuickSight • ¶2 Paragraph • ¶3 Small paragraph User Guide • Font – Use this menu tray to choose options for |
amazon-quicksight-user-298 | amazon-quicksight-user.pdf | 298 | pop-up editor, which prompts you for Conditional content. 5. Enter what you want to display in the insight, and format it as you want it to appear. Or if you prefer, you can add an image or a URL—or add a URL to an image. • Paragraph – This menu offers options for changes to the font size: • H1 Large header • H2 Header • H3 Small header • ¶1 Large paragraph The expression editor workspace 1063 Amazon QuickSight • ¶2 Paragraph • ¶3 Small paragraph User Guide • Font – Use this menu tray to choose options for text formatting. These include bold, italic, underline, strikethrough, foreground color of the text (the letters themselves), and background color of the text. Choose the icon to turn on an option; choose it again to toggle the option off. • Formatting – Use this menu tray to choose options for paragraph formatting, including bulleted list, left justify, center, and right justify. Choose the icon to turn on an option, choose it again to toggle the option off. • Image – Use this icon add an image URL. The image displays in your insight, provided the link is accessible. You can resize images. To display an image based on a condition, put the image inside an IF block. • URL – Use this icon to add a static or dynamic URL. You can also add URLs to images. For example, you can add traffic light indicator images to an insight for an executive dashboard, with links to a new sheet for red, amber, and green conditions. Adding URLs Using the URL button on the editing menu of the narrative expression editor, you can add static and dynamic URLs (hyperlinks) into a narrative. You can also use the following keyboard shortcuts: ⌘+⇧+L or Ctrl+⇧+L. A static URL is a link that doesn’t change; it always opens the same URL. A dynamic URL is a link that changes based on the expressions or parameters that you provide when you set it up. It's built with dynamically evaluated expressions or parameters. Following are of examples of when you might add a static link in your narrative: • In an IF statement, you might use the URL in the conditional content. If you do and a metric fails to meet an expected value, your link might send the user to a wiki with a list of best practices to improve the metric. • You might use a static URL to create a link to another sheet in the same dashboard, by using the following steps: 1. Go to the sheet that you want to make the link to. 2. Copy that sheet's URL. 3. Return to the narrative editor and create a link using the URL that you just copied. Adding URLs 1064 Amazon QuickSight User Guide Following are examples of when you might add a dynamic link in your narrative: • To search a website with a query, by using the following steps. 1. Create a URL with the following link. https://google.com?q=<<formatDate(now(),'yyyy-MM-dd')>> This link sends a query to Google with search text that is the evaluated value of the following. formatDate(now(), 'yyyy-MM-dd') If the value of now() is 02/02/2020, then the link on your narrative contains https:// google.com?q=2020-02-02. • To create a link that updates a parameter. To do this, create or edit a link and set the URL to the current dashboard or analysis URL. Then add the expression that sets the parameter value to at the end, for example #p.myParameter=12345. Suppose that the following is the dashboard link that you start with. https://us-east-1.quicksight.aws.amazon.com/sn/ analyses/00000000-1111-2222-3333-44444444 If you add a parameter value assignment to it, it looks like the following. https://us-east-1.quicksight.aws.amazon.com/sn/ analyses/00000000-1111-2222-3333-44444444#p.myParameter=12345 For more information on parameters in URLs, see Using parameters in a URL. Working with autonarrative computations Use this section to help you understand what functions are available to you when you are customizing an autonarrative. You only need to customize a narrative if you want to change or build on the default computation. Computations 1065 Amazon QuickSight User Guide After you create an autonarrative, the expression editor opens. You can also activate the expression editor by choosing the on-visual menu, and then Customize Narrative. To add a computation while using the expression editor, choose + Add computation. You can use the following code expression to build your autonarrative. These are available from the list that's labeled Insert code. Code statements can display inline (in a sentence) or as a block (in a list). • Expression – Create your own code expression. • IF – An IF statement that includes an expression after evaluating a condition. • FOR – A FOR statement that loops through values. You can use the following computations to build your autonarrative. You can use the expression editor without |
amazon-quicksight-user-299 | amazon-quicksight-user.pdf | 299 | Customize Narrative. To add a computation while using the expression editor, choose + Add computation. You can use the following code expression to build your autonarrative. These are available from the list that's labeled Insert code. Code statements can display inline (in a sentence) or as a block (in a list). • Expression – Create your own code expression. • IF – An IF statement that includes an expression after evaluating a condition. • FOR – A FOR statement that loops through values. You can use the following computations to build your autonarrative. You can use the expression editor without editing any syntax, but you can also customize it if you want to. To interact with the syntax, open the computational widget in the autonarrative expression editor. Topics • ML-powered anomaly detection for outliers • Bottom movers computation • Bottom ranked computation • ML-powered forecasting • Growth rate computation • Maximum computation • Metric comparison computation • Minimum computation • Period over period computation • Period to date computation • Top movers computation • Top ranked computation • Total aggregation computation • Unique values computation Computations 1066 Amazon QuickSight User Guide ML-powered anomaly detection for outliers The ML-powered anomaly detection computation searches your data for outliers. For example, you can detect the top three outliers for total sales on January 3, 2019. If you enable contribution analysis, you can also detect the key drivers for each outlier. To use this function, you need at least one dimension in the Time field well, at least one measure in the Values field well, and at least one dimension in the Categories field well. The configuration screen provides an option to analyze the contribution of other fields as key drivers, even if those fields aren't in the field wells. For more information, see Detecting outliers with ML-powered anomaly detection. Note You can't add ML-powered anomaly detection to another computation, and you can't add another computation to an anomaly detection. Computation outputs Each function generates a set of output parameters. You can add these outputs to the autonarrative to customize what it displays. You can also add your own custom text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name that you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. You can use items displayed in bold monospace font following in the narrative. • timeField – From the Time field well. • name – The formatted display name of the field. • timeGranularity – The time field granularity (DAY, YEAR, and so on). • categoryFields – From the Categories field well. • name – The formatted display name of the field. • metricField – From the Values field well. • name – The formatted display name of the field. Computations 1067 Amazon QuickSight User Guide • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • itemsCount – The number of items included in this computation. • items – Anomalous items. • timeValue – The values in the date dimension. • value – The date/time field at the point of the anomaly (outlier). • formattedValue – The formatted value in the date/time field at the point of the anomaly. • categoryName – The actual name of the category (cat1, cat2, and so on). • direction – The direction on the x-axis or y-axis that's identified as anomalous: HIGH or LOW. HIGH means "higher than expected." LOW means "lower than expected." When iterating on items, AnomalyDetection.items[index].direction can contain either HIGH or LOW. For example, AnomalyDetection.items[index].direction='HIGH' or AnomalyDetection.items[index].direction=LOW. AnomalyDetection.direction can have an empty string for ALL. An example is AnomalyDetection.direction=''. • actualValue – The metric's actual value at the point of the anomaly or outlier. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • expectedValue – The metric's expected value at the point of the anomaly (outlier). • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. Bottom movers computation The bottom movers computation counts the requested number of categories by date that rank in the bottom of the autonarrative's dataset. For example, you can create a computation to find the bottom three products sold, by sales revenue. To use this function, at least one dimension in the Time field well and at least one dimension in the Categories field well. Computations 1068 Amazon QuickSight Parameters name User Guide A unique descriptive name that you assign or |
amazon-quicksight-user-300 | amazon-quicksight-user.pdf | 300 | formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. Bottom movers computation The bottom movers computation counts the requested number of categories by date that rank in the bottom of the autonarrative's dataset. For example, you can create a computation to find the bottom three products sold, by sales revenue. To use this function, at least one dimension in the Time field well and at least one dimension in the Categories field well. Computations 1068 Amazon QuickSight Parameters name User Guide A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Date The date dimension that you want to rank. Category The category dimension that you want to rank. Value The aggregated measure that the computation is based on. Number of movers The number of ranked results that you want to display. Order by The order that you want to use, percent difference or absolute difference. Computation outputs Each function generates a set of output parameters. You can add these outputs to the autonarrative to customize what it displays. You can also add your own custom text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. Note These are the same output parameters as the ones that are returned by the top movers computation. Computations 1069 Amazon QuickSight User Guide • timeField – From the Time field well. • name – The formatted display name of the field. • timeGranularity – The time field granularity (DAY, YEAR, and so on). • categoryField – From the Categories field well. • name – The formatted display name of the field. • metricField – From the Values field well. • name – The formatted display name of the field. • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • startTimeValue – The value in the date dimension. • value – The raw value. • formattedValue – The value formatted by the datetime field. • endTimeValue – The value in the date dimension. • value – The raw value. • formattedValue – The absolute value formatted by the datetime field. • itemsCount – The number of items included in this computation. • items: Bottom moving items. • categoryField – The category field. • value – The value (contents) of the category field. • formattedValue – The formatted value (contents) of the category field. If the field is null, this displays 'NULL'. If the field is empty, it displays '(empty)'. • currentMetricValue – The current value for the metric field. • value – The raw value. • formattedValue – The value formatted by the metric field • formattedAbsoluteValue – The absolute value formatted by the metric field. • previousMetricValue – The previous value for the metric field. • value – The raw value. • formattedValue – The value formatted by the metric field • formattedAbsoluteValue – The absolute value formatted by the metric field. • percentDifference – The percent difference between the current and previous values of the metric field. • value – The raw value of the calculation of the percent difference. Computations 1070 Amazon QuickSight User Guide • formattedValue – The formatted value of the percent difference (for example, -42%). • formattedAbsoluteValue – The formatted absolute value of the percent difference (for example, 42%). • absoluteDifference – The absolute difference between the current and previous values of the metric field. • value – The raw value of the calculation of the absolute difference. • formattedValue – The absolute difference formatted by the settings in the metric field's format preferences. • formattedAbsoluteValue – The absolute value of the difference formatted by the metric field. Bottom ranked computation The bottom ranked computation calculates the requested number of categories by value that rank in the bottom of the autonarrative's dataset. For example, you can create a computation to find the bottom three states by sales revenue. To use this function, you need at least one dimension in the Categories field well. Parameters name A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Category The category dimension that you want to rank. Value The aggregated measure that the computation is based on. Number of results The number of ranked results that you want to display. Computations 1071 Amazon QuickSight Computation outputs User Guide Each |
amazon-quicksight-user-301 | amazon-quicksight-user.pdf | 301 | autonarrative's dataset. For example, you can create a computation to find the bottom three states by sales revenue. To use this function, you need at least one dimension in the Categories field well. Parameters name A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Category The category dimension that you want to rank. Value The aggregated measure that the computation is based on. Number of results The number of ranked results that you want to display. Computations 1071 Amazon QuickSight Computation outputs User Guide Each function generates a set of output parameters. You can add these outputs to the autonarrative to customize what it displays. You can also add your own custom text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. Note These are the same output parameters as the ones that are returned by the top ranked computation. • categoryField – From the Categories field well. • name – The formatted display name of the field. • metricField – From the Values field well. • name – The formatted display name of the field. • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • itemsCount – The number of items included in this computation. • items: Bottom ranked items. • categoryField – The category field. • value – The value (contents) of the category field. • formattedValue – The formatted value (contents) of the category field. If the field is null, this displays 'NULL'. If the field is empty, it displays '(empty)'. • metricValue – The metric field. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. Computations 1072 Amazon QuickSight Example User Guide The following screenshot shows the default configuration for the bottom-ranked computation. ML-powered forecasting The ML-powered forecast computation forecasts future metrics based on patterns of previous metrics by seasonality. For example, you can create a computation to forecast total revenue for the next six months. To use this function, you need at least one dimension in the Time field well. For more information about working with forecasts, see Forecasting and creating what-if scenarios with Amazon QuickSight. Parameters name A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Date The date dimension that you want to rank. Value The aggregated measure that the computation is based on. Periods forward The number of time periods in the future that you want to forecast. Ranges from 1 to 1,000. Periods backward The number of time periods in the past that you want to base your forecast on. Ranges from 0 to 1,000. Computations 1073 Amazon QuickSight Seasonality User Guide The number of seasons included in the calendar year. The default setting, automatic detects this for you. Ranges from 1 to 180. Computation outputs Each function generates a set of output parameters. You can add these outputs to the autonarrative to customize what it displays. You can also add your own custom text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. • timeField – From the Time field well. • name – The formatted display name of the field. • timeGranularity – The time field granularity (DAY, YEAR, and so on). • metricField – From the Values field well. • name – The formatted display name of the field. • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • metricValue – The value in the metric dimension. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • timeValue – The value in the date dimension. • value – The raw value. • formattedValue – The value formatted by the date field. • relativePeriodsToForecast – The relative number of periods between latest datetime record and last forecast record. Computations 1074 Amazon QuickSight Growth rate computation User Guide |
amazon-quicksight-user-302 | amazon-quicksight-user.pdf | 302 | • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • metricValue – The value in the metric dimension. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • timeValue – The value in the date dimension. • value – The raw value. • formattedValue – The value formatted by the date field. • relativePeriodsToForecast – The relative number of periods between latest datetime record and last forecast record. Computations 1074 Amazon QuickSight Growth rate computation User Guide The growth rate computation compares values over time periods. For example, you can create a computation to find the three-month compounded growth rate for sales, expressed as a percentage. To use this function, you need at least one dimension in the Time field well. Parameters name A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Date The date dimension that you want to rank. Value The aggregated measure that the computation is based on. Number of periods The number of time periods in the future that you want to use to compute the growth rate. Computation outputs Each function generates a set of output parameters. You can add these outputs to the autonarrative to customize what it displays. You can also add your own custom text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. • timeField – From the Time field well. • name – The formatted display name of the field. • timeGranularity – The time field granularity (DAY, YEAR, and so on). Computations 1075 Amazon QuickSight User Guide • metricField – From the Values field well. • name – The formatted display name of the field. • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • previousMetricValue – The previous value in the metric dimension. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • previousTimeValue – The previous value in the datetime dimension. • value – The raw value. • formattedValue – The value formatted by the datetime field. • compoundedGrowthRate – The percent difference between the current and previous values of the metric field. • value – The raw value of the calculation of the percent difference. • formattedValue – The formatted value of the percent difference (for example, -42%). • formattedAbsoluteValue – The formatted absolute value of the percent difference (for example, 42%). • absoluteDifference – The absolute difference between the current and previous values of the metric field. • value – The raw value of the calculation of the absolute difference. • formattedValue – The absolute difference formatted by the settings in the metric field's format preferences. • formattedAbsoluteValue – The absolute value of the difference formatted by the metric field. Maximum computation The maximum computation finds the maximum dimension by value. For example, you can create a computation to find the month with the highest revenue. To use this function, you need at least one dimension in the Time field well. Computations 1076 Amazon QuickSight Parameters name User Guide A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Date The date dimension that you want to rank. Value The aggregated measure that the computation is based on. Computation outputs Each function generates a set of output parameters. You can add these outputs to the autonarrative to customize what it displays. You can also add your own custom text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. Note These are the same output parameters as the ones that are returned by the minimum computation. • timeField – From the Time field well. • name – The formatted display name of the field. • timeGranularity – The time field granularity (DAY, YEAR, and so on). • metricField – From the Values field well. • |
amazon-quicksight-user-303 | amazon-quicksight-user.pdf | 303 | of the computations come from the name you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. Note These are the same output parameters as the ones that are returned by the minimum computation. • timeField – From the Time field well. • name – The formatted display name of the field. • timeGranularity – The time field granularity (DAY, YEAR, and so on). • metricField – From the Values field well. • name – The formatted display name of the field. • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • metricValue – The value in the metric dimension. Computations 1077 Amazon QuickSight • value – The raw value. User Guide • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • timeValue – The value in the datetime dimension. • value – The raw value. • formattedValue – The value formatted by the datetime field. Metric comparison computation The metric comparison computation compares values in different measures. For example, you can create a computation to compare two values, such as actual sales compared to sales goals. To use this function, you need at least one dimension in the Time field well and at least two measures in the Values field well. Parameters name A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Date The date dimension that you want to rank. Value The aggregated measure that the computation is based on. Target value The field that you want to compare to the value. Computation outputs Each function generates a set of output parameters. You can add these outputs to the autonarrative to customize what it displays. You can also add your own custom text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name you Computations 1078 Amazon QuickSight User Guide provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. • timeField – From the Time field well. • name – The formatted display name of the field. • timeGranularity – The time field granularity (DAY, YEAR, and so on). • fromMetricField – From the Values field well. • name – The formatted display name of the field. • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • fromMetricValue – The value in the metric dimension. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • toMetricField – From the Values field well. • name – The formatted display name of the field. • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • toMetricValue – The current value in the metric dimension. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • timeValue – The value in the datetime dimension. • value – The raw value. • formattedValue – The value formatted by the datetime field. • percentDifference – The percent difference between the current and previous values of the metric field. • value – The raw value of the calculation of the percent difference. • formattedValue – The formatted value of the percent difference (for example, -42%). • formattedAbsoluteValue – The formatted absolute value of the percent difference (for example, 42%). • absoluteDifference – The absolute difference between the current and previous values of the metric field. Computations 1079 Amazon QuickSight User Guide • value – The raw value of the calculation of the absolute difference. • formattedValue – The absolute difference formatted by the settings in the metric field's format preferences. • formattedAbsoluteValue – The absolute value of the difference formatted by the metric field. Minimum computation The minimum computation finds the minimum dimension by value. For example, you can create a computation to find the month with the lowest revenue. To use this function, you need at least one dimension in the Time field well. Parameters name A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Date The date dimension that you want to rank. Value The aggregated measure |
amazon-quicksight-user-304 | amazon-quicksight-user.pdf | 304 | in the metric field's format preferences. • formattedAbsoluteValue – The absolute value of the difference formatted by the metric field. Minimum computation The minimum computation finds the minimum dimension by value. For example, you can create a computation to find the month with the lowest revenue. To use this function, you need at least one dimension in the Time field well. Parameters name A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Date The date dimension that you want to rank. Value The aggregated measure that the computation is based on. Computation outputs Each function generates a set of output parameters. You can add these outputs to the autonarrative to customize what it displays. You can also add your own custom text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. Computations 1080 Amazon QuickSight Note User Guide These are the same output parameters as the ones that are returned by the maximum computation. • timeField – From the Time field well. • name – The formatted display name of the field. • timeGranularity – The time field granularity (DAY, YEAR, and so on). • metricField – From the Values field well. • name – The formatted display name of the field. • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • metricValue – The value in the metric dimension. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • timeValue – The value in the datetime dimension. • value – The raw value. • formattedValue – The value formatted by the datetime field. Period over period computation The period over period computation compares values from two different time periods. For example, you can create a computation to find out how much sales increased or decreased since the previous time period. To use this function, you need at least one dimension in the Time field well. Parameters name A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Computations 1081 Amazon QuickSight Date User Guide The date dimension that you want to rank. Value The aggregated measure that the computation is based on. Computation outputs Each function generates a set of output parameters. You can add these outputs to the autonarrative to customize what it displays. You can also add your own custom text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. • timeField – From the Time field well. • name – The formatted display name of the field. • timeGranularity – The time field granularity (DAY, YEAR, and so on). • metricField – From the Values field well. • name – The formatted display name of the field. • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • previousMetricValue – The previous value in the metric dimension. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • previousTimeValue – The previous value in the datetime dimension. • value – The raw value. • formattedValue – The value formatted by the datetime field. • currentMetricValue – The current value in the metric dimension. • value – The raw value. • formattedValue – The value formatted by the metric field. Computations 1082 Amazon QuickSight User Guide • formattedAbsoluteValue – The absolute value formatted by the metric field. • currentTimeValue – The current value in the datetime dimension. • value – The raw value. • formattedValue – The value formatted by the datetime field. • percentDifference – The percent difference between the current and previous values of the metric field. • value – The raw value of the calculation of the percent difference. • formattedValue – The formatted value of the percent difference (for example, -42%). • formattedAbsoluteValue – The formatted absolute value of the percent difference (for example, |
amazon-quicksight-user-305 | amazon-quicksight-user.pdf | 305 | metric field. Computations 1082 Amazon QuickSight User Guide • formattedAbsoluteValue – The absolute value formatted by the metric field. • currentTimeValue – The current value in the datetime dimension. • value – The raw value. • formattedValue – The value formatted by the datetime field. • percentDifference – The percent difference between the current and previous values of the metric field. • value – The raw value of the calculation of the percent difference. • formattedValue – The formatted value of the percent difference (for example, -42%). • formattedAbsoluteValue – The formatted absolute value of the percent difference (for example, 42%). • absoluteDifference – The absolute difference between the current and previous values of the metric field. • value – The raw value of the calculation of the absolute difference. • formattedValue – The absolute difference formatted by the settings in the metric field's format preferences. • formattedAbsoluteValue – The absolute value of the difference formatted by the metric field. Example To create a Period over period computation 1. 2. 3. In the analysis that you want to change, choose Add insight. For Computation type, choose Period over period, and then choose Select. In the new insight that you created, add the time dimenstion and value dimension fields that you want to compare. In the screenshot below, Order Date and Sales (Sum) are added to the insight. With these two fields selected, QuickSight shows the year to date sales of the latest month and the percentage difference compared with the previous month. Computations 1083 Amazon QuickSight User Guide 4. (Optional) To further customize the insight, open the on-visual menu and choose Customize narrative. In the Edit narative window that appears, drag and drop the fields that you need from the Computations list, and then choose Save. Period to date computation The period to date computation evaluates values for a specified period to date. For example, you can create a computation to find out how much you've earned in year-to-date sales. To use this function, you need at least one dimension in the Time field well. Parameters name A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Computations 1084 Amazon QuickSight Date The date dimension that you want to rank. Value The aggregated measure that the computation is based on. Time granularity User Guide The date granularity that you want to use for the computation, for example year to date. Computation outputs Each function generates a set of output parameters. You can add these outputs to the autonarrative to customize what it displays. You can also add your own custom text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. • timeField – From the Time field well. • name – The formatted display name of the field. • timeGranularity – The time field granularity (DAY, YEAR, and so on). • metricField – From the Values field well. • name – The formatted display name of the field. • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • previousMetricValue – The previous value in the metric dimension. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • previousTimeValue – The previous value in the datetime dimension. • value – The raw value. • formattedValue – The value formatted by the datetime field. • currentMetricValue – The current value in the metric dimension. Computations 1085 Amazon QuickSight • value – The raw value. User Guide • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • currentTimeValue – The current value in the datetime dimension. • value – The raw value. • formattedValue – The value formatted by the datetime field. • periodGranularity – The period granularity for this computation (MONTH, YEAR, and so on). • percentDifference – The percent difference between the current and previous values of the metric field. • value – The raw value of the calculation of the percent difference. • formattedValue – The formatted value of the percent difference (for example, -42%). • formattedAbsoluteValue – The formatted absolute value of the percent difference (for example, 42%). • absoluteDifference – The absolute difference between the current and previous values of the metric field. • value – The raw value of the |
amazon-quicksight-user-306 | amazon-quicksight-user.pdf | 306 | value formatted by the datetime field. • periodGranularity – The period granularity for this computation (MONTH, YEAR, and so on). • percentDifference – The percent difference between the current and previous values of the metric field. • value – The raw value of the calculation of the percent difference. • formattedValue – The formatted value of the percent difference (for example, -42%). • formattedAbsoluteValue – The formatted absolute value of the percent difference (for example, 42%). • absoluteDifference – The absolute difference between the current and previous values of the metric field. • value – The raw value of the calculation of the absolute difference. • formattedValue – The absolute difference formatted by the settings in the metric field's format preferences. • formattedAbsoluteValue – The absolute value of the difference formatted by the metric field. Example To create a Period to date computation 1. 2. 3. In the analysis that you want to change, choose Add insight. For Computation type, choose Period to date, and then choose Select. In the new insight that you created, add the time dimenstion and value dimension fields that you want to compare. In the screenshot below, Order Date and Sales (Sum) are added to the insight. With these two fields selected, QuickSight shows the year to date sales of the latest month and the percentage difference compared with the previous month. Computations 1086 Amazon QuickSight User Guide 4. (Optional) To further customize the insight, open the on-visual menu and choose Customize narrative. In the Edit narative window that appears, drag and drop the fields that you need from the Computations list, and then choose Save. Top movers computation The top movers computation counts the requested number of categories by date that rank in the top of the autonarrative's dataset. For example, you can create a computation to find the top products by sales revenue for a time period. To use this function, you need at least one dimension in the Time field well and at least one dimension in the Categories field well. Parameters name A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Computations 1087 User Guide Amazon QuickSight Category The category dimension you want to rank. Value The aggregated measure that the computation is based on. Number of results The number of top ranking items you want to find. Computation outputs Each function generates a set of output parameters. You can add these outputs to the autonarrative to customize what it displays. You can also add your own custom text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. Note These are the same output parameters as the ones that are returned by the bottom movers computation. • timeField – From the Time field well. • name – The formatted display name of the field. • timeGranularity – The time field granularity (DAY, YEAR, and so on). • categoryField – From the Categories field well. • name – The formatted display name of the field. • metricField – From the Values field well. • name – The formatted display name of the field. • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • startTimeValue – The value in the date dimension. • value – The raw value. Computations 1088 Amazon QuickSight User Guide • formattedValue – The value formatted by the datetime field. • endTimeValue – The value in the date dimension. • value – The raw value. • formattedValue – The absolute value formatted by the datetime field. • itemsCount – The number of items included in this computation. • items: Top moving items. • categoryField – The category field. • value – The value (contents) of the category field. • formattedValue – The formatted value (contents) of the category field. If the field is null, this displays 'NULL'. If the field is empty, it displays '(empty)'. • currentMetricValue – The current value for the metric field. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • previousMetricValue – The previous value for the metric field. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • percentDifference – The percent difference between the current and previous values |
amazon-quicksight-user-307 | amazon-quicksight-user.pdf | 307 | field is null, this displays 'NULL'. If the field is empty, it displays '(empty)'. • currentMetricValue – The current value for the metric field. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • previousMetricValue – The previous value for the metric field. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. • percentDifference – The percent difference between the current and previous values of the metric field. • value – The raw value of the calculation of the percent difference. • formattedValue – The formatted value of the percent difference (for example, -42%). • formattedAbsoluteValue – The formatted absolute value of the percent difference (for example, 42%). • absoluteDifference – The absolute difference between the current and previous values of the metric field. • value – The raw value of the calculation of the absolute difference. • formattedValue – The absolute difference formatted by the settings in the metric field's format preferences. • formattedAbsoluteValue – The absolute value of the difference formatted by the metric 1089 Computations field. Amazon QuickSight Top ranked computation User Guide The top ranked computation finds the top ranking dimensions by value. For example, you can create a computation to find the top three states by sales revenue. To use this function, you need at least one dimension in the Categories field well. Parameters name A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Category The category dimension that you want to rank. Value The aggregated measure that the computation is based on. Number of results The number of top ranking items that you want to find. Computation outputs Each function generates a set of output parameters. You can add these outputs to the autonarrative to customize what it displays. You can also add your own custom text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. Note These are the same output parameters as the ones that are returned by the bottom ranked computation. Computations 1090 Amazon QuickSight User Guide • categoryField – From the Categories field well. • name – The formatted display name of the field. • metricField – From the Values field well. • name – The formatted display name of the field. • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • itemsCount – The number of items included in this computation. • items: Top ranked items. • categoryField – The category field. • value – The value (contents) of the category field. • formattedValue – The formatted value (contents) of the category field. If the field is null, this displays 'NULL'. If the field is empty, it displays '(empty)'. • metricValue – The metric field. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. Total aggregation computation The total aggregation computation creates a grand total of the value. For example, you can create a computation to find the total revenue. To use this function, you need at least one dimension in the Time field well and at least one measure in the Values field well. Parameters name A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Value The aggregated measure that the computation is based on. Computations 1091 Amazon QuickSight Computation outputs User Guide Each function generates a set of output parameters. You can add these outputs to the autonarrative to customize what it displays. You can also add your own custom text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. • categoryField – The category field. • name – The display name of the category field. • metricField – From the Values field well. • name – The formatted display name of |
amazon-quicksight-user-308 | amazon-quicksight-user.pdf | 308 | text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. • categoryField – The category field. • name – The display name of the category field. • metricField – From the Values field well. • name – The formatted display name of the field. • aggregationFunction – The aggregation used for the metric (SUM, AVG, and so on). • totalAggregate – The total value of the metric aggregation. • value – The raw value. • formattedValue – The value formatted by the metric field. • formattedAbsoluteValue – The absolute value formatted by the metric field. Unique values computation The unique values computation counts the unique values in a category field. For example, you can create a computation to count the number of unique values in a dimension, such as how many customers you have To use this function, you need at least one dimension in the Categories field well. Parameters name A unique descriptive name that you assign or change. A name is assigned if you don't create your own. You can edit this later. Category The category dimension that you want to rank. Computations 1092 Amazon QuickSight Computation outputs User Guide Each function generates a set of output parameters. You can add these outputs to the autonarrative to customize what it displays. You can also add your own custom text. To locate the output parameters, open the Computations tab on the right, and locate the computation that you want to use. The names of the computations come from the name you provide when you create the insight. Choose the output parameter by clicking on it only once. If you click twice, you add the same output twice. Items displayed in bold can be used in the narrative. • categoryField – The category field. • name – The display name of the category field. • uniqueGroupValuesCount – The number of unique values included in this computation. Detecting outliers with ML-powered anomaly detection Amazon QuickSight uses proven Amazon technology to continuously run ML-powered anomaly detection across millions of metrics to discover hidden trends and outliers in your data. This tool allows you to get deep insights that are often buried in the aggregates and not scalable with manual analysis. With ML-powered anomaly detection, you can find outliers in your data without the need for manual analysis, custom development, or ML domain expertise. Amazon QuickSight notifies you in your visuals if it detects that you can analyze an anomaly or do some forecasting on your data. Anomaly detection is not available in the eu-central-2 Europe (Zurich) region. Important ML-powered anomaly detection is a compute-intense task. Before you start using it, you can get an idea of costs by analyzing the amount of data that you want to use. We offer a tiered pricing model that is based on the number of metrics you process per month. To learn more about usage-based pricing, see Amazon QuickSight Pricing. Topics • Concepts for anomaly or outlier detection Detecting outliers 1093 Amazon QuickSight User Guide • Setting up ML-powered anomaly detection for outlier analysis • Exploring outliers and key drivers with ML-powered anomaly detection and contribution analysis Concepts for anomaly or outlier detection Amazon QuickSight uses the word anomaly to describe data points that fall outside an overall pattern of distribution. There are many other words for anomalies, which is a scientific term, including outliers, deviations, oddities, exceptions, irregularities, quirks, and many more. The term that you use might be based on the type of analysis you do, or the type of data you use, or even just the preference of your group. These outlying data points represent an entity—a person, place, thing, or time—which is exceptional in some way. Humans easily recognize patterns and spot things that aren't like the others. Our senses provide this information for us. If the pattern is simple, and there is only a little data, you can easily make a graph to highlight the outliers in your data. Some simple examples include the following: • A red balloon in a group of blue ones • A racehorse that is far ahead of the others • A kid who isn't paying attention during class • A day when online orders are up, but shipping is down • A person who got well, where others didn't Some data points represent a significant event, and others represent a random occurrence. Analysis uncovers which data is worth investigating, based on what driving factors (key drivers) contributed |
amazon-quicksight-user-309 | amazon-quicksight-user.pdf | 309 | a little data, you can easily make a graph to highlight the outliers in your data. Some simple examples include the following: • A red balloon in a group of blue ones • A racehorse that is far ahead of the others • A kid who isn't paying attention during class • A day when online orders are up, but shipping is down • A person who got well, where others didn't Some data points represent a significant event, and others represent a random occurrence. Analysis uncovers which data is worth investigating, based on what driving factors (key drivers) contributed to the event. Questions are essential to data analysis. Why did it happen? What's it related to? Did it happen only once or many times? What can you do to encourage or discourage more like it? Understanding how and why a variation exists, and whether there is a pattern in the variations, requires more thought. Without the assistance of machine learning, each person might come to a different conclusion, because they have different experience and information. Therefore, each person might make a slightly different business decision. If there is a lot of data or variables to consider, it can require an overwhelming amount of analysis. ML-powered anomaly detection identifies the causations and correlations to enable you to make data-driven decisions. You still have control over defining how you want the job to work on your data. You can specify your own parameters, and choose additional options, such as identifying key Concepts for anomaly or outlier detection 1094 Amazon QuickSight User Guide drivers in a contribution analysis. Or you can use the default settings. The following section walks you through the setup process, and provides explanations for the options available. Setting up ML-powered anomaly detection for outlier analysis Use procedures in the following sections to start detecting outliers, detecting anomalies, and identifying the key drivers that contribute to them. Topics • Viewing anomaly and forecast notifications • Adding an ML insight to detect outliers and key drivers • Using contribution analysis for key drivers Viewing anomaly and forecast notifications Amazon QuickSight notifies you on a visual where it detects an anomaly, key drivers, or a forecasting opportunity. You can follow the prompts to set up anomaly detection or forecasting based on the data in that visual. 1. In an existing line chart, look for an insight notification in the menu on the visual widget. 2. Choose the lightbulb icon to display the notification, as shown in the following screenshot. 3. If you want more information about the ML insight, you can follow the screen prompts to add an ML insight. Adding an ML insight to detect outliers and key drivers You can add an ML insight that detects anomalies, which are outliers that seem significant. To get started, you create for your insight a widget, also known as an autonarrative. As you configure your options, you can view a limited screenshot of your insight in the Preview pane at screen right. In your insight widget, you can add up to five dimension fields that are not calculated fields. In the field wells, values for Categories represent the dimensional values that Amazon QuickSight uses to split the metric. For example, let's say that you are analyzing revenue across all product Setting up ML-powered anomaly detection for outlier analysis 1095 Amazon QuickSight User Guide categories and product SKUs. There are 10 product categories, each with 10 product SKUs. Amazon QuickSight splits the metric by the 100 unique combinations and runs anomaly detection on each combination for the split. The following procedure shows how to do this, and also how to add contribution analysis to detect the key drivers that are causing each anomaly. You can add contribution analysis later, as described in Using contribution analysis for key drivers. To set up outlier analysis, including key drivers 1. Open your analysis and in the toolbar, choose Insights, then Add. From the list, choose Anomaly detection and Select. 2. Follow the screen prompt on the new widget, which tells you to choose fields for the insight. Add at least one date, one measure, and one dimension. 3. Choose Get started on the widget. The configuration screen appears. 4. Under Compute options, choose values for the following options. a. For Combinations to be analysed, choose one of the following options: i. Hierarchical Choose this option if you want to analyze the fields hierarchically. For example, if you chose a date (T), a measure (N), and three dimension categories (C1, C2, and C3), QuickSight analyses the fields hierarchically, as shown following. T-N, T-C1-N, T-C1-C2-N, T-C1-C2-C3-N ii. Exact Choose this option if you want to analyze only the exact combination of fields in the Category field well, as they are listed. For example, if you chose a date |
amazon-quicksight-user-310 | amazon-quicksight-user.pdf | 310 | screen appears. 4. Under Compute options, choose values for the following options. a. For Combinations to be analysed, choose one of the following options: i. Hierarchical Choose this option if you want to analyze the fields hierarchically. For example, if you chose a date (T), a measure (N), and three dimension categories (C1, C2, and C3), QuickSight analyses the fields hierarchically, as shown following. T-N, T-C1-N, T-C1-C2-N, T-C1-C2-C3-N ii. Exact Choose this option if you want to analyze only the exact combination of fields in the Category field well, as they are listed. For example, if you chose a date (T), a measure (N), and three dimension categories (C1, C2, and C3), QuickSight analyses only the exact combination of category fields in the order they are listed, as shown following. T-C1-C2-C3-N iii. All Choose this option if you want to analyze all field combinations in the Category field well. For example, if you chose a date (T), a measure (N), and three dimension Setting up ML-powered anomaly detection for outlier analysis 1096 Amazon QuickSight User Guide categories (C1, C2, and C3), QuickSight analyses all combinations of fields, as shown following. T-N, T-C1-N, T-C1-C2-N, T-C1-C2-C3-N, T-C1-C3-N, T-C2-N, T-C2-C3-N, T-C3-N If you chose a date and a measure only, QuickSight analyses the fields by date and then by measure. In the Fields to be analyzed section, you can see a list of fields from the field wells for reference. b. For Name, enter a descriptive alphanumeric name with no spaces, or choose the default value. This provides a name for the computation. If you plan on editing the narrative that automatically displays on the widget, you can use the name to identify this widget's calculation. Customize the name if you plan to edit the autonarrative and if you have other similar calculations in your analysis. 5. In the Display options section, choose the following options to customize what is displayed in your insight widget. You can still explore all your results, no matter what you display. a. Maximum number of anomalies to show – The number of outliers you want to display in the narrative widget. b. Severity – The minimum level of severity for anomalies that you want to display in the insight widget. A level of severity is a range of anomaly scores that is characterized by the lowest actual anomaly score included in the range. All anomalies that score higher are included in the range. If you set severity to Low, the insight displays all of the anomalies that rank between low and very high. If you set the severity to Very high, the insight displays only the anomalies that have the highest anomaly scores. You can use the following options: • Very high • High and above • Medium and above • Low and above Setting up ML-powered anomaly detection for outlier analysis 1097 Amazon QuickSight User Guide c. Direction – The direction on the x-axis or y-axis that you want to identify as anomalous. You can choose from the following: • Higher than expected to identify higher values as anomalies. • Lower than expected to identify lower values as anomalies. • [ALL] to identify all anomalous values, high and low (default setting). d. Delta – Enter a custom value to use to identify anomalies. Any amount higher than the threshold value counts as an anomaly. The values here change how the insight works in your analysis. In this section, you can set the following: • Absolute value – The actual value to use. For example, suppose this is 48. Amazon QuickSight then identifies values as anomalous when the difference between a value and the expected value is greater than 48. • Percentage – The percentage threshold to use. For example, suppose this is 12.5%. Amazon QuickSight then identifies values as anomalous when the difference between a value and the expected value is greater than 12.5%. e. Sort by – Choose a sort method for your results. Some methods are based on the anomaly score that Amazon QuickSight generates. Amazon QuickSight gives higher scores to data points that look anomalous. You can use any of the following options: • Weighted anomaly score – The anomaly score multiplied by the log of the absolute value of the difference between the actual value and the expected value. This score is always a positive number. • Anomaly score – The actual anomaly score assigned to this data point. • Weighted difference from expected value – The anomaly score multiplied by the difference between the actual value and the expected value (default). • Difference from expected value – The actual difference between the actual value and the expected value (that is, actual−expected). • Actual value – The actual value with no formula applied. 6. In the Schedule options section, set the schedule |
amazon-quicksight-user-311 | amazon-quicksight-user.pdf | 311 | the log of the absolute value of the difference between the actual value and the expected value. This score is always a positive number. • Anomaly score – The actual anomaly score assigned to this data point. • Weighted difference from expected value – The anomaly score multiplied by the difference between the actual value and the expected value (default). • Difference from expected value – The actual difference between the actual value and the expected value (that is, actual−expected). • Actual value – The actual value with no formula applied. 6. In the Schedule options section, set the schedule for automatically running the insight recalculation. The schedule runs only for published dashboards. In the analysis, you can run it manually as needed. Scheduling includes the following settings: • Occurrence – How often that you want the recalculation to run: every hour, every day, every week, or every month. Setting up ML-powered anomaly detection for outlier analysis 1098 Amazon QuickSight User Guide • Start schedule on – The date and time to start running this schedule. • Timezone – The time zone that the schedule runs in. To view a list, delete the current entry. 7. In the Top contributors section, set Amazon QuickSight to analyze the key drivers when an outlier (anomaly) is detected. For example, Amazon QuickSight can show the top customers that contributed to a spike in sales in the US for home improvement products. You can add up to four dimensions from your dataset. These include dimensions that you didn't add to the field wells of this insight widget. For a list of dimensions available for contribution analysis, choose Select fields. 8. Choose Save to confirm your choices. Choose Cancel to exit without saving. 9. From the insight widget, choose Run now to run the anomaly detection and view your insight. The amount of time that anomaly detecton takes to complete varies depending on how many unique data points you are analyzing. The process can take a few minutes for a minimum number of points, or it can take many hours. While it's running in the background, you can do other work in your analysis. Make sure to wait for it to complete before you change the configuration, edit the narrative, or open the Explore anomalies page for this insight. The insight widget needs to run at least once before you can see results. If you think the status might be out of date, you can refresh the page. The insight can have the following states. Appears on the Page Status Run now button The job has not yet started. Message about Analyzing for anomalies The job is currently running. Narrative about the detected anomalies (outliers) Alert icon with an exclamation point (!) The job has run successfully. The message says when this widget's calculation was last updated. This icon indicates there was an error during the last run. If the narrative also displays, you Setting up ML-powered anomaly detection for outlier analysis 1099 Amazon QuickSight User Guide Appears on the Page Status can still use Explore anomalies to use data from the previous successful run. Using contribution analysis for key drivers Amazon QuickSight can identify the dimensions (categories) that contribute to outliers in measures (metrics) between two points in time. The key driver that contributes to an outlier helps you to answer the question: What happened to cause this anomaly? If you are already using anomaly detection without contribution analysis, you can enable the existing ML insight to find key drivers. Use the following procedure to add contribution analysis and identify the key drivers behind outliers. Your insight for anomaly detection needs to include a time field and at least one aggregated metric (SUM, AVERAGE, or COUNT). You can include multiple categories (dimension fields) if you wish, but you can also run contribution analysis without specifying any category or dimension field. You can also use this procedure to change or remove fields as key drivers in your anomaly detection. To add contribution analysis to identify key drivers 1. Open your analysis and locate an existing ML insight for anomaly detection. Select the insight widget to highlight it. 2. Choose Menu Options (…) from the menu on the visual. 3. Choose Configure anomaly to edit the settings. 4. The Contribution analysis (optional) setting allows Amazon QuickSight to analyze the key drivers when an outlier (anomaly) is detected. For example, Amazon QuickSight can show you the top customers that contributed to a spike in sales in the US for home improvement products. You can add up to four dimensions from your dataset, including dimensions that you didn't add to the field wells of this insight widget. To view a list of dimensions available for contribution analysis, choose Select fields. If you want to change the fields you're |
amazon-quicksight-user-312 | amazon-quicksight-user.pdf | 312 | on the visual. 3. Choose Configure anomaly to edit the settings. 4. The Contribution analysis (optional) setting allows Amazon QuickSight to analyze the key drivers when an outlier (anomaly) is detected. For example, Amazon QuickSight can show you the top customers that contributed to a spike in sales in the US for home improvement products. You can add up to four dimensions from your dataset, including dimensions that you didn't add to the field wells of this insight widget. To view a list of dimensions available for contribution analysis, choose Select fields. If you want to change the fields you're using as key drivers, change the fields that are enabled in this list. If you disable all of them, QuickSight won't perform any contribution analysis in this insight. Setting up ML-powered anomaly detection for outlier analysis 1100 Amazon QuickSight User Guide 5. To save your changes, scroll to the bottom of the configuration options, and choose Save. To exit without saving, choose Cancel. To completely remove these settings, choose Delete. Exploring outliers and key drivers with ML-powered anomaly detection and contribution analysis You can interactively explore the anomalies (also known as outliers) in your analysis, along with the contributors (key drivers). The analysis is available for you to explore after the ML-powered anomaly detection runs. The changes you make in this screen aren't saved when you go back to the analysis. To begin, choose Explore anomalies in the insight. The following screenshot shows the anomalies screen as it appears when you first open it. In this example, contributors analysis is set up and shows two key drivers. The sections of the screen include the following, from top left to bottom right: Exploring outliers and key drivers 1101 Amazon QuickSight User Guide • Contributors displays key drivers. To see this section, you need to have contributors set up in your anomaly configuration. • Controls contains settings for anomaly exploration. • Number of anomalies displays outliers detected over time. You can hide or show this chart section. • Your field names for category or dimension fields act as titles for charts that show anomalies for each category or dimension. The following sections provide detailed information for each aspect of exploring anomalies. Topics • Exploring contributors (key drivers) • Setting controls for anomaly detection • Showing and hiding anomalies by date • Exploring anomalies per category or dimension Exploring contributors (key drivers) If your anomaly insight is set up to detect key drivers, QuickSight runs the contribution analysis to determine which categories (dimensions) are influencing the outliers. The Contributors section appears on the left. Exploring outliers and key drivers 1102 Amazon QuickSight User Guide Contributors contains the following sections: • Narrative – At top left, a summary describes any changes in the metrics. • Top contributors configuration – Choose Configure to change the contributors and the date range to use in this section. Exploring outliers and key drivers 1103 Amazon QuickSight User Guide • Sort by – Sets the sort applied to the results that appear below. You can choose from the following: • Absolute difference • Contribution percentage (default) • Deviation from expected • Percentage difference • Top contributor results – Displays the results of the top contributor analysis for the point in time selected on the timeline at right. Contribution analysis identifies up to four of the top contributing factors or key drivers of an anomaly. For example, Amazon QuickSight can show you the top customers that contributed to a spike in sales in the US for health products. This panel appears only if you choose to include fields in contribution analysis when you configure the anomaly. If you don't see this panel and you want to display it, you can turn it on. To do so, go to the analysis, choose anomaly configuration from the insight's menu, and choose up to four fields to analyze for contributions. If you make changes in the sheet controls that exclude the contributing drivers, the Contributions panel closes. Setting controls for anomaly detection You can find the settings for anomaly detection in the Controls section of the screen. You can open and close this section by clicking the word Controls. The settings include the following: Exploring outliers and key drivers 1104 Amazon QuickSight User Guide • Controls – The current settings appear at the top of the workspace. You can expand this section by choosing the double arrow icon on the right side. The following settings are available for exploring outliers generated by ML-powered anomaly detection: • Severity – Sets how sensitive your detector is to detected anomalies (outliers). You should expect to see more anomalies with the threshold set to Low and above, and fewer anomalies when the threshold is set to High and above. This sensitivity is determined based on standard deviations |
amazon-quicksight-user-313 | amazon-quicksight-user.pdf | 313 | following: Exploring outliers and key drivers 1104 Amazon QuickSight User Guide • Controls – The current settings appear at the top of the workspace. You can expand this section by choosing the double arrow icon on the right side. The following settings are available for exploring outliers generated by ML-powered anomaly detection: • Severity – Sets how sensitive your detector is to detected anomalies (outliers). You should expect to see more anomalies with the threshold set to Low and above, and fewer anomalies when the threshold is set to High and above. This sensitivity is determined based on standard deviations of the anomaly score generated by the RCF algorithm. The default is Medium and above. • Direction – The direction on the x-axis or y-axis that you want to identify as anomalous. The default is [ALL]. You can choose the following: • Set to Higher than expected to identify higher values as anomalies. • Set to Lower than expected to identify lower values as anomalies. • Set to [ALL] to identify all anomalous values, both high and low. • Minimum Delta - absolute value – Enter a custom value to use to as the absolute threshold to identify anomalies. Any amount higher than this value counts as an anomaly. • Minimum Delta - percentage – Enter a custom value to use to as the percentage threshold to identify anomalies. Any amount higher than this value counts as an anomaly. • Sort by – Choose the method that you want to apply to sorting anomalies. These are listed in preferred order on the screen. View the following list for a description of each method. • Weighted anomaly score – The anomaly score multiplied by the log of the absolute value of the difference between the actual value and the expected value. This score is always a positive number. • Anomaly score – The actual anomaly score assigned to this data point. • Weighted difference from expected value – (Default) The anomaly score multiplied by the difference between the actual value and the expected value. • Difference from expected value – The actual difference between the actual value and the expected value (actual−expected). • Actual value – The actual value with no formula applied. • Categories – One or more settings can appear at the end of the other settings. There is one for each category field that you added to the category field well. You can use category settings to limit the data that displays in the screen. Exploring outliers and key drivers 1105 Amazon QuickSight User Guide Showing and hiding anomalies by date The Number of anomalies chart shows outliers detected over time. If you don't see this chart, you can display it by choosing SHOW ANOMALIES BY DATE. This chart shows anomalies (outliers) for the most recent data point in the time series. When expanded, it displays the following components: • Anomalies – The middle of the screen displays the anomalies for the most recent data point in the time series. One or more graphs appear with a chart showing variations in a metric over time. To use this graph, select a point along the timeline. The currently selected point in time is highlighted in the graph, and includes a menu offering you the option to analyze contributions to the current metric. You can also drag the cursor over the timeline without choosing a specific point to display the metric value for that point in time. • Anomalies by date – If you choose SHOW ANOMALIES BY DATE, another graph appears that shows how many significant anomalies there were for each time point. You can see details in this chart on each bar's context menu. • Timeline adjustment – Each graph has a timeline adjustor tool below the dates, which you can use to compress, expand, or choose a period of time to view. Exploring anomalies per category or dimension The main section of the Explore anomalies screen is locked to the lower right of the screen. It remains here no matter how many other sections of the screen are open. If multiple anomalies exist, you can scroll out to highlight them. The chart displays anomalies in color ranges and shows where they occur over a period of time. Exploring outliers and key drivers 1106 Amazon QuickSight User Guide Each category or dimension has a separate chart that uses the field name as the chart title. Each chart contains the following components: • Configure alerts – If you are exploring anomalies from a dashboard, select this button to subscribe to alerts and contribution analysis (if configured). You can set up the alerts for the level of severity (medium, high, and so on). You can get the top five alerts for Higher than expected, Lower than expected, or ALL. Dashboard |
amazon-quicksight-user-314 | amazon-quicksight-user.pdf | 314 | and shows where they occur over a period of time. Exploring outliers and key drivers 1106 Amazon QuickSight User Guide Each category or dimension has a separate chart that uses the field name as the chart title. Each chart contains the following components: • Configure alerts – If you are exploring anomalies from a dashboard, select this button to subscribe to alerts and contribution analysis (if configured). You can set up the alerts for the level of severity (medium, high, and so on). You can get the top five alerts for Higher than expected, Lower than expected, or ALL. Dashboard readers can configure alerts for themselves. If you open the Explore Anomalies page doesn't display this button if you opened the page from an analysis. Note The ability to configure alerts is available only in published dashboards. • Status – Under the Anomalies header, the status label displays information on the last run. For example, you might see "Anomalies for Revenue on November 17, 2018." This label tells you how many metrics were processed and how long ago. You can choose the link to learn more about the details, such as how many metrics were ignored. Forecasting and creating what-if scenarios with Amazon QuickSight Using ML-powered forecasting, you can forecast your key business metrics with point-and- click simplicity. No machine learning expertise is required. The built-in ML algorithm in Amazon QuickSight is designed to handle complex real-world scenarios. Amazon QuickSight uses machine learning to help provide more reliable forecasts than available by traditional means. For example, suppose that you are a business manager. Suppose that you want to forecast sales to see if you are going to meet your goal by the end of the year. Or, suppose that you expect a large ML-powered forecasts and what-ifs 1107 Amazon QuickSight User Guide deal to come through in two weeks and you want to know how it's going to affect your overall forecast. You can forecast your business revenue with multiple levels of seasonality (for example, sales with both weekly and quarterly trends). Amazon QuickSight automatically excludes anomalies in the data (for example, a spike in sales due to price drop or promotion) from influencing the forecast. You also don't have to clean and reprep the data with missing values because Amazon QuickSight automatically handles that. In addition, with ML-powered forecasting, you can perform interactive what-if analyses to determine the growth trajectory you need to meet business goals. Using forecasts and what-if scenarios You can add a forecasting widget to your existing analysis, and publish it as a dashboard. To analyze what-if scenarios, use an analysis, not a dashboard. With ML-powered forecasting, Amazon QuickSight enables you to forecast complex, real-world scenarios such as data with multiple seasonality. It automatically excludes outliers that it identifies and imputes missing values. Use the following procedure to add a graphical forecast to your analysis, and explore what-if scenarios. Although the following procedure is for graphical forecasting, you can also add a forecast as a narrative in an insight widget. To learn more, see Creating autonarratives with Amazon QuickSight. To add a graphical forecast to your analysis 1. Create a visual that uses a single date field and up to three metrics (measures). 2. On the menu in the upper-right corner of the visual, choose the Menu options icon (the three dots), and then choose Add forecast. Using forecasts and what-if scenarios 1108 Amazon QuickSight User Guide QuickSight automatically analyzes the historical data using ML, and displays a graphical forecast for the next 14 periods. Forecast properties apply to all metrics in your visual. If you want individual forecasts for each metric, consider creating a separate visual for each metric and adding a forecast to each. Using forecasts and what-if scenarios 1109 Amazon QuickSight User Guide 3. On the Forecast properties panel at left, customize one or more of the following settings: • Forecast length – Set Periods forward to forecast, or set Periods backward to look for patterns to base the forecast on. • Prediction interval – Set the estimated range for the forecast. Doing this changes how wide the band of possibility is around the predicted line. • Seasonality – Set the number of time periods involved in the predictable seasonal pattern of data. The range is 1–180, and the default setting is Automatic. • Forecast boundaries – Set a minimum and/or maximum forecast value to prevent forecast values from going above or below a specified value. For example, if your forecasting predicts the number of new hires the company will make in the next month to be in the negative numbers, you can set a forecast boundary minimum to zero. This stops the forecasted values from ever going below zero. To save your changes, choose Apply. Using forecasts and what-if scenarios 1110 Amazon |
amazon-quicksight-user-315 | amazon-quicksight-user.pdf | 315 | time periods involved in the predictable seasonal pattern of data. The range is 1–180, and the default setting is Automatic. • Forecast boundaries – Set a minimum and/or maximum forecast value to prevent forecast values from going above or below a specified value. For example, if your forecasting predicts the number of new hires the company will make in the next month to be in the negative numbers, you can set a forecast boundary minimum to zero. This stops the forecasted values from ever going below zero. To save your changes, choose Apply. Using forecasts and what-if scenarios 1110 Amazon QuickSight User Guide If your forecast contains multiple metrics, you can isolate one of the forecasts by selecting anywhere inside the orange band. When you do this, the other forecasts disappear. Select the isolated forecast band again to have them reappear. 4. Analyze what-if scenarios by choosing a forecasted data point (in the orange band) on the chart, and then choosing What-if analysis from the context menu. The What-if analysis panel opens at left. Set the following options: • Scenario – Set a target for a date, or set a target for a time range. • Dates – If you are setting a target for a specific date, enter that date here. If you are using a time range, set the start and end dates. • Target – Set a target value for the metric. Amazon QuickSight adjusts the forecast to meet the target. Note The What-if analysis option isn't available for multiple-metric forecasts. If you want to perform a what-if scenario on your forecast, your visual should contain only one metric. 5. Keep your changes by choosing Apply. To discard them, close the What-if analysis panel. If you keep your changes, you see the new forecast adjusted for the target, alongside the original forecast without the what-if. The what-if analysis is represented on the visual as a dot on the metric line. You can hover over the data points on the forecasting line to see the details. Here are other things you can do: • To interact with or remove a what-if analysis, choose the dot on the metric line. • To create additional what-if scenarios, close the what-if analysis before choosing a new point on the line. Using forecasts and what-if scenarios 1111 Amazon QuickSight Note What-if analyses can exist inside an analysis only, not inside a dashboard. User Guide Using forecasts and what-if scenarios 1112 Amazon QuickSight User Guide Answering business questions with Amazon QuickSight Q Applies to: Enterprise Edition Important The QuickSight Q add-on is no longer available in Amazon QuickSight. To learn more about the latest Generative BI experience, see Using Generative BI with Amazon Q in QuickSight. Amazon QuickSight Q, powered by machine learning, uses natural language processing to answer your business questions quickly. By using Q, you can save weeks of effort on the part of your business intelligence (BI) teams, who otherwise might have to build predefined data models and dashboards. Q is optimized to understand business language that you use every day as part of your work, including phrases related to sales, marketing, and retail. For example, suppose that a sales leader wants to identify product categories that brought in the highest revenue in a region. They can simply ask, "What are the top-selling categories in California?" Q understands that "top-selling" means highest revenue and return the top-ranked categories in California by revenue. Unlike conventional natural-language query-based BI tools, Q uses machine learning to automatically understand the relationships across your data and build indexes. You can ask questions on all your data and get insights in seconds. Q provides autocomplete suggestions, performs spell-checks, and suggests acronyms and synonyms that you can customize to be business-specific. Also, if Q gets an answer wrong, you can provide feedback to Q to correct the answer. This feedback is passed on to the BI team, who can fine-tune the data model or add more data. Note Amazon QuickSight Q is not available in all AWS regions. To see a list of regions that QuickSight Q is available in, see Supported AWS Regions for Amazon QuickSight Q 1113 Amazon QuickSight Topics User Guide • New ways for authors to get value from Natural Language Query (NLQ) in Amazon QuickSight • Getting started with Amazon QuickSight Q • Trying Amazon QuickSight Q Embedding • Working with Amazon QuickSight Q topics • Asking questions with Amazon QuickSight Q • Pinning visuals in Amazon QuickSight Q • Providing feedback about Amazon QuickSight Q topics • Correcting wrong answers provided by Amazon QuickSight Q • Verifying Amazon QuickSight Q answers • Managing Amazon QuickSight Q regions • Unsubscribing from Q New ways for authors to get value from Natural Language Query (NLQ) in Amazon QuickSight Natural Language Query is a |
amazon-quicksight-user-316 | amazon-quicksight-user.pdf | 316 | for authors to get value from Natural Language Query (NLQ) in Amazon QuickSight • Getting started with Amazon QuickSight Q • Trying Amazon QuickSight Q Embedding • Working with Amazon QuickSight Q topics • Asking questions with Amazon QuickSight Q • Pinning visuals in Amazon QuickSight Q • Providing feedback about Amazon QuickSight Q topics • Correcting wrong answers provided by Amazon QuickSight Q • Verifying Amazon QuickSight Q answers • Managing Amazon QuickSight Q regions • Unsubscribing from Q New ways for authors to get value from Natural Language Query (NLQ) in Amazon QuickSight Natural Language Query is a powerful new data tool that can speed insight discovery when integrated into the BI suite. New Amazon QuickSight Q capabilities help existing analytics authors to do more with NLQ. Guided setup Natural Language Q&A is a powerful new capability and authors seeking to make the most of the technology need to understand some vital concepts. Amazon QuickSight Q has added guided topic setup to help authors familiar with analysis build simple and useful natural language topics. Guided setup provides a simple set of step-by-step instructions that teach tools authors have at their disposal to improve topic performance. It helps people understand how well their topics are being adopted, identify concrete actions to improve, and to tailor for the particular language used in their business. Authors can step out of guided setup at any time, and easily return to complete at their leisure. New ways to get value from NLQ 1114 Amazon QuickSight Add to analysis User Guide Authors building visuals need faster ways to get started, and easier ways to perform complex calculations. Add to analysis is a new capability which enables authors to use natural language to describe a visual they want, and then add directly to an existing analysis or dashboard. This speeds creation for common analysis types like bar charts, line graphs, and tables. It also helps authors to create more complex and difficult to achieve results like period over period comparisons. Visuals fit right in, automatically adopting themes in the analysis. Getting started with Amazon QuickSight Q Applies to: Enterprise Edition Intended audience: Amazon QuickSight administrators and authors Important The QuickSightQ search bar provides the classic QuickSight Q&A experience. QuickSight now offers a Generative BI Q&A experience. To learn more about the latest Generative BI experience, see Using Generative BI with Amazon Q in QuickSight. To get started using Amazon QuickSight Q, first get the Q add-on for your QuickSight account and specify the AWS Regions that you want the subscription to be available for. Pricing for the add- on applies to your entire QuickSight account and isn't specific to a Region. After you subscribe to Q, QuickSight authors can create topics, ask questions, and share topics with QuickSight readers. QuickSight readers can also ask questions using the Q bar. To help you create effective topics and practice asking Q questions about your data, QuickSight offers a step-by-step setup and getting started video. You can also find an interactive walkthrough that shows you how to ask questions about a topic using the Q bar, create topics, and optimize topics for natural language. To learn more about QuickSight Q, watch the following videos: Add to analysis 1115 Amazon QuickSight User Guide • Get Started with QuickSight Q in 3 Steps • Best Practices for QuickSight Q Authors Topics • Step 1: Get the Q add-on • Step 2: Create a sample Q topic • Step 3: Explore the sample topic • Step 4: Practice asking questions with the Q bar Step 1: Get the Q add-on Important The QuickSight Q add-on is no longer available in Amazon QuickSight. To learn more about the latest Generative BI experience, see Using Generative BI with Amazon Q in QuickSight. Step 2: Create a sample Q topic We strongly recommend that you create a sample topic to start learning to use Q after setup is complete. The sample topics include sample datasets and corresponding topic configurations to answer questions about the data. When a sample topic is ready, Q walks you through how to ask questions using the Q bar and how to create and configure topics. To create a sample topic 1. On any page in QuickSight, choose Topics at left. Step 1: Get the Q add-on 1116 Amazon QuickSight User Guide 2. On the Topics page, choose New Sample Topic. 3. In the Select sample topic page that opens, choose a sample topic to create, and then choose Create sample topic. In this example, the Software Sales sample topic is used. The topic creation process begins. This might take several minutes. While you wait, we recommend watching the getting started video. It contains the most important steps authors need to do to create a successful topic. Step 3: Explore |
amazon-quicksight-user-317 | amazon-quicksight-user.pdf | 317 | topic 1. On any page in QuickSight, choose Topics at left. Step 1: Get the Q add-on 1116 Amazon QuickSight User Guide 2. On the Topics page, choose New Sample Topic. 3. In the Select sample topic page that opens, choose a sample topic to create, and then choose Create sample topic. In this example, the Software Sales sample topic is used. The topic creation process begins. This might take several minutes. While you wait, we recommend watching the getting started video. It contains the most important steps authors need to do to create a successful topic. Step 3: Explore the sample topic When the sample topic is ready, you can follow a step-by-step walkthrough to familiarize yourself with the topic workspace and to learn best practices for creating successful topics. Use the following procedure to learn how. You can find the sample topic on the Topics page. This page includes a list of all your topics. Each listing includes the topic name, refresh history, number of questions asked using it, and feedback data. Because this is your first time using Q, only the sample topic is listed. To explore the sample topic 1. On the Topics page, choose the sample topic. In this example, the Software Sales sample topic is used. The topic opens to the topic Summary page. Here you can see how your readers engage with your topic and what feedback and ratings they give on the answers provided. Here you can also see a list of the datasets used to create the topic. 2. Choose the Data tab. Step 3: Explore the sample topic 1117 Amazon QuickSight User Guide The Data tab lists all the fields in your topic. Here you can configure your metadata to make your topic more natural-language-friendly and to improve your topic performance. The step-by-step walkthrough points out the following four best practices for configuring natural-language-friendly topics. Choose Next on the walkthrough to follow along with each of the following best practices: a. Exclude unused fields – Remove any fields that you don't want included in answers to your readers' questions. In this example, the field Row ID was removed. As a result, Q doesn't index the Row ID field as a term or use any of its values (customer mailing addresses) in answers. To exclude a field, turn off Include. b. Verify friendly field names – Rename fields to use names that your readers might use when asking a question about the topic. In this example, the author renamed the field cstmr_nm to Customer. To rename a field, choose the pencil icon at the right of the field name and then enter a name for the field. Step 3: Explore the sample topic 1118 Amazon QuickSight User Guide c. Add synonyms to fields – Not everyone in your organization knows the names of your fields, so it's necessary to include commonly used terms for your fields as synonyms. In this example, the author added the synonyms buyer, purchaser, Company, and client to the Customer field. That way, if a reader asks, "Show me top 10 clients", Q knows they're referring to data in the Customer field. To add a synonym to a field, choose the pencil icon beneath the Synonyms column for the field, enter a word or phrase, and then press Enter on your keyboard. To add another synonym, choose the + icon. d. Review field configurations – To help Q understand your data and use it correctly to answer readers' questions, we recommend that you review and update your field details. Here you can specify how you want Q to use the field. Should it be used as a measure or a dimension? Is it a location, person, or a date? Should it be aggregated as a sum or a count by default? Is it currency or a number? In field details, you can specify this information. In this example, the Customer field has been configured as a Dimension with a default aggregation of Count distinct. It has also been identified as an Organization. To tell Q more about your fields, choose the field list at far right and then add your changes to the field details. Step 3: Explore the sample topic 1119 Amazon QuickSight User Guide For more information about best practices and making topics natural-language-friendly, see Making Amazon QuickSight Q topics natural-language-friendly. Step 4: Practice asking questions with the Q bar Now that you've explored the sample topic and its data, practice asking questions about it using the Q bar at the top of any QuickSight page. For a list of the types of questions that you can ask Q, see Types of questions supported by Amazon QuickSight Q. To ask questions using the Q bar 1. Select a topic. Step 4: Practice asking questions with |
amazon-quicksight-user-318 | amazon-quicksight-user.pdf | 318 | Explore the sample topic 1119 Amazon QuickSight User Guide For more information about best practices and making topics natural-language-friendly, see Making Amazon QuickSight Q topics natural-language-friendly. Step 4: Practice asking questions with the Q bar Now that you've explored the sample topic and its data, practice asking questions about it using the Q bar at the top of any QuickSight page. For a list of the types of questions that you can ask Q, see Types of questions supported by Amazon QuickSight Q. To ask questions using the Q bar 1. Select a topic. Step 4: Practice asking questions with the Q bar 1120 Amazon QuickSight User Guide To select a topic, choose the topic list at left of the Q bar, and then choose the topic that you want to ask about. Because the sample topic is the only topic that you have at this time, it's already selected for you. 2. Click or tap inside the Q bar and enter a question. Press Enter on your keyboard when you're finished. The sample topic includes several sample questions to ask Q. For example, if you enter Who had the most sales last quarter?, Q responds with a horizontal bar chart showing sales by customer in the previous quarter. Step 4: Practice asking questions with the Q bar 1121 Amazon QuickSight User Guide 3. Review how Q interpreted your question. You can see a description of the visualization at upper left of the Q answer. Notice how Q underlined key terms in the question also. Those are the terms Q mapped to data fields in the topic. In this example, the term customer was mapped to who; sales was mapped to the sales field; and quarter was mapped to the previous quarter field. Q knows how to map these terms to data fields in the topic because the owner of the topic configured it to be natural-language-friendly. However, if you ask a question that Q doesn't know how to interpret, you can improve Q's accuracy by providing feedback and making corrections, as described later. Step 4: Practice asking questions with the Q bar 1122 Amazon QuickSight User Guide 4. Change the chart type. To do this, choose the bar chart icon at the answer's upper right, and then choose the type of chart that you want. For more information about asking questions using the Q bar, including the types of questions Q recognizes, see Asking questions with Amazon QuickSight Q. Now that you've explored the sample topic and practiced asking questions, you're ready to start creating topics and asking questions about them. To learn how, continue to Working with Amazon QuickSight Q topics. Trying Amazon QuickSight Q Embedding With QuickSight embedding, you can add a Q search bar, not just for registered users, but for anonymous users as well. To learn more, see the following topics: • Embedded analytics Try Q Embedding 1123 Amazon QuickSight • Embedding the Q search bar User Guide Working with Amazon QuickSight Q topics Applies to: Enterprise Edition Intended audience: Amazon QuickSight administrators and authors Q Topics are collections of one or more datasets that represent a subject area that your business users can ask questions about. With Amazon QuickSight automated data prep for Q, you get an ML-powered assist to help you create a Q topic that is relevant to your end users. The first process begins with automated field selection and classification, something like this: • Automated data prep for Q chooses a small number of fields to include by default to create a focused data space for readers to explore. • Automated data prep for Q selects fields that you use in other assets like reports and dashboards. • Automated data prep for Q also imports any additional fields from any related analysis where a topic is enabled. • It identifies dates, dimensions, and measures, to learn how fields can be used in answers. This automatic set of fields help the author quickly get started with natural language analytics. Authors can always exclude fields, or include additional fields, as needed by using the Include toggle. Next, Automated data prep for Q continues with the process by automatically labeling fields and identifying synonyms. Automated data prep for Q updates field names with friendly names and synonyms using common terms. For example, a SLS_PERSON field might be renamed to Sales person, and assigned synonyms including: salesman, saleswoman, agent, and sales representative. Although you can let automated data prep for Q do much of the work, it's worthwhile to review the fields, names, and synonyms to further customize them for your end Working with Q topics 1124 Amazon QuickSight User Guide users. For example, if the users refer to a sales person as a "rep" or a "dealer" in casual conversation, then you support this |
amazon-quicksight-user-319 | amazon-quicksight-user.pdf | 319 | Automated data prep for Q updates field names with friendly names and synonyms using common terms. For example, a SLS_PERSON field might be renamed to Sales person, and assigned synonyms including: salesman, saleswoman, agent, and sales representative. Although you can let automated data prep for Q do much of the work, it's worthwhile to review the fields, names, and synonyms to further customize them for your end Working with Q topics 1124 Amazon QuickSight User Guide users. For example, if the users refer to a sales person as a "rep" or a "dealer" in casual conversation, then you support this term by adding rep and dealer to the synonyms for SLS_PERSON. Finally, automated data prep for Q detects the semantic type of each field, by sampling its data and examining the formats applied to it by the author during analysis. Automated data prep for Q updates the field configuration automatically, setting formats for values used for each field. Answers to questions are thus provided in expected formats for dates, currencies, identifiers, Booleans, persons, and so on. To learn more about working with Q topics, continue on to the following sections in this chapter. Topics • Navigating Q Topics • Creating Amazon QuickSight Q topics • Topic workspace • Working with datasets in an Amazon QuickSight Q topic • Making Amazon QuickSight Q topics natural-language-friendly • Sharing Amazon QuickSight Q topics • Managing Amazon QuickSight topic permissions • Reviewing Amazon QuickSight Q topic performance and feedback • Refreshing Amazon QuickSight Q topic indexes • Work with QuickSight Q topics using the Amazon QuickSight APIs Navigating Q Topics In Amazon QuickSight, there is more than one way to create and manage a topic. You can begin on an Amazon QuickSight home or "start" page. Or, you can begin inside of an analysis. Topics • From an Amazon QuickSight home page • From an Amazon QuickSight analysis • Navigating questions in an Amazon QuickSight analysis Navigating Q Topics 1125 Amazon QuickSight User Guide From an Amazon QuickSight home page From your Amazon QuickSight start page, you can create and manage topics by selecting Topics in the navigation pane at left. QuickSight provides a guided workflow for creating topics. You can step out of the guided workflow and come back to it later, without disrupting your work. When you create a topic, your business users can ask questions about it in the Q bar. At any time, you can open a topic to change it or review how it's performing. To open a topic, choose the topic name. If at any time you want to return to a list of all your topics, choose All topics at left of the topic workspace. Navigating Q Topics 1126 Amazon QuickSight User Guide From an Amazon QuickSight analysis To start from an Amazon QuickSight analysis, open the analysis that you want to use with automated data prep for Q. To open or create a topic, choose the Q topic icon in the top navigation bar. At any time, you can open a topic to change it or review how it's performing. To open a topic from an analysis, choose the topic name in the top navigation bar, if it isn't already displayed. Then select the vertical ellipsis icon ( # ) on the top navigation bar. To view information about the topic, select About topic. A screen similar to the following appears: Navigating Q Topics 1127 Amazon QuickSight User Guide To view the data fields included in the topic, select Data fields in the tab list. A screen similar to the following appears: Navigating questions in an Amazon QuickSight analysis By navigating through the questions and answers for a topic in an analysis, you can learn how the topic is being used. This information can inform you to make adjustments if necessary. To learn how to use a topic with an analysis, see Using Q Topics on sheets in Amazon QuickSight. Navigating Q Topics 1128 Amazon QuickSight User Guide Starting from within an analysis that is already linked to a topic, select the Q search bar on the top navigation bar and then enter a question. The answer displays on a topic screen that also displays all the available options to work with the Q topic in an analysis. • To change the type of visual displayed in the answer, select the type icon (which resembles a bar chart). • To view improvement suggestions, select the speech bubble, which is highlighted if you have unviewed suggestions. • To view insights related to a question, select the light bulb icon. • To add or remove a question from the pinboard, toggle the icon for Add to pinboard or Remove from pinboard. You can view the pinboard by selecting the pinboard icon from the top navigation bar. • To |
amazon-quicksight-user-320 | amazon-quicksight-user.pdf | 320 | the available options to work with the Q topic in an analysis. • To change the type of visual displayed in the answer, select the type icon (which resembles a bar chart). • To view improvement suggestions, select the speech bubble, which is highlighted if you have unviewed suggestions. • To view insights related to a question, select the light bulb icon. • To add or remove a question from the pinboard, toggle the icon for Add to pinboard or Remove from pinboard. You can view the pinboard by selecting the pinboard icon from the top navigation bar. • To view information about this topic, select the circled lowercase i ( ). • Select the ellipsis menu ( … ) to do one of the following actions: Navigating Q Topics 1129 Amazon QuickSight User Guide • Export to CSV – Export the data displayed in the selected visual. • Copy Request ID – Capture the request ID of this process for troubleshooting. Amazon QuickSight generates an alphanumeric request ID to uniquely identify each process. • Share this visual – Securely share a URL for the topic used in the visual. • Answer breakdown – To view a detailed explanation of your answer. At the bottom of the topic screen, you can add or change variations on the question by selecting Edit question variants. Also at the bottom, when you are satisfied with the question and answer, mark the topic as reviewed by choosing Mark as reviewed. Or, if you see that a previously reviewed topic needs further review, choose Unmark as reviewed. At any time, you can open a topic to change it or review how it's performing. To work directly with the settings for a topic, such as which fields are included, or what synonyms they have, use the Topics page. To open a topic linked to an analysis 1. Open the Amazon QuickSight Topics page from the Amazon QuickSight start page, by selecting Topics in the navigation pane at left. If you want to keep your analysis open, you can open the Topics page in a new browser tab or window. 2. To open a topic, choose the topic name. If you recently navigated away from the analysis page, the name is probably still displayed in the Q search bar at the top of the screen. 3. If at any time you want to return to a list of all your topics, choose All topics at left of the topic workspace. Navigating Q Topics 1130 Amazon QuickSight User Guide Creating Amazon QuickSight Q topics Applies to: Enterprise Edition Intended audience: Amazon QuickSight administrators and authors To turn on questions for your datasets, you have to create a topic. QuickSight provides a guided workflow for creating topics. You can step out of the guided workflow and come back to it later, without disrupting your work. There are two ways to create a topic: • Create the topic by selecting a dataset. When you create topics in Amazon QuickSight, you can add multiple datasets to them and also enable the topics in analyses. • Create the topic using an analysis. When you create a topic in an analysis, or link an existing topic to an analysis, automated data prep for Q learns from how you analyze your data and automatically applies this to your Q topic. For more information, see Using Q Topics on sheets in Amazon QuickSight. After you share your topic with QuickSight readers and they use it to ask questions in the Q bar, you can see a summary of how the topic is performing. You can also see a list of everything users asked and how well Q responded, and any answers you have verified. Reviewing the feedback is important so that Q can continue to provide your business users with the correct visualizations and answers to their questions. Creating a topic Use the following procedure to create a topic. To create a topic 1. On the QuickSight start page, choose Topics. Creating topics 1131 Amazon QuickSight User Guide 2. On the Topics page that opens, choose New topic at upper right. 3. On the New topic page that opens, do the following: a. For Topic name, enter a descriptive name for the topic. Your business users identify the topic by this name and use it to ask questions. b. For Description, enter a description for the topic. Your users can use this description to get more details about the topic. c. Choose Continue. 4. On the Add data to topic page that opens, choose one of the following options: • To add one or more datasets that you own or have permission to, choose Datasets, and then select the dataset or datasets that you want to add. • To add datasets from dashboards that you |
amazon-quicksight-user-321 | amazon-quicksight-user.pdf | 321 | name, enter a descriptive name for the topic. Your business users identify the topic by this name and use it to ask questions. b. For Description, enter a description for the topic. Your users can use this description to get more details about the topic. c. Choose Continue. 4. On the Add data to topic page that opens, choose one of the following options: • To add one or more datasets that you own or have permission to, choose Datasets, and then select the dataset or datasets that you want to add. • To add datasets from dashboards that you have created or that have been shared with you, choose Datasets from a dashboards, and then select a dashboard from the list. 5. Choose Add data. Your topic is created and the page for that topic opens. The next step is to configure the topic metadata to make it natural-language-friendly for your readers. For more information, see Creating topics 1132 Amazon QuickSight User Guide Making Amazon QuickSight Q topics natural-language-friendly. Or continue to the next topic to explore the topic workspace. Topic workspace Applies to: Enterprise Edition Intended audience: Amazon QuickSight administrators and authors After you create a topic, or when you choose an existing topic from the list on the Topics page, the topic opens to that topic's workspace. Four tabs appear here that you can use as described in the following sections. QuickSight provides a guided workflow for topics. You can step out of the guided workflow and come back to it later, without disrupting your work. Topic workspace 1133 Amazon QuickSight Summary User Guide The Summary tab has three important areas: • Suggestions – Suggestions provide step-by-step guidance for how you can improve a topic. These steps help you understand how to create better-performing topics. To follow a suggestion, choose the action button in the Suggestion banner and follow the recommended steps. Topic workspace 1134 Amazon QuickSight User Guide Currently, there are eight preset suggestions that Q offers in the order shown by the following table. After you complete a step for a suggestion, a new suggestion is offered when you return to the Summary tab. Suggestion Message When It Appears Exclude unnecessary fields Review all fields of your topic and exclude those that This suggestion encourage s you to exclude fields that must not be used to provide aren't relevant to your answers. readers. Excluding fields that are irrelevant to a topic prevents Q from using the field entirely and helps Q answer questions more accurately. Add synonyms Expand topic vocabulary by adding different variations of This suggestion encourage s you to create synonyms business terms to refer to a for fields in your dataset. particular field. Synonyms are alternative names for your fields that your readers are more likely to understand. Topic workspace 1135 Amazon QuickSight User Guide Suggestion Message When It Appears Update semantic types for fields Improve answer quality by telling us more about data This suggestion encourage s you to update semantic contained in each field in the types for your fields. form of Semantic type. Semantic types help Q understand when to use a field in context to related questions. They include the field role, data type, default aggregation, and more. Test topic by asking questions Verify your topic performan ce by asking questions about it in the Q bar. This suggestion encourage s you to test your topic by asking a question in the Q bar. Make sure to format your question in a way that Q can understand. For more information, see Asking questions with Amazon QuickSight Q. Provide feedback on answers Preconfigure answers for questions You can review feedback for answers on your topic. This suggestion encourage s you to ask your readers to Try asking a question and provide specific feedback providing feedback for an related to their questions. answer. You can verify answers generated by your topic by creating reviewed answers. Try creating a reviewed answer. This suggestion encourage s you to review answers created by your topic and verify that the answers are accurate. Topic workspace 1136 Amazon QuickSight User Guide Suggestion Message When It Appears Review questions with negative feedback. You can review answers with negative feedback from This suggestion encourage s you to review individua users and make necessary l questions your readers improvements to topic. asked and gave negative feedback for. You can view the question and answer to identify gaps in this topic's settings and correct them. Review questions with comments You can review answers with comments to improve topic This suggestion encourage s you to review free-form performance. comments from your readers about questions they asked. Reviewing comments can help you identify ways to improve your readers' question and answer experience. • Metrics and key performance indicators (KPIs) on topic |
amazon-quicksight-user-322 | amazon-quicksight-user.pdf | 322 | with negative feedback from This suggestion encourage s you to review individua users and make necessary l questions your readers improvements to topic. asked and gave negative feedback for. You can view the question and answer to identify gaps in this topic's settings and correct them. Review questions with comments You can review answers with comments to improve topic This suggestion encourage s you to review free-form performance. comments from your readers about questions they asked. Reviewing comments can help you identify ways to improve your readers' question and answer experience. • Metrics and key performance indicators (KPIs) on topic engagement and performance – In this section, you can see how your readers engage with your topics and what feedback and ratings they give on the answers provided. You can view engagement for all the questions users asked, or select a specific question. You can also change the time span of the metrics from one year down to one week. For more information, see Reviewing Amazon QuickSight Q topic performance and feedback. Topic workspace 1137 Amazon QuickSight User Guide • Datasets – This section shows the datasets that were used to create the topic. In this section, you can add additional datasets or import datasets from existing dashboards. You can also edit the metadata for a topic dataset, set a data refresh schedule, change the name of the dataset, and more. For more information, see Working with datasets in an Amazon QuickSight Q topic. Data The Data tab shows all the fields included in the topic. Here you configure your topic metadata to make your topic natural-language-friendly and to improve your topic performance. For more information, see Making Amazon QuickSight Q topics natural-language-friendly. Topic workspace 1138 Amazon QuickSight User Guide User activity This tab shows all the questions that your topic receives and the overall feedback for each question. You can see an overview of how many questions were asked and what percentage of them were positive and negative. You can filter by feedback and whether someone left a comment with their feedback. For more information, see Reviewing Amazon QuickSight Q topic performance and feedback. Topic workspace 1139 Amazon QuickSight User Guide Verified answers Verified answers are questions that you have preconfigured visuals for. You can create a verified answer to a question by asking the question in the Q bar and then marking it as reviewed. By using the Verified Answers tab, you can review your verified answers and the feedback they receive by your users. For more information, see Verifying Amazon QuickSight Q answers. Topic workspace 1140 Amazon QuickSight User Guide Working with datasets in an Amazon QuickSight Q topic Applies to: Enterprise Edition Intended audience: Amazon QuickSight administrators and authors When you create a topic, you can add additional datasets to it or import datasets from existing dashboards. At any time, you can edit metadata for a dataset and set a data refresh schedule. You can also add new fields to a dataset in a topic by creating calculated fields, filters, or named entities. Topics • Adding datasets to a topic in Amazon QuickSight • Adding datasets with row-level security (RLS) to a Amazon QuickSight Q topic Working with datasets in a topic 1141 Amazon QuickSight User Guide • Refreshing datasets in a QuickSight Q topic • Removing datasets from a Amazon QuickSight Q topic • Adding calculated fields to a Amazon QuickSight Q topic dataset • Adding filters to a Amazon QuickSight Q topic dataset • Adding named entities to a Amazon QuickSight Q topic dataset Adding datasets to a topic in Amazon QuickSight At any time, you can add datasets to a topic. Use the following procedure to learn how. To add datasets to a topic 1. Open the topic that you want to add one or more datasets to. 2. On the Summary page, under Datasets, choose Add datasets. 3. On the Add datasets page that opens, choose the dataset or datasets that you want to add, and then choose Add datasets. The dataset is added to the topic and Q begins indexing the dataset's unique string values. You can edit the field configurations right away. For more information about the Q index, see Refreshing Amazon QuickSight Q topic indexes. For more information about editing field configurations for Q, see Making Amazon QuickSight Q topics natural-language-friendly. Adding datasets with row-level security (RLS) to a Amazon QuickSight Q topic You can add datasets that contain row-level security (RLS) to Q topics. All fields in a topic respect the RLS rules applied to your dataset. For example, if a user asks, "show me sales by region," the Working with datasets in a topic 1142 Amazon QuickSight User Guide data that Q returns is based on the user's access to the underlying data. So, if they're only |
amazon-quicksight-user-323 | amazon-quicksight-user.pdf | 323 | Refreshing Amazon QuickSight Q topic indexes. For more information about editing field configurations for Q, see Making Amazon QuickSight Q topics natural-language-friendly. Adding datasets with row-level security (RLS) to a Amazon QuickSight Q topic You can add datasets that contain row-level security (RLS) to Q topics. All fields in a topic respect the RLS rules applied to your dataset. For example, if a user asks, "show me sales by region," the Working with datasets in a topic 1142 Amazon QuickSight User Guide data that Q returns is based on the user's access to the underlying data. So, if they're only allowed to see the East region, only data for the East region appears in the Q answer. RLS rules are applied to automatic suggestions when users are asking questions. As users enter questions, only the values that they have access to are suggested to them. If a user enters a question about a dimensional value that they don't have access to, they do not get an answer for that value. For example, suppose that the same user is entering the question, "show me sales in the West region." In this case, they do not get a suggestion or an answer for it, even if they ask, because they don't have RLS access to that region. By default, QuickSight Q allows users to ask questions regarding fields based on the user's permissions in RLS. Continue to use this option if your field contains sensitive data that you want to restrict access to. If your fields don't contain sensitive information and you want all users to see the information in Q suggestions, then you can choose to allow questions for all values in the field. To allow questions for all fields 1. From the QuickSight start page, choose Datasets. 2. On the Datasets page, choose the dataset that you added RLS to, and then choose Edit dataset. For more information about adding RLS to a dataset, see Using row-level security in Amazon QuickSight. 3. On the data preparation page, choose the field menu (the three dots) for a field that you want to allow for Q, and then choose Row level security for Q. Working with datasets in a topic 1143 Amazon QuickSight User Guide 4. On the Row level security for QuickSight Q page that opens, choose Allow users to ask questions regarding all values on this field. 5. Choose Apply. 6. When finished editing the dataset, choose Save & publish in the blue toolbar at upper right. 7. Add the dataset to your Q topic. For more information, see the previous section, Adding datasets to a topic in Amazon QuickSight. If you currently allow users to ask questions regarding all values, but want to implement the dataset's RLS rules to protect sensitive information, then repeat steps 1–4 and choose Allow users to ask questions regarding this field based on their permissions. When you are done, refresh the dataset in your topic. For more information, see Refreshing datasets in a QuickSight Q topic. Refreshing datasets in a QuickSight Q topic When you add a dataset to a topic, you can specify how often you want that dataset to refresh. When you refresh datasets in a topic, Q refreshes the index for that topic with any new and updated information. Working with datasets in a topic 1144 Amazon QuickSight User Guide Q doesn't replicate your datasets when you add them to a topic. Q creates an index of unique string values and doesn't index metrics. For example, measures stored as integers are not indexed by Q. Questions asked always fetch the latest sales metrics based on data in your dataset. For more information about refreshing the topic index, see Refreshing Amazon QuickSight Q topic indexes You can set a refresh schedule for a dataset in a topic, or refresh the dataset manually. You can also see when the data was last refreshed. To set a refresh schedule for a topic dataset 1. Open the topic that you want to change. 2. On the Summary page, under Datasets, expand the dataset that you want to set a refresh schedule for. 3. Choose Add schedule, and then do one of the following in the Add refresh schedule page that opens. • If the dataset is a SPICE dataset, select Refresh topic when dataset is imported into SPICE. Currently, hourly refresh SPICE datasets aren't supported in Q. SPICE datasets that are set to refresh every hour are automatically converted to a daily refresh. For more information about setting refresh schedules for SPICE datasets, see Refreshing SPICE data. • If the dataset is a direct query dataset, do the following: 1. For Timezone, choose a time zone. 2. For Repeats, choose how often you want the refresh to happen. You can choose to refresh the dataset |
amazon-quicksight-user-324 | amazon-quicksight-user.pdf | 324 | Add refresh schedule page that opens. • If the dataset is a SPICE dataset, select Refresh topic when dataset is imported into SPICE. Currently, hourly refresh SPICE datasets aren't supported in Q. SPICE datasets that are set to refresh every hour are automatically converted to a daily refresh. For more information about setting refresh schedules for SPICE datasets, see Refreshing SPICE data. • If the dataset is a direct query dataset, do the following: 1. For Timezone, choose a time zone. 2. For Repeats, choose how often you want the refresh to happen. You can choose to refresh the dataset daily, weekly, or monthly. Working with datasets in a topic 1145 Amazon QuickSight User Guide 3. For Refresh time, enter the time that you want the refresh to start. 4. For Start first refresh on, choose a date that you want start refreshing the dataset on. 4. Choose Save. To manually refresh a dataset 1. On the topic Summary page, under Datasets, choose the dataset that you want to refresh. 2. Choose Refresh now. To view refresh history for a dataset 1. On the topic Summary page, under Datasets, choose the dataset that you want to see refresh history for. 2. Choose View history. Working with datasets in a topic 1146 Amazon QuickSight User Guide The Update history page opens with a list of the times the dataset was refreshed. Removing datasets from a Amazon QuickSight Q topic You can remove datasets from a topic. Removing datasets from a topic doesn't delete them from QuickSight. Use the following procedure to remove a dataset from a topic. To remove a dataset from a topic 1. Open the topic that you want to change. 2. On the Summary page, under Datasets, choose the dataset menu (the three dots) at right, and then choose Remove from topic. 3. On the Are you sure you want to delete? page that opens, choose Delete to remove the dataset from the topic. Choose Cancel if you don't want to remove the dataset from the topic. Adding calculated fields to a Amazon QuickSight Q topic dataset You can create new fields in a topic by creating calculated fields. Calculated fields are fields that use a combination of one or two fields from a dataset with a supported function to create new data. For example, if your dataset contains columns for sales and expenses, you can combine them in a calculated field with a simple function to create a profit column. The function might look like the following: sum({Sales}) - sum({Expenses}). Working with datasets in a topic 1147 Amazon QuickSight User Guide To add a calculated field to a topic 1. Open the topic that you want to change. 2. 3. In the topic, choose the Data tab. For Actions, choose Add calculated field. 4. In the calculations editor that opens, do the following: a. Give the calculated field a friendly name. b. c. For Datasets at right, choose a dataset that you want to use for the calculated field. Enter a calculation in the calculation editor at left. You can see a list of fields in the dataset in the Fields pane at right. You can also see a list of supported functions in the Functions pane at right. For more information about the functions and operators you can use to create calculations in QuickSight, see the Calculated field function and operator reference for Amazon QuickSight . 5. When finished, choose Save. The calculated field is added to the list of fields in the topic. You can add a description to it and configure metadata for it to make it more natural language friendly. Working with datasets in a topic 1148 Amazon QuickSight User Guide Adding filters to a Amazon QuickSight Q topic dataset Sometimes your business users (readers) might ask questions that contain terms that map to multiple cells of values in the data. For example, let's say one of your readers asks Q, "Show me weekly sales trend in the west." West in this instance refers to both the Northwest and Southwest values in the Region field, and requires the data to be filtered to generate an answer. You can add filters to a topic to support requests like these. To add a filter to a topic 1. Open the topic that you want to add a filter to. 2. 3. In the topic, choose the Data tab. For Actions, choose Add filter. 4. In the Filter configuration page that opens, do the following: a. b. c. For Name, enter a friendly name for the filter. For Dataset, choose a dataset that you want to apply the filter to. For Field, choose the field that you want to filter. Depending on the type of field you choose, you're offered different filtering options. • If you |
amazon-quicksight-user-325 | amazon-quicksight-user.pdf | 325 | to support requests like these. To add a filter to a topic 1. Open the topic that you want to add a filter to. 2. 3. In the topic, choose the Data tab. For Actions, choose Add filter. 4. In the Filter configuration page that opens, do the following: a. b. c. For Name, enter a friendly name for the filter. For Dataset, choose a dataset that you want to apply the filter to. For Field, choose the field that you want to filter. Depending on the type of field you choose, you're offered different filtering options. • If you chose a text field (for example, Region), do the following: Working with datasets in a topic 1149 Amazon QuickSight User Guide 1. For Filter type, choose the type of filter that you want. For more information about filter text fields, see Adding text filters. 2. For Rule, choose a rule. 3. For Value, enter one or more values. • If you chose a date field (for example, Date), do the following: 1. For Filter type, choose the type of filter that you want, and then enter the date or dates that you want to apply the filter to. For more information about filtering dates, see Adding date filters. • If you chose a numeric field (for example, Compensation), do the following: 1. For Aggregation, choose how you want to aggregate the filtered values. 2. For Rule, choose a rule for the filter, and then enter a value for that rule. For more information about filtering numeric fields, see Adding numeric filters. d. (Optional) To specify when the filter is applied, choose Apply the filter anytime the dataset is used, and then choose one of the following: • Apply always – When you choose this option, the filter is applied whenever any column from the dataset you specified is linked to a question. • Apply always, unless a question results in an explicit filter from the dataset – When you choose this option, the filter is applied whenever any column from the dataset you specified is linked to a question. However, if the question mentions an explicit filter on the same field, the filter isn't applied. e. When finished, choose Save. The filter is added to the list of fields in the topic. You can edit the description for it or adjust when the filter is applied. Adding named entities to a Amazon QuickSight Q topic dataset When asking questions about your topic, your readers might refer to multiple columns of data without stating each column explicitly. For example, they might ask for the address of a transaction. What they actually mean is that they want the branch name, state, and city of where the transaction was made. To support requests like this, you can create a named entity. Working with datasets in a topic 1150 Amazon QuickSight User Guide A named entity is a collection of fields that display together in an answer. For example, using the transaction address example, you can create a named entity called Address. You can then add the Branch Name, State, and City columns to it, which already exist in the dataset. When someone asks a question about address, the answer displays the branch, state, and city where a transaction took place. To add a named entity to a topic 1. Open the topic that you want to change. 2. 3. In the topic, choose the Data tab. For Actions, choose Add named entity. 4. In the Named entity page that opens, do the following: a. b. c. d. For Dataset, choose a dataset. For Name, enter a friendly name for the named entity. For Description, enter a description of the named entity. (Optional) For Synonyms, add any alternate names that you think your readers might use to refer to the named entity or the data it contains. e. Choose Add field, and then choose a field from the list. Choose Add field again to add another field. Working with datasets in a topic 1151 Amazon QuickSight User Guide The ordering of the fields listed here are the order they appear in answers. To move a field, choose the six dots at left of the field name and drag and drop the field to the order that you want. f. When finished, choose Save. The named entity is added to the list of fields in the topic. You can add edit the description for it and add synonyms to it to make it more natural language friendly. Making Amazon QuickSight Q topics natural-language-friendly Applies to: Enterprise Edition Intended audience: Amazon QuickSight administrators and authors When you create a topic, Amazon QuickSight Q creates, stores, and maintains an index with definitions for data in that topic. Q uses this index to generate correct answers, provide autocomplete |
amazon-quicksight-user-326 | amazon-quicksight-user.pdf | 326 | field name and drag and drop the field to the order that you want. f. When finished, choose Save. The named entity is added to the list of fields in the topic. You can add edit the description for it and add synonyms to it to make it more natural language friendly. Making Amazon QuickSight Q topics natural-language-friendly Applies to: Enterprise Edition Intended audience: Amazon QuickSight administrators and authors When you create a topic, Amazon QuickSight Q creates, stores, and maintains an index with definitions for data in that topic. Q uses this index to generate correct answers, provide autocomplete suggestions when someone asks a question, and suggest mappings of terms to columns or data values. This is how Q can interpret key terms in your readers' questions and map them to your data. To help Q interpret your data and better answer your readers' questions, provide as much information about your datasets and their associated fields as possible. Use the following procedures to do so, making your topics more natural-language-friendly. Tip You can edit multiple fields at a time using bulk actions. Use the following procedure to bulk-edit fields in a topic. To bulk-edit fields in a topic 1. Open the topic that you want to change. Making topics natural-language-friendly 1152 Amazon QuickSight User Guide 2. In the topic, choose the Data tab. 3. Under Fields, select two or more fields that you want to change. 4. Choose Bulk Actions at the top of the list. 5. In the Bulk Actions page that opens, configure the fields how you want, and then choose Apply to. The configuration options are described in the following steps. Step 1: Give datasets friendly names and descriptions Dataset names are often based on technical naming conventions that your readers might not naturally use to refer to them. We recommend that you give your datasets friendly names and descriptions to provide more information about the data they contain. Q uses these friendly names and descriptions to understand dataset contents and select a dataset based on the reader's question. Q also shows the dataset names to the reader to provide additional context for an answer. For example, if your dataset is named D_CUST_DLY_ORD_DTL, you might rename it in the topic to Customer Daily Order Details. That way, when your readers see it listed in the Q bar for your topic, they can quickly determine if the data is relevant to them or not. To give a dataset a friendly name and description 1. Open the topic that you want to change. 2. On the Summary tab, under Datasets, choose the down arrow at the far right of the dataset to expand it. 3. Choose the pencil icon next to the dataset name at left, and then enter a friendly name. We recommend using a name that your readers will understand. Making topics natural-language-friendly 1153 Amazon QuickSight User Guide 4. For Description, enter a description for the dataset that describes the data it contains. Step 2: Tell Q how to use date fields in your datasets If your dataset contains date and time information, we recommend telling Q how to use that information when answering questions. Doing this is especially important if you have multiple date time columns in a topic. In some cases, there are multiple valid date columns in a topic, such as order date and shipped date. In these cases, you can help readers by specifying a default date for Q to use to answer their questions. Readers can choose a different date if the default date doesn't answer their question. You can also tell Q how granular to be with your date time columns by specifying a time basis. The time basis for a dataset is the lowest level of time granularity that is supported by all measures in the dataset. This setting helps Q aggregate metrics in the dataset across different time dimensions and is applicable for datasets that support a single date time granularity. This option can be set for Making topics natural-language-friendly 1154 Amazon QuickSight User Guide denormalized datasets with a large number of metrics. For example, if a dataset supports several metrics at a daily aggregation, then you can set the time basis of that dataset to Daily. Q then uses that to determine how to aggregate metrics. To set a default date and time basis for a dataset 1. Open the topic that you want to change. 2. On the Summary tab, under Datasets, choose the down arrow at far right of the dataset to 3. 4. expand it. For Default date, choose a date field. For Time basis choose the lowest level of granularity that you want Q to aggregate metrics in the dataset to. You can aggregate metrics in a topic at the daily, weekly, monthly, |
amazon-quicksight-user-327 | amazon-quicksight-user.pdf | 327 | set the time basis of that dataset to Daily. Q then uses that to determine how to aggregate metrics. To set a default date and time basis for a dataset 1. Open the topic that you want to change. 2. On the Summary tab, under Datasets, choose the down arrow at far right of the dataset to 3. 4. expand it. For Default date, choose a date field. For Time basis choose the lowest level of granularity that you want Q to aggregate metrics in the dataset to. You can aggregate metrics in a topic at the daily, weekly, monthly, quarterly, or yearly level. Step 3: Exclude unused fields When you add a dataset to a topic, all columns (fields) in the dataset are added by default. If your dataset contains fields that you or your readers don't use, or that you don't want to include in answers, you can exclude them from the topic. Excluding these fields removes them from Q answers and the Q index and improves the accuracy of answers that your readers receive. To exclude fields in a topic 1. Open the topic that you want to change. 2. In the topic, choose the Data tab. Making topics natural-language-friendly 1155 Amazon QuickSight User Guide 3. In the Fields section, under Include, toggle the icon off. Step 4: Rename fields to be natural-language-friendly Fields in a dataset are often named based on technical naming conventions. You can make your field names more user-friendly in your topics by renaming them and adding descriptions. Q uses field names to understand the fields and link them to terms in your readers' questions. When your field names are user-friendly, it's easier for Q to draw links between the data and a reader’s question. These friendly names are also presented to readers as part of the answer to their question to provide additional context. To rename and add descriptions to a field 1. Open the topic that you want to change. 2. 3. In the topic, choose the Data tab. In the Fields section, choose the down arrow at far right of the field to expand it. 4. Choose the pencil icon next to the field name at left, and then enter a friendly name. 5. For Description, enter a description of the field. Making topics natural-language-friendly 1156 Amazon QuickSight User Guide Step 5: Add synonyms to fields and field values Even if you update your field names to be user-friendly and provide a description for them, your readers might still use different names to refer to them. For example, a Sales field might be referred to as revenue, rev, or spending in your reader's questions. To help Q make sense of these terms and map them to the correct fields, you can add one or more synonyms to your fields. Doing this improves Q's accuracy. As with field names, your readers might use different names to refer to specific values in your fields. For example, if you have a field that contains the values NW, SE, NE, and SW, you can add synonyms for those values. You can add Northwest for NW, Southeast for SE, and so on. To add synonyms for a field 1. Open the topic that you want to change. 2. 3. In the topic, choose the Data tab. In the Fields section, under Synonyms, choose the pencil icon for the field, enter a word or phrase, and then press Enter on your keyboard. To add another synonym, choose the + icon. Making topics natural-language-friendly 1157 Amazon QuickSight User Guide To add synonyms for a value in a field 1. Open the topic that you want to change. 2. 3. In the topic, choose the Data tab. In the Fields section, choose the down arrow at far right to expand information about the field. 4. Under Value Preview at right, choose Configure value synonyms. 5. On the Field Value Synonyms page that opens, choose Add, and then do the following: a. b. For Value, choose the value that you want to add synonyms to. For Synonyms, enter one or more synonyms for the value. 6. Choose Save. 7. To add synonyms for another value, repeat steps 5–6. 8. When you finish, choose Done. Making topics natural-language-friendly 1158 Amazon QuickSight User Guide Step 6: Tell Q more about your fields To help Q interpret how to use your data to answer readers' questions, you can tell Q more about the fields in your datasets. You can tell Q whether a field in your dataset is a dimension or a measure and specify how that field should be aggregated. You can also clarify how the values in a field should be formatted, and what type of data is in the field. Configuring these additional settings helps Q create accurate answers |
amazon-quicksight-user-328 | amazon-quicksight-user.pdf | 328 | When you finish, choose Done. Making topics natural-language-friendly 1158 Amazon QuickSight User Guide Step 6: Tell Q more about your fields To help Q interpret how to use your data to answer readers' questions, you can tell Q more about the fields in your datasets. You can tell Q whether a field in your dataset is a dimension or a measure and specify how that field should be aggregated. You can also clarify how the values in a field should be formatted, and what type of data is in the field. Configuring these additional settings helps Q create accurate answers for your readers when they ask a question. Use the following procedures to tell Q more about your fields. Assign field roles Every field in your dataset is either a dimension or a measure. Dimensions are categorical data, and measures are quantitative data. Knowing whether a field is a dimension or a measure determines what operations Q can and can't perform on a field. For example, setting the fields Patient ID, Employee ID, and Ratings helps Q interpret those fields as integers. This setting means that Q doesn't try to aggregate them as it does measures. To set a field role 1. Open the topic that you want to change. 2. 3. In the topic, choose the Data tab. In the Fields section, choose the down arrow at far right to expand information about the field. 4. For Role, choose a role. You can choose a measure or a dimension. Making topics natural-language-friendly 1159 Amazon QuickSight User Guide 5. (Optional) If your measure is inversely proportional (for example, the lower the number, the better), choose Inverted measure. This tells Q how to interpret and display the values in this field. Set field aggregations Setting field aggregations tells Q which function should or shouldn't be used when those fields are aggregated across multiple rows. You can set a default aggregation for a field, and a not allowed aggregation. A default aggregation is the aggregation that's applied when there's no explicit aggregation function mentioned or identified in a reader's question. For example, let's say one of your readers asks Q, "How many products were sold yesterday?" In this case, Q uses the field Product ID, Making topics natural-language-friendly 1160 Amazon QuickSight User Guide which has a default aggregation of count distinct, to answer the question. Doing this results in a visual showing the distinct count of Product ID. Not allowed aggregations are aggregations that are excluded from being used on a field to answer a question. They're excluded even if the question specifically asks for a not allowed aggregation. For example, let's say you specify that the Product ID field should never be aggregated by sum. Even if one of your readers asks, "How many total products were sold yesterday?" Q doesn't use sum to answer the question. If Q is incorrectly applying aggregate functions on a field, we recommend that you set not allowed aggregations for the field. To set field aggregations 1. Open the topic that you want to change. 2. 3. 4. 5. 6. In the topic, choose the Data tab. In the Fields section, choose the down arrow at far right to expand information about the field. For Default aggregation, choose the aggregation that you want Q to aggregate the field by default. You can aggregate measures by sum, average, max, and min. You can aggregate dimensions by count and count distinct. (Optional) For Not allowed aggregations, choose an aggregation that you don't want Q to use. (Optional) If you don't want Q to aggregate the field in a filter, choose Never aggregate in a filter. Making topics natural-language-friendly 1161 Amazon QuickSight User Guide Specify how to format field values If you want to tell Q how to format the values in your fields, you can do so. For example, suppose that you have the field Order Sales Amount, which contains values that you want to format as U.S. dollars. In this case, you can tell Q to format the values in the field as U.S. currency when using it in answers. To specify how to format field values 1. Open the topic that you want to change. 2. 3. In the topic, choose the Data tab. In the Fields section, choose the down arrow at far right to expand information about the field. 4. For Value format, choose how you want to format the values in the field. Making topics natural-language-friendly 1162 Amazon QuickSight User Guide Specify field semantic types A field semantic type is the type of information represented by the data in a field. For example, you might have a field that contains location data, currency data, age data, or Boolean data. You can specify a semantic type and additional semantic subtype for fields. Specifying |
amazon-quicksight-user-329 | amazon-quicksight-user.pdf | 329 | 2. 3. In the topic, choose the Data tab. In the Fields section, choose the down arrow at far right to expand information about the field. 4. For Value format, choose how you want to format the values in the field. Making topics natural-language-friendly 1162 Amazon QuickSight User Guide Specify field semantic types A field semantic type is the type of information represented by the data in a field. For example, you might have a field that contains location data, currency data, age data, or Boolean data. You can specify a semantic type and additional semantic subtype for fields. Specifying these helps Q understand the meaning of the data stored in your fields. Use the following procedure to specify field semantic types and subtypes. To specify field semantic types 1. Open the topic that you want to change. 2. 3. In the topic, choose the Data tab. In the Fields section, choose the down arrow at far right to expand information about the field. 4. For Semantic type, choose the kind of information the data represents. For measures, you can select duration, date part, location, boolean, currency, percentage, age, distance, and identifier types. For dimensions, you can select date part, location, Boolean, person, organization, and identifier types. 5. For Semantic sub-type, choose an option to further specify the kind of information the data represents. Making topics natural-language-friendly 1163 Amazon QuickSight User Guide The options here depend on the semantic type that you chose and the role associated with the field. For a list of semantic types and their associated subtypes for measures and dimensions, see the following table. Semantic Type Semantic Subtype Available for the Following Age Boolean Currency Date part USD EUR GBP Day Week Measures Dimensions and measures Measures Dimensions and measures Making topics natural-language-friendly 1164 Amazon QuickSight User Guide Semantic Type Semantic Subtype Available for the Following Month Year Quarter Distance Kilometer Measures Meter Yard Foot Second Minute Hour Day Zip code Country State City Duration Identifier Location Organization Percentage Person Measures Dimensions and measures Dimensions and measures Dimensions Measures Dimensions Making topics natural-language-friendly 1165 Amazon QuickSight User Guide Sharing Amazon QuickSight Q topics Applies to: Enterprise Edition Intended audience: Amazon QuickSight administrators and authors After you create a topic, you can share it with others in your organization. Sharing a topic allows your users to select the topic and ask questions about it in the Q bar. After you share a topic with your users, you can assign permissions to them that specify who can change the topic. To share a topic 1. On the QuickSight start page, choose Topics at left. 2. On the Topics page that opens, open the topic that you want to share. 3. On the page that opens, choose Share at upper right. 4. On the Share topic with users page that opens, choose the user or users that you want to share the topic with. Sharing topics 1166 Amazon QuickSight User Guide You can use the search bar to search for users by email address. 5. Choose either Viewer or Co-owner under the Permission column to assign permissions to your users. For more information about these permissions, see the following section, Managing Amazon QuickSight topic permissions. 6. When you're finished selecting users, choose Share. Managing Amazon QuickSight topic permissions When you share your Q topics with others in your organization, you might want to control who can change them. To do this, specify which users are viewers and which are co-owners. Viewers can see the topic in the Q bar when they select a topic from the list, but they can't change the topic data. Co-owners can see the topic in the Q bar, and they can also change the topic. To assign topic permissions to your users 1. From the QuickSight start page, choose Topics. 2. On the Q Topics page that opens, open the topic that you want to manage permissions for. 3. On the topic page that opens, choose Share at upper right. Manage topic permissions 1167 Amazon QuickSight User Guide 4. On the Share topic with users page that opens, choose Manage topic access. 5. On the Manage topic permissions page that opens, find the user that you want to manage access for, and then for Permission, choose one of the following options: • To allow a user to view and change the topic, choose Co-Owner. • To allow a user to view the topic only, choose Viewer. Reviewing Amazon QuickSight Q topic performance and feedback Applies to: Enterprise Edition Intended audience: Amazon QuickSight administrators and authors After you create a topic and share it with your users, you can review how that topic is performing. When someone uses your topic to ask a question or provides feedback on how well Q responded, it's recorded on |
amazon-quicksight-user-330 | amazon-quicksight-user.pdf | 330 | that you want to manage access for, and then for Permission, choose one of the following options: • To allow a user to view and change the topic, choose Co-Owner. • To allow a user to view the topic only, choose Viewer. Reviewing Amazon QuickSight Q topic performance and feedback Applies to: Enterprise Edition Intended audience: Amazon QuickSight administrators and authors After you create a topic and share it with your users, you can review how that topic is performing. When someone uses your topic to ask a question or provides feedback on how well Q responded, it's recorded on the topic's Summary and User Activity tabs. On the topic's Summary tab, you can view historical data for the number of questions asked over time, in time periods from seven days to a year. You can also see a distribution of questions that received positive, negative, or no feedback, and also questions that were unanswerable. On the User Activity tab, you can see a list of the questions that users asked and any positive or negative feedback and comments that they left. Reviewing this information can help you determine whether your topic is meeting your users' needs. For example, let's say you have a topic that's receiving a lot of negative feedback from your users. When you review your user activity, you notice that several users are leaving comments on a Reviewing topic performance and feedback 1168 Amazon QuickSight User Guide question that Q is showing them the wrong data. In response, you examine the questions that they asked, and notice that they were using a term that you didn't anticipate. You decide to add that term as a synonym to the correct field in the topic. Over time, you notice an increase in positive feedback. Reviewing topic performance Use the following procedure to view how a topic is performing. To view how a topic is performing 1. On the QuickSight start page, choose Topics at left. 2. On the Topics page that opens, open the topic that you want to review. The topic opens and the Statistics section shows the topic's statistics. Reviewing topic performance and feedback 1169 Amazon QuickSight User Guide 3. (Optional) To change the amount of historical data shown in the chart, choose one of the following options: 7 days, 30 days, 90 days, 120 days, or 12 months. Reviewing topic performance and feedback 1170 Amazon QuickSight User Guide 4. (Optional) To remove questions that were unanswerable from the data, clear Include Unanswerable data. 5. (Optional) To remove questions that didn't receive feedback from the data, clear Include No feedback data. Reviewing topic performance and feedback 1171 Amazon QuickSight User Guide Reviewing topic questions and feedback Use the following procedures to review a topic's questions and feedback. To review topic questions and feedback 1. On the QuickSight start page, choose Topics. 2. On the Topics page that opens, open the topic that you want to review feedback for. 3. On the topic's page that opens, choose the User Activity tab. Reviewing topic performance and feedback 1172 Amazon QuickSight User Guide The user activity for the topic is shown. At the top, you can see the total number of questions asked and the number of questions that were answerable and unanswerable. You can also see the percentage of questions that were rated positive and negative. Additionally, you can see the percentage of questions that were disambiguated. This means that someone entered a question and mapped one of the words in the question to a field in the topic. You can choose any of these statistics to filter the list of questions. 4. (Optional) To view a comment left by a user on a question, choose the down arrow at right of the question. The comment is shown at left. Reviewing topic performance and feedback 1173 Amazon QuickSight User Guide 5. (Optional) To view the fields used to respond to a question, choose the down arrow at right of the question. The fields used are shown at right. Choose a field name to edit its metadata. 6. (Optional) To view a question that was disambiguated, choose the down arrow at right of a question with a term highlighted in red. A description of the term and the field that was used to disambiguate it is shown. To add synonyms for the field, choose Add synonyms. 7. (Optional) To view how Q responded to a question, choose View next to the question in the list. Reviewing topic performance and feedback 1174 Amazon QuickSight User Guide 8. (Optional) To filter the list of questions, choose Filter by at right, and then filter by one of the following options. • See all questions – This option removes all filters and shows all questions that a topic has received. • Answerable – |
amazon-quicksight-user-331 | amazon-quicksight-user.pdf | 331 | in red. A description of the term and the field that was used to disambiguate it is shown. To add synonyms for the field, choose Add synonyms. 7. (Optional) To view how Q responded to a question, choose View next to the question in the list. Reviewing topic performance and feedback 1174 Amazon QuickSight User Guide 8. (Optional) To filter the list of questions, choose Filter by at right, and then filter by one of the following options. • See all questions – This option removes all filters and shows all questions that a topic has received. • Answerable – This option filters the list of questions to those that were answerable. Answerable questions are questions that Q was able to respond to. • Unanswerable – This option filters the list of questions to those that were unanswerable. Unanswerable questions are questions that Q could not respond to. • Disambiguated – This option filters the list of questions to those that were disambiguated, meaning questions with terms that users manually mapped a field to. • No feedback – This option filters the list of questions to those that didn't receive feedback. • Negative – This option filters the list of questions to those that received negative feedback. • Positive – This option filters the list of questions to those that received positive feedback. • No comments – This option filters the list of questions to those that didn't receive comments from users. • Has comments – This option filters the list of questions to those that received comments from users. • User – This option filters the list of questions to those that were asked by a user with a specific user name that you enter. Reviewing topic performance and feedback 1175 Amazon QuickSight User Guide Refreshing Amazon QuickSight Q topic indexes Applies to: Enterprise Edition Intended audience: Amazon QuickSight administrators and authors When you create a topic, Amazon QuickSight Q creates, stores, and maintains an index with definitions for data in that topic. This index isn't exposed to QuickSight authors. It's not a copy of the datasets included in a topic either. Q doesn't index metrics. For example, measures stored as integers are not indexed by Q. The topic index is an index of unique string values for fields included in a topic. Q uses this index to generate correct answers, provide autocomplete suggestions when someone asks a question, and suggest mappings of terms to columns or data values. To refresh a topic index, refresh the datasets in the topic. You can manually refresh all datasets in a topic or refresh an individual dataset. You can also view dataset refresh history to monitor past refreshes, and set a recurring refresh schedule for every dataset in the topic. For SPICE Refreshing topic indexes 1176 Amazon QuickSight User Guide datasets, you can sync the topic index refresh schedule with the SPICE refresh schedule. For more information about setting SPICE refresh schedules, see Refreshing a dataset on a schedule . Note Currently, hourly refresh schedules aren't supported in Q. You can set a refresh schedule to refresh datasets in a topic up to once a day. We recommend that you update topic indexes regularly to ensure that the latest definitions and values are recorded. Updating a topic index takes approximately 15 to 30 minutes, depending on the number and size of datasets included in the topic. To refresh a topic index 1. On the QuickSight start page, choose Topics. 2. On the Topics page that opens, open the topic that you want to refresh. The topic opens to the Summary tab, which shows the datasets that are included in the topic at page bottom. It also shows when the last time the topic was refreshed at upper right. Refreshing topic indexes 1177 Amazon QuickSight User Guide 3. Choose Refreshed at upper right to refresh the topic index, and then choose Refresh data. Doing this manually refreshes all datasets in the topic. For more information about refreshing individual datasets in a topic, see Refreshing datasets in a QuickSight Q topic. Work with QuickSight Q topics using the Amazon QuickSight APIs Applies to: Enterprise Edition Using the Amazon QuickSight APIs 1178 Amazon QuickSight User Guide Intended audience: Amazon QuickSight developers Use this section to learn how to work with QuickSight Q topics using the Amazon QuickSight command line interface (CLI). Prerequisites Before you begin, make sure that you have an AWS Identity and Access Management (IAM) role that grants the CLI user access to call the QuickSight API operations. The following table shows which permissions must be added to the IAM policy to use specific API operations. To use all of the Q topic API operations, add all of the permissions listed in the table. API operation CreateTopic ListTopics DescribeTopic IAM policy quicksight:CreateTopic quicksight:PassDataSet |
amazon-quicksight-user-332 | amazon-quicksight-user.pdf | 332 | Guide Intended audience: Amazon QuickSight developers Use this section to learn how to work with QuickSight Q topics using the Amazon QuickSight command line interface (CLI). Prerequisites Before you begin, make sure that you have an AWS Identity and Access Management (IAM) role that grants the CLI user access to call the QuickSight API operations. The following table shows which permissions must be added to the IAM policy to use specific API operations. To use all of the Q topic API operations, add all of the permissions listed in the table. API operation CreateTopic ListTopics DescribeTopic IAM policy quicksight:CreateTopic quicksight:PassDataSet quicksight:ListTopics quicksight:DescribeTopic DescribeTopicPermissions quicksight:DescribeTopicPer missions DescribeTopicRefresh quicksight:DescribeTopicRefresh DeleteTopic UpdateTopic quicksight:DeleteTopic quicksight:UpdateTopic quicksight:PassDataSet UpdateTopicPermissions quicksight:UpdateTopicPermi ssions CreateTopicRefreshSchedule quicksight:CreateTopicRefre shSchedule Using the Amazon QuickSight APIs 1179 Amazon QuickSight API operation IAM policy User Guide ListTopicRefreshSchedules quicksight:ListTopicRefresh Schedules DescribeTopicRefreshSchedule quicksight:DescribeTopicRef reshSchedule UpdateTopicRefreshSchedule quicksight:UpdateTopicRefre shSchedule DeleteTopicRefreshSchedule quicksight:DeleteTopicRefre shSchedule BatchCreateTopicReviewedAnswer quicksight:BatchCreateTopic ReviewedAnswer BatchDeleteTopicReviewedAnswer quicksight:BatchDeleteTopic ReviewedAnswer ListTopicReviewedAnswers quicksight:ListTopicReviewe dAnswers The following example shows an IAM policy that allows a user to use the ListTopics API operation. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "quicksight:ListTopics" ], "Resource": "*" } ] } Using the Amazon QuickSight APIs 1180 Amazon QuickSight User Guide After you configure the permissions to create QuickSight Q topics with the QuickSight APIs, use the following topics to create and work with QuickSight Q topic APIs. Topics • Work with QuickSight Q topics using the QuickSight APIs • Configure QuickSight Q topic refresh schedules with the QuickSight CLI • Copy and migrate QuickSight Q topics within and between AWS accounts • Create and modify reviewed answers in QuickSight Q topics with the QuickSight APIs Work with QuickSight Q topics using the QuickSight APIs The following example creates a new Q topic. aws quicksight create-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID --topic TOPIC You can also create a new Q topic by using a CLI skeleton file with the following command. For more information about CLI skeleton files, see Using CLI skeleton files in the Amazon QuickSight Developer Guide. aws quicksight create-topic --cli-input-json file://createtopic.json When you create a new Q topic, the dataset refresh configuration is not copied to the topic. To set a topic refresh schedule for your new topic, you can make a create-topic-refresh- schedule API call. For more information about configuring topic refresh schedules with the CLI, see Configure QuickSight Q topic refresh schedules with the QuickSight CLI. After you create your first Q topic, you can update, delete, list, or request a summary of a Q topic. The following example updates a Q topic. aws quicksight update-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID Using the Amazon QuickSight APIs 1181 Amazon QuickSight --topic TOPIC User Guide You can also update a Q topic by using a CLI skeleton file with the following command. For more information about CLI skeleton files, see Using CLI skeleton files in the Amazon QuickSight Developer Guide. aws quicksight update-topic --cli-input-json file://updatetopic.json The following example provides a list of all Q topics in a QuickSight account. aws quicksight list-topics --aws-account-id AWSACCOUNTID The following example deletes a Q topic. aws quicksight delete-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID The following example provides information about how a Q topic was configured. aws quicksight describe-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID The following command updates the permissions of a Q topic. aws quicksight update-topic-permissions --aws-account-id AWSACCOUNTID --topic-id TOPICID --grant-permissions Principal=arn:aws:quicksight:us-east-1:AWSACCOUNTID:user/ default/USERNAME,Actions=quicksight:DescribeTopic --revoke-permissions Principal=arn:aws:quicksight:us-east-1:AWSACCOUNTID:user/ default/USERNAME,Actions=quicksight:DescribeTopic Use the grant-permissions parameter to grant read and author permissions to QuickSight account users. To grant read permissions to an account user, enter the following value: Using the Amazon QuickSight APIs 1182 Amazon QuickSight User Guide "quicksight:DescribeTopic". To grant permissions to an account user, enter the following values: • "quicksight:DescribeTopic" • "quicksight:DescribeTopicRefresh" • "quicksight:ListTopicRefreshSchedules" • "quicksight:DescribeTopicRefreshSchedule" • "quicksight:DeleteTopic" • "quicksight:UpdateTopic" • "quicksight:CreateTopicRefreshSchedule" • "quicksight:DeleteTopicRefreshSchedule" • "quicksight:UpdateTopicRefreshSchedule" • "quicksight:DescribeTopicPermissions" • "quicksight:UpdateTopicPermissions" The RevokePermissions parameter revokes all permissions granted to an account user. The following command describes all permissions from a Q topic. aws quicksight describe-topic-permissions --aws-account-id AWSACCOUNTID --topic-id TOPICID After you create a QuickSight Q topic, you can use the Amazon QuickSight APIs to configure a topic refresh schedule, migrate QuickSight Q topics within or between accounts, and create reviewed answers. Configure QuickSight Q topic refresh schedules with the QuickSight CLI The following command creates a refresh schedule of a Q topic. aws quicksight create-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-arn DATASETARN --refresh-schedule REFRESHSCHEDULE Using the Amazon QuickSight APIs 1183 Amazon QuickSight User Guide After you create a refresh schedule for a Q topic, you can update, delete, list, or request a summary of the topic's refresh schedule. The following command updates the refresh schedule of a Q topic. aws quicksight update-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID --refresh-schedule REFRESHSCHEDULE The following example provides a list of all refresh schedules configured to a Q topic. aws quicksight list-topic-refresh-schedules --aws-account-id AWSACCOUNTID --topic-id TOPICID The following example |
amazon-quicksight-user-333 | amazon-quicksight-user.pdf | 333 | creates a refresh schedule of a Q topic. aws quicksight create-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-arn DATASETARN --refresh-schedule REFRESHSCHEDULE Using the Amazon QuickSight APIs 1183 Amazon QuickSight User Guide After you create a refresh schedule for a Q topic, you can update, delete, list, or request a summary of the topic's refresh schedule. The following command updates the refresh schedule of a Q topic. aws quicksight update-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID --refresh-schedule REFRESHSCHEDULE The following example provides a list of all refresh schedules configured to a Q topic. aws quicksight list-topic-refresh-schedules --aws-account-id AWSACCOUNTID --topic-id TOPICID The following example deletes a topic refresh schedule. aws quicksight delete-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID The following example provides information about how a topic refresh schedule was configured. aws quicksight describe-topic-refresh-schedule --aws-account-id AWSACCOUNTID --topic-id TOPICID --dataset-id DATASETID Copy and migrate QuickSight Q topics within and between AWS accounts You can migrate your QuickSight Q topics from one account to another with the QuickSight command line interface (CLI). Instead of manually replicating the same topic across multiple dashboards, namespaces, or accounts, you can use the QuickSight CLI to reuse the same topic repeatedly. This capability saves QuickSight authors time and creates a standardized topic experience for dashboard readers across multiple dashboards. To migrate Q topics with the QuickSight CLI, use the following procedure Using the Amazon QuickSight APIs 1184 Amazon QuickSight User Guide To migrate a Q topic to another account 1. First, identify the topic that you want to migrate. You can view a list of every Q topic in your QuickSight account with a list-topics API command. aws quicksight list-topics --aws-account-id AWSACCOUNTID 2. After you have a list of Q topics, locate the topic that you want to migrate and make a describe-topic call to receive a JSON structure of the topic's configuration. aws quicksight describe-topic --aws-account-id AWSACCOUNTID --topic-id TOPICID Following is an example of a describe-topic API response. { "Status": 200, "TopicId": "TopicExample", "Arn": "string", "Topic": [ { "Name": "{}", "DataSets": [ { "DataSetArn": "{}", "DataSetName": "{}", "DataSetDescription": "{}", "DataAggregation": "{}", "Filters": [], "Columns": [], "CalculatedFields": [], "NamedEntities": [] } ] } ], "RequestId": "requestId" } 3. Use the JSON response to create a skeleton file that you can input into a new create-topic call in your other QuickSight account. Before you make an API call with your skeleton file, Using the Amazon QuickSight APIs 1185 Amazon QuickSight User Guide make sure to change the AWS account ID and dataset ID in the skeleton file to match the AWS account ID and dataset ID that you are adding the new Q topic to. For more information about CLI skeleton files, see Using CLI skeleton files in the Amazon QuickSight Developer Guide. aws quicksight create-topic --aws-account-id AWSACCOUNTID \ --cli-input-json file://./create-topic-cli-input.json After you make a create-topic call to the QuickSight API, the new topic appears in your account. To confirm that the new topic exists, make a list-topics call to the QuickSight API. If the source topic that was duplicated contains verified answers, the answers are not migrated to the new topic. To see a list of all verified answers that are configured to the original topic, use a describe- topic API call. Create and modify reviewed answers in QuickSight Q topics with the QuickSight APIs After you create a QuickSight Q topic, you can use the QuickSight APIs to create, list, update, and delete reiewed answers for topics. The command below batch creates up to 100 reviewed answers for a QuickSight topic. aws quicksight batch-create-topic-reviewed-answer \ --topic-id TOPICID \ --aws-account-id AWSACCOUNTID \ —answers ANSWERS You can also batch create reviewed answers from a CLI skeleton file with the following command. For more information about CLI skeleton files, see Using CLI skeleton files in the Amazon QuickSight Developer Guide. aws quicksight batch-create-topic-reviewed-answer \ --cli-input-json file://createTopicReviewedAnswer.json The command below lists all reviewed answers in a QuickSight Q topic. aws quicksight list-topic-reviewed-answers \ --aws-account-id AWSACCOUNTID \ --topic-id TOPICID \ Using the Amazon QuickSight APIs 1186 Amazon QuickSight User Guide The example below batch deletes up to 100 reviewed answers from a topic. aws quicksight batch-delete-topic-reviewed-answer \ --topic-id TOPICID \ --aws-account-id AWSACCOUNTID \ —answer-ids: ["AnswerId1, AnswerId2…"] You can also batch create topic reviewed answers form a CLI skeleton file with the following command. For more information about CLI skeleton files, see Using CLI skeleton files in the Amazon QuickSight Developer Guide. aws quicksight batch-delete-topic-reviewed-answer \ --cli-input-json file://deleteTopicReviewedAnswer.json To update a reviewed answer, delete the existing answer from the topic with the batch-delete- topic-reviewed-answer API. Then, use the batch-create-topic-reviewed-answer API to add the updated reviewed answer to the topic. Asking questions with Amazon QuickSight Q Applies to: Enterprise Edition Intended audience: Amazon QuickSight Dashboard subscribers or viewership Important The QuickSight Q search bar provides the classic QuickSight Q&A experience. QuickSight now offers a Generative BI |
amazon-quicksight-user-334 | amazon-quicksight-user.pdf | 334 | form a CLI skeleton file with the following command. For more information about CLI skeleton files, see Using CLI skeleton files in the Amazon QuickSight Developer Guide. aws quicksight batch-delete-topic-reviewed-answer \ --cli-input-json file://deleteTopicReviewedAnswer.json To update a reviewed answer, delete the existing answer from the topic with the batch-delete- topic-reviewed-answer API. Then, use the batch-create-topic-reviewed-answer API to add the updated reviewed answer to the topic. Asking questions with Amazon QuickSight Q Applies to: Enterprise Edition Intended audience: Amazon QuickSight Dashboard subscribers or viewership Important The QuickSight Q search bar provides the classic QuickSight Q&A experience. QuickSight now offers a Generative BI Q&A experience. To learn more about the latest Generative BI experience, see Using Generative BI with Amazon Q in QuickSight. Use the following procedure to ask a question in the Q bar. Asking questions 1187 Amazon QuickSight To ask a question in the Q bar User Guide 1. In the Q bar at the top of any QuickSight page, choose the topic list at left, and then choose the topic that you want to ask questions about. If you're not sure what a topic is about, hover your cursor over the topic name to read a description about it. 2. Enter a question in the Q bar and then press enter on your keyboard. Q presents an answer to your question as a visual. Asking questions 1188 Amazon QuickSight User Guide You can see how Q interpreted your question in the description at the visual's upper left. Here you can see the fields, aggregations, and datasets used to answer the question. 3. (Optional) Change the visual type by choosing the visual types icon at right, and then choosing a visual type. Asking questions 1189 Amazon QuickSight User Guide 4. (Optional) See key data insights and callouts by choosing the lightbulb icon at right. Insights appear in the pane that opens at right. Asking questions 1190 Amazon QuickSight User Guide 5. (Optional) Add a forecast by choosing the lightbulb icon at right, and then turning on Forecast. Choose the settings gear icon that appears at right and use the slider to adjust the forecast timeline. Note Forecasting is only available for answers that contain line charts with a single time series. Asking questions 1191 Amazon QuickSight User Guide 6. (Optional) Undo or redo any changes you make to the answer by choosing the undo or redo arrows in the Q search bar. 7. (Optional) Use the About topic menu to see the topic's name, description, key details, commonly asked questions, and attributes. Choose the info icon that appears at right to access the About topic menu. Asking questions 1192 Amazon QuickSight User Guide Sometimes Q might not interpret your question the way you wanted. When this happens, you can provide feedback on the answer or make suggestions for corrections to the answer. For more information about providing answer feedback, see Providing feedback about Amazon QuickSight Q topics. For more information about correcting answers, see Correcting wrong answers provided by Amazon QuickSight Q. Types of questions supported by Amazon QuickSight Q When asking questions in the Q bar, we recommend phrasing them similarly to the following question types. Question Type Example Dimensional Group Bys Revenue by product Dimensional Filters (Include) Sales for company Date Group Bys Multi Metrics What is the weekly/monthly revenue trend? What is actual revenue compared to goal? KPI-Based Period over Periods (PoPs) What is the revenue difference WoW? Supported question types 1193 Amazon QuickSight Question Type Example User Guide Relative Date Filters Show me revenue trend for the last 12 weeks Date Aggregation Time Range Filters Show me revenue by quarter How many new users do we have since Jan 2020? Top/Bottom Filter Top 10 customers by regional sales last week Period to Date (PtD) and Period over Period (PoP) Growth % in revenue YTD vs last year in California Non-KPI-Based Table Calculations Product with largest WoW growth % Sort Order Products with most revenue last week Aggregate Metrics Filter List Questions OR filters Percent of Total Where Questions When Questions Who Questions Exclude Questions Boolean Questions Customers who spent more than $1M last month Show me all opportunities created last month Show me defect that are open OR older than 3 months What is % of total revenue by product in 2018? Where did we have the most sales in 2020? When did we have more than 50,000 in sales per week? Who made the most sales last month? Show me weekly sales excluding New York Show me the count of open tickets Supported question types 1194 Amazon QuickSight Question Type Forecasting Questions Why Questions User Guide Example Show me a forecast of sales for energy customers Why did student enrollment drop in 2021 in the fall? Fragment Questions Sales details Explicit visual type Sales by region |
amazon-quicksight-user-335 | amazon-quicksight-user.pdf | 335 | OR older than 3 months What is % of total revenue by product in 2018? Where did we have the most sales in 2020? When did we have more than 50,000 in sales per week? Who made the most sales last month? Show me weekly sales excluding New York Show me the count of open tickets Supported question types 1194 Amazon QuickSight Question Type Forecasting Questions Why Questions User Guide Example Show me a forecast of sales for energy customers Why did student enrollment drop in 2021 in the fall? Fragment Questions Sales details Explicit visual type Sales by region last week as a donut chart Pinning visuals in Amazon QuickSight Q Applies to: Enterprise Edition Important QuickSight Q provides the classic QuickSight Q&A experience. QuickSight now offers a Generative BI Q&A experience. To learn more about the latest Generative BI experience, see Using Generative BI with Amazon Q in QuickSight. You can pin visuals for easy access to frequently asked questions. Instead of asking the same question repeatedly, you can add the visual answer to your pinboard and access it in a single click. Pinning visuals also makes it easier to share interesting insights and collaborate on data narratives with other users. From within your pinboard, you can share any visual with others through a URL. Use the topics below to create pins and use your pinboard. Topics • Pinning a visual to your Amazon QuickSight pinboard • Using your Amazon QuickSight pinboard Pinning visuals 1195 Amazon QuickSight User Guide Pinning a visual to your Amazon QuickSight pinboard To pin a visual to your pinboard 1. At the Q bar at the top of any QuickSight page, choose the topic list at the left, and then 2. 3. choose the topic that you want to ask questions about. Enter a question into the Q bar, then press Enter. In the visual that appears as the answer to your question, choose the Pin visual icon on the right side of the visual. When you pin a visual to our pinboard, a green notification appears in the bottom-right corner of the page informing you that the Visual has been pinned. Additionally, the Pin visual icon turns blue. You can pin up to 30 visuals to your pinboard. Pin visuals 1196 Amazon QuickSight User Guide Using your Amazon QuickSight pinboard To access your pinboard, choose the Pin board icon on the right side of the Q search bar. After you pin a visual to your pinboard, you can rename the visual, share the visual using a link with other users in your account, or you can remove the visual from your pinboard. Use the procedures in the topics below to perform different actions with your pinboard. Topics • Rename a visual in your pinboard • Share a visual in your pinboard Using your pinboard 1197 Amazon QuickSight • Remove a visual User Guide Rename a visual in your pinboard Use the procedure below to rename a visual in your pinboard. To rename a visual in your pinboard 1. On any page in QuickSight, choose the Pinboard icon on the right side of the Q search bar to open your pinboard. 2. Browse to the visual that you want to remove and choose the three dots icon in the upper- right corner to display more actions. Open the on-visual menu. 3. Choose Rename, and then enter the new name that you want to use for the visual. Share a visual in your pinboard Use the procedure below to share a visual in your pinboard. To share a visual in your pinboard 1. On any page in QuickSight, choose the Pinboard icon on the right side of the Q search bar to open your pinboard. 2. Browse to the visual that you want to remove and choose the three dots icon in the upper- right corner to display more actions. Open the on-visual menu. Using your pinboard 1198 Amazon QuickSight User Guide 3. Choose Share via link, and then choose Copy link. Only people with topic access can access the link. Remove a visual Use the procedure below to remove a visual from your pinboard. To remove a visual from your pinboard 1. On any page in QuickSight, choose the Pinboard icon on the right side of the Q search bar to open your pinboard. 2. Browse to the visual that you want to remove and then choose the three dots icon in the upper-right corner to display more actions. Open the on-visual menu. 3. Choose Remove. You can also remove the visual from your pinboard. To do so, enter the question that returns the visual into the Q search bar and clear the blue Pin visual icon located on the right side of the visual. Using your pinboard 1199 Amazon QuickSight User Guide |
amazon-quicksight-user-336 | amazon-quicksight-user.pdf | 336 | any page in QuickSight, choose the Pinboard icon on the right side of the Q search bar to open your pinboard. 2. Browse to the visual that you want to remove and then choose the three dots icon in the upper-right corner to display more actions. Open the on-visual menu. 3. Choose Remove. You can also remove the visual from your pinboard. To do so, enter the question that returns the visual into the Q search bar and clear the blue Pin visual icon located on the right side of the visual. Using your pinboard 1199 Amazon QuickSight User Guide Providing feedback about Amazon QuickSight Q topics Applies to: Enterprise Edition Intended audience: Amazon QuickSight Dashboard subscribers or viewership Important The QuickSight Q search bar provides the classic QuickSight Q&A experience. QuickSight now offers a Generative BI Q&A experience. To learn more about the latest Generative BI experience, see Using Generative BI with Amazon Q in QuickSight. When you ask a question in the Amazon QuickSight Q bar, you can provide feedback on the answer Q provides. Providing feedback helps topic owners review how the topic is performing and make improvements where possible. Use the following procedure to provide feedback on a Q answer when you receive it. Providing feedback 1200 Amazon QuickSight User Guide To provide feedback on a Q answer • Choose the thumbs-up or thumbs-down icon at lower right. For negative feedback, you can leave a comment describing what's wrong with the answer. Your comment is sent to the topic owner, along with your question and the visual you received in response. Leaving a comment helps improve Q, even if you don't receive a response from the topic owner. To leave a comment with your feedback 1. Choose Leave a comment, tell us what's wrong. 2. On the Provide additional feedback page that opens, for What didn't look right?, choose one of the following reasons from the list: Providing feedback 1201 Amazon QuickSight User Guide • Disambiguation didn't provide option I wanted • The question was misinterpreted • Data was not filtered correctly • The answer is irrelevant • The question was interpreted correctly, but the answer is wrong • The wrong dimension was displayed • Graph type was wrong • Periodicity was wrong (daily, weekly, etc.) 3. For To: Topic owner, enter a message describing what didn't look right. 4. When finished, choose Send. You can also make suggestions to improve answers. For more information, see Correcting wrong answers provided by Amazon QuickSight Q. Correcting wrong answers provided by Amazon QuickSight Q Applies to: Enterprise Edition Intended audience: Amazon QuickSight Dashboard subscribers or viewership When you ask a question in the Q bar, Q identifies terms in your question and links them to the appropriate data fields to give you an answer. Sometimes, Q doesn't understand your question, or misinterprets your question and answers it with the wrong data. When this happens, you can make the following corrections to teach Q how to answer your question correctly: • Define terms in your question by linking them to the appropriate fields. • Adjust to how Q uses a field to answer your question. • Customize the visual you receive as an answer. • Manually link an existing visual to a question. Correcting answers 1202 Amazon QuickSight User Guide For more information, see the topics listed below. Topics • Correcting wrong answers in Amazon QuickSight • What to do when QuickSight Q can't provide an answer • Saving corrections to an Amazon QuickSight Q answer Correcting wrong answers in Amazon QuickSight When Q gets an answer wrong, there a few things you can do. Following are your options. 1. Define unrecognized terms in your question When Q doesn't recognize a term in your question or interprets a term incorrectly, either link the term to the correct field or tell Q to ignore the term. If you're an author, you can also add a filter to the term or link the term to a calculated field you create. To define unrecognized terms 1. 2. In the Q bar, highlight the term that you want to define, and then choose Define this term. In the What did you mean? menu that appears, choose a field from the list. Correcting wrong answers 1203 Amazon QuickSight User Guide To correct a term that Q got wrong, or to update a term • In the Q bar, choose the term that Q got wrong, and then choose a field from the list. Correcting wrong answers 1204 Amazon QuickSight User Guide To remove a term that Q got wrong • In the Q bar, choose the term that Q got wrong, and then choose Skip this term. Correcting wrong answers 1205 Amazon QuickSight User Guide To add a filter to the dataset and link |
amazon-quicksight-user-337 | amazon-quicksight-user.pdf | 337 | that appears, choose a field from the list. Correcting wrong answers 1203 Amazon QuickSight User Guide To correct a term that Q got wrong, or to update a term • In the Q bar, choose the term that Q got wrong, and then choose a field from the list. Correcting wrong answers 1204 Amazon QuickSight User Guide To remove a term that Q got wrong • In the Q bar, choose the term that Q got wrong, and then choose Skip this term. Correcting wrong answers 1205 Amazon QuickSight User Guide To add a filter to the dataset and link it to a term (QuickSight authors only) 1. In the Q bar, choose the term that you want, and then choose Add a filter. This opens the filter configuration page in the Data tab in a separate window. Correcting wrong answers 1206 Amazon QuickSight User Guide 2. On the Filter configuration page that opens, do the following, and then choose Save. a. b. c. For Name, enter a name for the filter. For Dataset, choose a dataset from your topic. For Field, choose a field from the dataset. d. Depending on the type of field you chose, do one of the following: • If you chose a dimension, choose a Filter type. • If you chose a measure, choose an Aggregation, choose a Rule for the aggregation, and then enter a value. e. (Optional) Select Apply the filter anytime the dataset is used. You can choose to always apply the filter any time the dataset is used. Or you can choose to always apply the filter any time the dataset is used unless a question results in an explicit filter from the dataset. After you save the filter, it appears in your list of fields in the Data tab. You can then assign the filter to the term in the Q bar. For more information about adding filters to datasets in a topic, see Adding filters to a Amazon QuickSight Q topic dataset. To add a calculated field to a topic and link it to a term (QuickSight authors only) 1. In the Q bar, choose the term, and then choose Add a calculated field. Correcting wrong answers 1207 Amazon QuickSight User Guide The calculation editor opens in a new window. 2. In the calculation editor, enter a name for the calculated field. The term that you highlighted is used as the name of the calculated field by default, but you can change it. 3. Enter a calculation in the editor. For more information about the functions and operations that you can use to create calculations, see Calculated field function and operator reference for Amazon QuickSight . 4. When finished, choose Save. After you save the calculated field, it appears in your list of fields in the Data tab. You can then assign the calculated field to the term in the Q bar. For more information about adding calculated fields to topics, see Adding calculated fields to a Amazon QuickSight Q topic dataset. Correcting wrong answers 1208 Amazon QuickSight 2. Adjust how Q uses a field User Guide Sometimes Q links a term to the correct field, but it uses it incorrectly in the answer. Q might use the wrong aggregation or data type. If this happens, you can correct how Q uses the field in the answer. To change the field aggregation • In the answer in the Q bar, choose the description of the field, choose Aggregation, and then choose the aggregation that you want Q to use for your answer. To remove a field from being used in the answer • In the answer in the Q bar, choose the field, and then choose Remove from answer. Correcting wrong answers 1209 Amazon QuickSight User Guide 3. Customize a visual You can customize the visual used for an answer if the visual that Q uses isn't what you expect. To change the sort order in the visual • In the answer in the Q bar, choose the field that you want to change the sort order for, choose Sorted by, and then choose a sort order. Correcting wrong answers 1210 Amazon QuickSight User Guide To change the number format in the visual • In the answer in the Q bar, choose the field to change the number formatting for, choose Format, and then choose the format and decimal places. Correcting wrong answers 1211 Amazon QuickSight User Guide To change the visual axis • In the answer in the Q bar, choose the chart axis, and then choose a field. Correcting wrong answers 1212 Amazon QuickSight User Guide To change the chart type • In the answer in the Q bar, choose the chart type icon at right, and then choose the chart type that you want. Correcting wrong |
amazon-quicksight-user-338 | amazon-quicksight-user.pdf | 338 | format in the visual • In the answer in the Q bar, choose the field to change the number formatting for, choose Format, and then choose the format and decimal places. Correcting wrong answers 1211 Amazon QuickSight User Guide To change the visual axis • In the answer in the Q bar, choose the chart axis, and then choose a field. Correcting wrong answers 1212 Amazon QuickSight User Guide To change the chart type • In the answer in the Q bar, choose the chart type icon at right, and then choose the chart type that you want. Correcting wrong answers 1213 Amazon QuickSight User Guide What to do when QuickSight Q can't provide an answer Sometimes Q can't provide an answer, even if you try to make corrections. When this happens, you can manually link the question to a visual from an existing dashboard. This is called creating a linked answer. Use the following procedure to create a linked answer. To create a linked answer 1. In the answer in the Q bar, choose Link to visual. 2. On the page that opens, go to the visual that you want to link the answer to and then choose Link Visual. The linked visual appears as the answer to the question. From here, you can edit the link to the visual or add question variants. What to do when Q can't provide an answer 1214 Amazon QuickSight User Guide Question variants are questions that return the same reviewed answer. To add a question variant to a linked visual, choose Edit question variants, choose Add new variant, enter a question, and then choose Save variant. Saving corrections to an Amazon QuickSight Q answer When you change an answer, it's saved as an improvement suggestion and a notification appears next to the improvement suggestion icon. You can choose to save or dismiss these changes. To save or dismiss corrections to an answer 1. In the answer in the Q bar, choose the improvement suggestion icon. 2. On the Improvement suggestions pane that opens, choose the change that you want to save or dismiss. Choose Save to save the changes, or choose Dismiss to dismiss the changes. Verifying Amazon QuickSight Q answers Applies to: Enterprise Edition Intended audience: Amazon QuickSight administrators and authors Saving corrections to a Q answer 1215 Amazon QuickSight User Guide To improve the accuracy of the answers that Q provides for your readers, you can review your readers' questions and verify those that were answered correctly. Verifying an answer to a specific question lets your readers know that the answer to that question is accurate. Verifying answers to questions You can review the questions your readers ask and verify correct answers to them. Verified answers appear at the top of the list of questions that display in the Q bar when someone begins entering a question. To verify a Q answer 1. Open the topic that you want to review answers for. 2. In the topic, choose the User Activity tab. 3. On the User Activity tab, under Question, choose a question that you want to review the answer for, and then choose View. 4. In the answer that appears in the Q bar, do one of the following: • Choose Mark as reviewed. • Choose Link to visual, and then select a visual from an existing dashboard to use for the answer. Reviewing verified answers You can review questions with answers that were verified or linked to visuals in existing dashboards on the Verified Answers tab of a topic. You can see the question and view its answer. You can also review how many times the question was asked, and see whether your readers found the verified answer to it helpful. You can see who validated the answer and how long ago they did so. You can also see which fields and datasets were used to answer the question. You can also remove a question from the verified answers list. To review verified answers 1. Open the topic that you want to review. 2. In the topic, choose the Verified Answers tab. Verifying answers to questions 1216 Amazon QuickSight User Guide 3. On the Verified Answers tab, choose the down arrow at far right to expand information about the question that you want to review. From here, you can do the following: • To view the answer for a question, choose View. • To view the fields used to answer a question, and possibly change the field metadata, choose the field at right. Reviewing verified answers 1217 Amazon QuickSight User Guide • To remove a question from the verified answers list, choose Remove at lower right. Managing Amazon QuickSight Q regions Applies to: Enterprise Edition Intended audience: System administrators and Amazon QuickSight administrators Managing Q regions 1218 Amazon |
amazon-quicksight-user-339 | amazon-quicksight-user.pdf | 339 | the down arrow at far right to expand information about the question that you want to review. From here, you can do the following: • To view the answer for a question, choose View. • To view the fields used to answer a question, and possibly change the field metadata, choose the field at right. Reviewing verified answers 1217 Amazon QuickSight User Guide • To remove a question from the verified answers list, choose Remove at lower right. Managing Amazon QuickSight Q regions Applies to: Enterprise Edition Intended audience: System administrators and Amazon QuickSight administrators Managing Q regions 1218 Amazon QuickSight Important User Guide The QuickSight Q add-on is no longer available in Amazon QuickSight. For more information about opting out of QuickSight Q, see Opting out of Amazon Q in QuickSight. To learn more about the latest Generative BI experience, see Using Generative BI with Amazon Q in QuickSight. Unsubscribing from Q Important The QuickSight Q add-on is no longer available in Amazon QuickSight. For more information about opting out of QuickSight Q, see Opting out of Amazon Q in QuickSight. To learn more about the latest Generative BI experience, see Using Generative BI with Amazon Q in QuickSight. Unsubscribe from Q 1219 Amazon QuickSight User Guide Using Generative BI with Amazon Q in QuickSight Note Powered by Amazon Bedrock: Amazon Q in QuickSight is built on Amazon Bedrock and includes automated abuse detection implemented in Amazon Bedrock to enforce safety, security, and the responsible use of AI. Amazon Q integrates with Amazon QuickSight to give QuickSight users access to a suite of new Generative BI capabilities. With Amazon Q in QuickSight, you can utilize the Generative BI authoring experience, create executive summaries of your data, ask and answer questions of data, and generate data stories. To access all QuickSight Generative BI features that are relevant to your task, choose the Q icon at the top right of any QuickSight page. In the Q pane that opens, Amazon Q displays all content that is available based on the context of the task that you are performing. For example, if you're working in an Analysis, you can build a calculation, edit visuals, set up Q&A, or ask questions about your data. If you're working in a Dashboard, you can build a data story, generate an executive summary, or ask questions about the dashboard. The image below shows the Q icon that opens the Q pane. Note Amazon Q in QuickSight Generative BI features are not available in all AWS regions. To see a list of regions that Generative BI features are available in, see Supported AWS Regions for Amazon Q in QuickSight Use the following topics to learn more about Generative BI with Amazon Q in QuickSight. Topics 1220 User Guide Amazon QuickSight • Get started with Generative BI • Augmenting Amazon QuickSight insights with Amazon Q Business • The Generative BI authoring experience • Creating executive summaries with Amazon Q in QuickSight • Authoring Q&A • Turn on the Dashboard Q&A experience in Amazon QuickSight • Asking and answering questions of data with Amazon Q in QuickSight • Opting out of Amazon Q in QuickSight • Working with data stories in Amazon QuickSight • Working with scenarios in Amazon QuickSight Get started with Generative BI To get started with Amazon Q in QuickSight Generative BI capabilities, upgrade your account's users to Admin Pro, Author Pro, or Reader Pro roles. Pro roles grant users access to all Generative BI capabilities that are relevant to the role that's assigned to the user. Pro users can share generative Q&A topics with anoTo understand which Generative BI capabilities are available to the different user roles in QuickSight, see the table below. For more information about QuickSight Pro roles, see Amazon QuickSight Pricing. Note Non-Pro Authors and Readers can still access Generative Q&A topics if an Author Pro or Admin Pro user shares the topic with them. Non-Pro Authors and Readers can also access data stories if a Reader Pro, Author Pro, or Admin Pro shares one with them. Feature name Feature descripti on Creating a data Build data story stories Reader Author Admin Reader Pro Author Pro Admin Pro No No No Yes Yes Yes Get started 1221 Amazon QuickSight User Guide Reader Author Admin Reader Pro Author Pro Admin Pro Yes* Yes* Yes* Yes Yes Yes Feature name Feature descripti on that explain your with Amazon Q in QuickSigh data with t visuals, insights, and ideas to help improve your business. Viewing a View narrative generated data data stories story in that are Amazon shared QuickSigh with you. t Get started 1222 Amazon QuickSight User Guide Reader Author Admin Reader Pro Author Pro Admin Pro No No No No Yes Yes Yes* Yes* Yes* Yes Yes Yes Feature name Feature descripti on |
amazon-quicksight-user-340 | amazon-quicksight-user.pdf | 340 | Yes Yes Get started 1221 Amazon QuickSight User Guide Reader Author Admin Reader Pro Author Pro Admin Pro Yes* Yes* Yes* Yes Yes Yes Feature name Feature descripti on that explain your with Amazon Q in QuickSigh data with t visuals, insights, and ideas to help improve your business. Viewing a View narrative generated data data stories story in that are Amazon shared QuickSigh with you. t Get started 1222 Amazon QuickSight User Guide Reader Author Admin Reader Pro Author Pro Admin Pro No No No No Yes Yes Yes* Yes* Yes* Yes Yes Yes Feature name Feature descripti on Authoring Q&A Create and refine topics that utilize Generativ e Q&A for QuickSigh t dashboard s. Asking and Ask questions answering about questions data to of data accelerat with Amazon e data driven Q in decisions QuickSigh with t multi- visual answers. Get started 1223 Amazon QuickSight User Guide Reader Author Admin Reader Pro Author Pro Admin Pro No No No Yes Yes Yes No No No No Yes Yes Feature name Feature descripti on Creating executive Get an executive summaries summary with of key Amazon insights Q in from a QuickSigh QuickSigh t t dashboard . The Generativ Create an analysis e BI to build authoring visuals, experienc calculati e ons, and refine existing visuals with natural language. *Non-pro roles in accounts that were created on or after April 30, 2024 can access Q&A topics that are shared with them. If your QuickSight account was created before April 30, 2024 and you want to opt-in to this new feature, contct your AWS account team. For more information about non pro- role pricing for accounts created after April 30, 2024, see Amazon QuickSight Pricing. Any QuickSight administrator can upgrade a user to a Pro role with the following procedure. Get started 1224 Amazon QuickSight To upgrade a user to a Pro role 1. Open the QuickSight console. User Guide 2. Choose the user icon at the top right, and then choose Manage QuickSight. 3. Choose Manage users to open the Manage Users page. 4. To change the role of an existing user, locate that user on the Manage Users table and choose the role that you want to grant them from the Role dropdown. The image below shows the Manage users table with the Role dropdown opened. For more information about managing QuickSight users, see Managing user access inside Amazon QuickSight. Augmenting Amazon QuickSight insights with Amazon Q Business Amazon QuickSight account admins can connect their QuickSight account to Amazon Q Business to augment insights with unstructured data sources. Amazon Q Business is a generative AI assistant that helps your team work smarter. It can answer questions, provide summaries, generate content, and securely complete tasks based on the information in your enterprise systems. When an Amazon QuickSight account is integrated with Amazon Q Business, users can now leverage this vast repository of organizational knowledge alongside their structured data analytics. This integration allows for more comprehensive and context-rich insights, as it combines Augmenting Amazon QuickSight insights with Amazon Q Business 1225 Amazon QuickSight User Guide quantitative data from QuickSight with qualitative information from various business documents and applications. For more information about connecting your Amazon Q Business account with Amazon QuickSight, see Creating an Amazon QuickSight-integrated application. Use the following topics to configure an Amazon Q Business application in Amazon QuickSight. Topics • Considerations • Configuring an Amazon Q Business application in Amazon QuickSight • Connect an Amazon QuickSight account to an existing Amazon Q Business application • Disconnect an Amazon Q Business application from an Amazon QuickSight account Considerations The following limitations apply to the Amazon Q Business application. • Amazon QuickSight and Amazon Q Business must exist in the same AWS account. Cross account calls are not supported. • Amazon QuickSight and Amazon Q Business accounts need to exist in the same AWS Region. Cross Region calls are not supported. For a list of all supported QuickSight Regions, see Supported AWS Regions for Amazon Q in QuickSight. For a list of all supported Amazon Q Business Regions, see Service quotas for Amazon Q Business. If your Amazon QuickSight account exists in more than one Region, you can connect one Amazon Q Business application from each Region to the QuickSight account. For example, if your QuickSight account exists in US East (N. Virginia) and US West (Oregon), one Amazon Q Business application located in US East (N. Virginia) and one Amazon Q Business application located in US West (Oregon) can be connected to the QuickSight account. • Amazon QuickSight and Amazon Q Business accounts that are integrated need to use the same identity methods. For example, if a QuickSight account uses IAM Identity Center for identity management, the Amazon Q Business account that it is integrating with must also use |
amazon-quicksight-user-341 | amazon-quicksight-user.pdf | 341 | Amazon Q Business application from each Region to the QuickSight account. For example, if your QuickSight account exists in US East (N. Virginia) and US West (Oregon), one Amazon Q Business application located in US East (N. Virginia) and one Amazon Q Business application located in US West (Oregon) can be connected to the QuickSight account. • Amazon QuickSight and Amazon Q Business accounts that are integrated need to use the same identity methods. For example, if a QuickSight account uses IAM Identity Center for identity management, the Amazon Q Business account that it is integrating with must also use IAM Identity Center for identity management. • Email addresses that are associated with QuickSight users and groups are used to perform authorization checks in Amazon Q Business. Considerations 1226 Amazon QuickSight User Guide Configuring an Amazon Q Business application in Amazon QuickSight Use the following procedure to connect an Amazon QuickSight account with Amazon Q Business 1. Open the QuickSight console. 2. Choose the user icon at the top right, and then choose Manage QuickSight. 3. Choose Security & permissions. 4. On the QuickSight access to AWS services page, choose the Amazon Q Business application checkbox. 5. On the Create an Amazon Q Business connection to unstructured data popup that appears, choose the QuickSight Region that you want your connection to be in. 6. Choose Done. 7. When you choose Done, your Amazon Q Business account is created and you are redirected to a new tab that shows the Applications page of the Amazon Q Business console. 8. 9. 10. For Applications, choose the Amazon Q Business connection that you created in Amazon QuickSight. The Application details page of your connection opens. Choose the Index tab, and then choose Select index. In the popup that appears, choose the Index provisioning option that you want to use, and then choose Confirm. For more information about indexes in Amazon Q Business, see Creating a retriever for an Amazon Q Business application. 11. After you choose an index, set up a data source connection. To set up a data source connection, choose the Data sources section of the Enhancements menu in the left side pane. 12. Choose Add data source. 13. Choose the data source that you want to add. The data source that you choose determines the steps that are required to configure the data source connection. For more infotmation about adding a data source to an Amazon Q Business account, see Connecting Amazon Q Business data sources. When you finish setting up the data source configuration, choose Add data source. After you choose an index, a retriever, and a data source for your Amazon Q Business account, your connection to Amazon Q Business is complete and you can return to the QuickSight console. Create a new Amazon Q Business application in QuickSight 1227 Amazon QuickSight User Guide Connect an Amazon QuickSight account to an existing Amazon Q Business application If you already have an Amazon Q Business application that uses the same identity management and exists in the same Region as your QuickSight account, use the following procedure to link the existing Amazon Q Business account to Amazon QuickSight. 1. Open the QuickSight console. 2. Choose the user icon at the top right, and then choose Manage QuickSight. 3. Choose Security & permissions. 4. On the QuickSight access to AWS services page, choose the Amazon Q Business application checkbox. 5. On the Create an Amazon Q Business connection to unstructured data popup that appears, choose the QuickSight Region that you want your connection to be in. 6. Choose your existing Amazon Q Business application from the dropdown. Note Your Amazon Q Business application does not appear if the application exists in a different Region than your QuickSight account or if the application uses a different identity management option than your QuickSight account. After you choose your Amazon Q Business application from the dropdown, the connection between QuickSight and Amazon Q Business is configured. Disconnect an Amazon Q Business application from an Amazon QuickSight account Amazon QuickSight account admins can use the following procedure to disconnect an Amazon Q Business application from an Amazon QuickSight account. 1. Open the QuickSight console. 2. Choose the user icon at the top right, and then choose Manage QuickSight. 3. Choose Security & permissions. 4. On the QuickSight access to AWS services page, choose SELECT APPLICATION. Connect QuickSight to an existing Amazon Q Business application 1228 Amazon QuickSight User Guide 5. Perform one of the following options: a. To disconnect a single Amazon Q Business application from a QuickSight account, navigate to the application that you want to remove, open the dropdown, and choose NONE. b. To disconnect all Amazon Q Business applications from a QuickSight account, uncheck the Amazon Q Business application checkbox. When you |
amazon-quicksight-user-342 | amazon-quicksight-user.pdf | 342 | Choose the user icon at the top right, and then choose Manage QuickSight. 3. Choose Security & permissions. 4. On the QuickSight access to AWS services page, choose SELECT APPLICATION. Connect QuickSight to an existing Amazon Q Business application 1228 Amazon QuickSight User Guide 5. Perform one of the following options: a. To disconnect a single Amazon Q Business application from a QuickSight account, navigate to the application that you want to remove, open the dropdown, and choose NONE. b. To disconnect all Amazon Q Business applications from a QuickSight account, uncheck the Amazon Q Business application checkbox. When you disconnect an Amazon Q Business application from a QuickSight account, the Amazon Q Business application that you created for QuickSight is not deleted. The application, index, retriever, and any unstructured data source connections that you configured remain in your Amazon Q Business account. The Generative BI authoring experience With Amazon Q in QuickSight, authors can use new Generative BI capabilities to build calculated fields and to build and refine visuals. Use the following topics to learn more about the Generative BI authoring experience. Topics • Build visuals with Generative BI • Build calculations with Generative BI • Refine visuals with generative BI Authoring experience 1229 Amazon QuickSight User Guide Build visuals with Generative BI QuickSight authors can use the Build a visual button to build a custom visual that's generated from author input. The author's input uses natural language to describe the desired outcome for the new visual. You can enter a custom description, or you can choose from a list of generated suggestions that Amazon Q has generated for the topic that's attached to the analysis. The following image shows a custom visual that's created with the Build a visual menu. Build visuals 1230 Amazon QuickSight User Guide Prerequisites Before you get started, create and attach an QuickSight Q topic to the analysis that you want to work in. For more information about creating topics in QuickSight Q,see Working with Amazon QuickSight Q topics. To build a visual with Generative BI 1. Navigate to the analysis that you want to work in and choose Ask Q to build a visual. 2. In the Build a visual panel that appears, perform the following steps. a. Describe the data that you want to visualize. You can enter a custom description, or you can choose from the Suggested questions that are generated based on the analysis' data. Build visuals 1231 Amazon QuickSight User Guide When you describe the data that you want to visualize, you can phrase it as a question, or you can use conversational phrases or filters. For example, you can enter "How many people signed up for a free trial last month?" or "Free trial sign ups by month." Both statements generate a visual that shows the number of free trial sign-ups by month. Amazon Q can also respond to vague language or keyword style requests. Suggested questions can include a mix of artificial intelligence (AI) generated questions and human verified questions. Human verified questions appear with a check mark next to the suggestion. b. Choose Build. c. Review the visual that Amazon Q generates. To refine the data presented in the visual, enter a new description into the Build bar, and then choose Build. Use the forward and back arrows to review the changes made to the visual without losing any progress. d. When you're satisfied with the visual, choose ADD TO ANALYSIS. Build visuals 1232 Amazon QuickSight User Guide Build visuals 1233 Amazon QuickSight User Guide Build calculations with Generative BI With Generative BI, you can use natural language prompts to create calculated fields in Amazon QuickSight, as shown in the following image. For more information about calculated fields in analyses, see Adding calculated fields. To build a calculated field with Generative BI 1. Navigate to the analysis that you want to work in and choose Data from the toolbar at the top of the page. Then choose Add calculated field. 2. In the calculation editor that appears, choose Build. 3. Describe the calculation outcome that you want to achieve. For example, "year over year percent change in daily sales." 4. Choose BUILD. 5. Review the expression that's returned, and then choose Insert to add it to the expression editor. You can also choose the Copy icon to copy the expression to your clipboard. To delete the expression and start over, choose the Delete icon next to the expression. 6. When you're finished, close the editor. After you add a calculation to the expression editor, you must name the calculation before you can save it. Refine visuals with generative BI QuickSight authors can also use natural language prompts to edit visuals in an analysis, as shown in the following visual. Authors can use this functionality to edit |
amazon-quicksight-user-343 | amazon-quicksight-user.pdf | 343 | that's returned, and then choose Insert to add it to the expression editor. You can also choose the Copy icon to copy the expression to your clipboard. To delete the expression and start over, choose the Delete icon next to the expression. 6. When you're finished, close the editor. After you add a calculation to the expression editor, you must name the calculation before you can save it. Refine visuals with generative BI QuickSight authors can also use natural language prompts to edit visuals in an analysis, as shown in the following visual. Authors can use this functionality to edit visuals without performing manual tasks in the QuickSight UI. Authors can only use Generative BI to perform formatting tasks that are currently supported in QuickSight, even if Amazon Q asks for otherwise. Build calculations 1234 Amazon QuickSight User Guide The following types of edit are supported: • Change a visual's type. • Show or hide axis titles, axis labels, or data labels. • Show, hide, or change the title of a chart. • Change axis and table column names. • Add fields or field wells to a visual. • Remove fields from a visual. • Change the aggregation of an axis. • Show or hide legends and grid lines. • Show or hide data zoom. • Add fields or field wells to a visual. • Change or remove a visual's sort controls. • Update the conditional formatting of a visual's colors, color gradients, background color, or text color. • Change the time granularity of a visual. • Adjust axis scaling and range, as well as maximum and minimum values. • Change font sizes of titles and subtitles. • Show, hide, and adjust data labels. • Adjust column formatting (change between number, percent, date, and currency). Refine visuals 1235 Amazon QuickSight User Guide To edit a visual with Generative BI 1. Navigate to the visual that you want to edit, and then choose Edit with Q. 2. Describe the task that you want performed, and then choose APPLY. 3. Review the visual changes. If you're satisfied with the generated changes, close the Edit visual modal. To undo the changes, choose Undo and enter a new prompt. Creating executive summaries with Amazon Q in QuickSight With Amazon Q in QuickSight, you can leverage large language models (LLMs) to generate executive summaries of dashboards. Executive summaries are based on QuickSight's suggested insights for a dashboard. Executive summaries help readers find key insights at a glance without the need to pinpoint specific data from a dashboard's visuals. To turn on executive summaries for a dashboard, turn on Allow executive summary on the Publish a dashboard modal. For more information about how readers can interact with executive summaries, see Generate an executive summary of an Amazon QuickSight dashboard. Executive summaries 1236 Amazon QuickSight User Guide Executive summaries work best when an analysis has multiple suggested insights. To see a list of all suggested insights for an analysis, navigate to the analysis that you want to work in, and then open the Insights pane. Authoring Q&A Converting to the Generative Q&A experience If you have existing Amazon Q topics, you can easily convert these to leverage our new generative capabilities. Navigate to a topic, and then choose Convert next to the topic name. You will then be prompted to Duplicate & Convert Topic in a dialog box. We duplicate your topic for you so that the conversion to our beta experience does not impact your end users. Once you are satisfied with topic performance in the new experience, you can unshare the original topic and share the new one. Named entities Named entities are one of the most important components of topic curation. The information contained in named entities — specifically, the ordering of fields and their ranking — is what makes it possible to present contextual, multi-visual answers in response to even vague questions. Authoring Q&A 1237 Amazon QuickSight User Guide Authors can find named entities by navigating to a topic, choosing the Data tab, and then choosing the Named Entities. From here, authors can preview or edit existing named entities, and create new ones. Authors can configure the following facets of named entities: 1. 2. Fields: Choose a dataset, and then choose which fields from that dataset to include. This defines the scope of data that will be considered when using this named entity to answer enduser questions. Field Rank and Presentation: The relative rank of the dimensions and measures in a named entity determines how those fields are used when generating contextual, multi-visual answers. Note in the following demo that adjusting the relative rank of Profit so that it is higher than Sales leads to different data being displayed. By default, the order of fields in the table visual is the same as |
amazon-quicksight-user-344 | amazon-quicksight-user.pdf | 344 | 2. Fields: Choose a dataset, and then choose which fields from that dataset to include. This defines the scope of data that will be considered when using this named entity to answer enduser questions. Field Rank and Presentation: The relative rank of the dimensions and measures in a named entity determines how those fields are used when generating contextual, multi-visual answers. Note in the following demo that adjusting the relative rank of Profit so that it is higher than Sales leads to different data being displayed. By default, the order of fields in the table visual is the same as the field rank. However, you can control these two individually by turning off Sync table view with field ranking. 3. Show / Hide in Presentation: Fields that are included in named entities can simultaneously be hidden from the tabular presentation of the named entity, while still providing additional context in other components of the answer. Named entities 1238 Amazon QuickSight User Guide Measure aggregations Authors have fine-grained control over how Amazon Q aggregates measures in topics. Across QuickSight, measures are defaulted to SUM,unless they have custom aggregations defined in a calculated expression. To change this in Q, navigate to the measure in the list of data fields, and specify a different default aggregation. You can also disallow aggregations, which will prevent Measure aggregations 1239 Amazon QuickSight User Guide them from being applied even if a user specifically asks for them. Lastly, you can specify that a measure is non-additive. This is useful for pre-computed metrics, such as percentages, which should not be re-combined in any way. Doing so will force Amazon Q MEDIAN or AVG depending on your use case. Turn on the Dashboard Q&A experience in Amazon QuickSight Amazon QuickSight allows any Author to enable Q&A directly from their dashboards in one click without the need to create a Topic in QuickSight. To do this, publish your dashboard and check the Allow data Q&A checkbox from the dashboard publishing menu. When you turn on dashboard Q&A, you can choose which datasets to use for dashboard Q&A to ensure that your end users get the answers they need. Dashboard Q&A uses the data values that are rendered on the dashboard. End users can ask for different slices of the same data that they see on the dashboard. For example, the dashboard might include a KPI visual that shows the month-over-month change in revenue, but the user might want to see the year-over-year change. The user can do this by asking a question that references the fields and values present on the dashboard. The user does not need to know the exact field and value names that are used in the raw data. The following table compares feature availability between dashboard Q&A and topic Q&A. Turn on the Dashboard Q&A experience in Amazon QuickSight 1240 Amazon QuickSight User Guide Q&A feature Dashboard Q&A Topic Q&A Allows users in all roles to ask and answer questions of data Allows author and admin roles to enable data Q&A on dashboards Suported in QuickSight console embedding Ability to add reviewed answers Ability to customize Q&A- specific metadata Ability to support autocompl ete for data values Yes Yes No No No No Yes No (Pro users only) Yes Yes Yes Yes Use the procedure below to enable dashboard Q&A on a QuickSight dashboard. To enable dashboard Q&A on a dashboard 1. Open the QuickSight console. 2. Open the analysis that the dashboard that you want to publish with Q&A enabled. 3. Choose Publish. 4. Check the Allow data Q&A check box. 5. (Optional) Choose MANAGE Q&A to choose which datasets you want to include in the dashboard Q&A experience. By default, all datasets that are used by the dashboard are included. 6. Choose APPLY CHANGES, and then choose Publish dashboard. Turn on the Dashboard Q&A experience in Amazon QuickSight 1241 Amazon QuickSight User Guide After you publish a dashboard with the dashboard Q&A experience enabled, users can ask questions about their data with the Ask a question about this dashboard input at the top of the dashboard. QuickSight allows any user to ask questions on dashboards that have dashboard Q&A enabled. However, dashboard Q&A is a feature of Amazon Q and therefore incurs the associated enablement fee. QuickSight admins can disable this feature at the account level at any time. Use the following procedure to disable dashboard Q&A across an entire QuickSight account. 1. Open the QuickSight console. 2. Choose the user icon in the top right, and then choose Manage QuickSight. 3. Choose Security & permissions. 4. Navigate to the Amazon Q section, and then choose Manage. 5. Toggle Manage Dashboard Q&A off. When you toggle Manage Dashboard Q&A off, dashboard Q&A is removed from any dashboards that have dashboard Q&A enabled. If your |
amazon-quicksight-user-345 | amazon-quicksight-user.pdf | 345 | a feature of Amazon Q and therefore incurs the associated enablement fee. QuickSight admins can disable this feature at the account level at any time. Use the following procedure to disable dashboard Q&A across an entire QuickSight account. 1. Open the QuickSight console. 2. Choose the user icon in the top right, and then choose Manage QuickSight. 3. Choose Security & permissions. 4. Navigate to the Amazon Q section, and then choose Manage. 5. Toggle Manage Dashboard Q&A off. When you toggle Manage Dashboard Q&A off, dashboard Q&A is removed from any dashboards that have dashboard Q&A enabled. If your QuickSight account does not have Pro users or topics, this action stops the Amazon Q enablement fee from billing your QuickSight account. This setting Turn on the Dashboard Q&A experience in Amazon QuickSight 1242 Amazon QuickSight User Guide does not impact Pro users or existing topics in QuickSight. For more information about opting out of Amazon Q in QuickSight, see Opting out of Amazon Q in QuickSight. Asking and answering questions of data with Amazon Q in QuickSight Note To view the multi-visual Amazon Q experience, the topic author must do the following: add named entities, and convert an existing topic to use generative capabilities or create a new generative topic. For more information, see Authoring Q&A. Accelerate data-driven decisions with humanistic Q&A that includes: • AI-generated narrative that highlights key insights • Multi-visual answer that provides the answer to your question along with supporting visuals to add valuable context • Home page for every topic with AI-generated and author-reviewed suggested questions and automated data previews to see what data you can ask about In the top navigation bar, at the top right, choose Ask Q to open Amazon Q. You can also open Amazon Q from the blue bar when a topic is linked to a dashboard. Once you open your topic, there is a home page with a list of suggested questions and What’s in your topic to see what data you can ask about. Asking and answering questions of data with Amazon Q in QuickSight 1243 Amazon QuickSight User Guide When there are multiple dates available, choose more... to view them. For example, in this Student Enrollment Trends topic, there is data available for enrollment data spanning from 2018 to 2023, but there is also student Date of Birth (DOB) data ranging from 1973 to 2005. Asking and answering questions of data with Amazon Q in QuickSight 1244 Amazon QuickSight User Guide Choose a suggested question or type your own question to get started. By hovering over a sentence in the AI-generated narrative, you can clearly identify the source visualization and verify the values. Each visualization is interactive and can be added to your pinboard. Asking and answering questions of data with Amazon Q in QuickSight 1245 Amazon QuickSight User Guide Amazon Q can answer a variety of questions from vague to precise. If you don’t have a precise question in mind, you can ask a vague question that is only one word or a short phrase, like “sales” or “top students." You can include additional filter criteria with these vague questions like “top students last semester." Question examples include: • Entity name: “Order Details" • Note You can find the entities from the topic home page and in the What’s in topic tab at the top of the list. Asking and answering questions of data with Amazon Q in QuickSight 1246 Amazon QuickSight User Guide • Field name: “Segment” • Field values: “Acme Inc.,” “Washington DC” • Vague (or implicit) filters: “best account managers," “bottom products” For precise questions that Amazon Q supports, see this table of question types: Types of questions supported by Q. Examples include “product with largest WoW growth %” or “forecast sales for APAC customers by quarter.”Amazon Q covers a range of filters, like top/bottom, relative and absolute date filters, period-to-date and period-over-period, and more. Amazon Q also supports analytical questions, like percent of total, or “why did sales drop in October 2023?" Tip To help you form questions, think Who, What, Where, When and Why. Asking and answering questions of data with Amazon Q in QuickSight 1247 Amazon QuickSight Unpacking your answer: User Guide • Interpreted as: – This is how Amazon Q interpreted your question. It will map your words to the underlying data so you can verify that Amazon Q correctly understood you. If not, adjust your question or leave feedback for your author. • AI-generated narrative: – A summary of the visuals that highlights key insights. If your QuickSight account is connected to an Amazon Q application, you may receive additional insights from unstructured data sources under Insights from Q Business. You can see the unstructured sources that are used in the Sources collabsible. For more information about |
amazon-quicksight-user-346 | amazon-quicksight-user.pdf | 346 | answer: User Guide • Interpreted as: – This is how Amazon Q interpreted your question. It will map your words to the underlying data so you can verify that Amazon Q correctly understood you. If not, adjust your question or leave feedback for your author. • AI-generated narrative: – A summary of the visuals that highlights key insights. If your QuickSight account is connected to an Amazon Q application, you may receive additional insights from unstructured data sources under Insights from Q Business. You can see the unstructured sources that are used in the Sources collabsible. For more information about connecting a QuickSight account to a Amazon Q Business application, see Augmenting Amazon QuickSight insights with Amazon Q Business. Asking and answering questions of data with Amazon Q in QuickSight 1248 Amazon QuickSight User Guide Asking and answering questions of data with Amazon Q in QuickSight 1249 Amazon QuickSight User Guide • Visuals: – Visuals consist of: center visual that directly answers the question, supporting visual on the right that provides context, relevant KPIs, and a details table at the bottom. Note If the field is not included in a named entity, then it will display as a single visual. • Did you mean: – When there are multiple interpretations to your question, Amazon Q will display a list of alternate answers that you can select to align with your intended question. • In the following example, the question "top customers” can be interpreted in several ways, including by “Total Sales,” “Total Profit,” or “number of customers." Asking and answering questions of data with Amazon Q in QuickSight 1250 Amazon QuickSight Other tips • To re-size the panel, drag the left side. User Guide • Add important visuals to your pinboard for quick access. View your pinboard from the top of the Amazon Q pane, as shown following: • Provide feedback for your topic author to see and make improvements. Asking and answering questions of data with Amazon Q in QuickSight 1251 Amazon QuickSight User Guide Opting out of Amazon Q in QuickSight QuickSight accounts are charged if Amazon Q in QuickSight is active in the account. Amazon Q in QuickSight is considered active if your account uses any of the following capabilities: • Pro users • Topics • Dashboard and visual indexing • Dashboard Q&A To avoid being charged for Amazon Q in QuickSight by completely deactivating it, perform the following steps. Note If your QuickSight account was subscribed to QuickSight Q before 4/30/2024 and you want to opt out of the QuickSight Q add-on, contact your account team and request to migrate your account to the new pricing model. After your account is migrated to the new pricing model, perform the following steps. For more information about QuickSight pricing, see Amazon QuickSight Pricing. Opting out of Amazon Q in QuickSight 1252 Amazon QuickSight User Guide To opt out of Amazon Q in QuickSight 1. Ensure there are no Pro users or user groups mapped to Pro roles in the account by performing the following steps: • To update or remove Pro users using APIs: • If you use QuickSight identity (with or without IAM federation): a. b. Find users that have Pro roles using the ListUsers API. Either change the users' roles using the UpdateUser API, or remove the users from the account using the DeleteUser API. • If you use IAM Identity Center or Microsoft Active Directory: a. Find group of users mapped to Pro roles using the ListRoleMemberships API. b. Create new user groups with the same users, but mapped to different roles, using the CreateRoleMemberships API. c. Delete the previous user groups mapped to Pro roles using the DeleteRoleMemberships API. • To update or remove Pro users using the QuickSight console: a. Open the QuickSight console. b. Choose the profile icon, then choose Manage QuickSight. c. If necessary, in the left navigation pane, choose Manage users. • • If you use QuickSight identity (with or without IAM federation), update user roles or delete users using the steps in Viewing Amazon QuickSight account details or Deleting a QuickSight user account. If you use IAM Identity Center or Microsoft Active Directory, update group and role mappings or delete user groups using the steps in Managing user access. 2. Ensure there are no topics in the account by performing the following steps: a. Use the ListTopics API to list all topics in the account for each AWS Region where topics are used. b. For each topic, do one of the following: • If you are an owner or co-owner of the topics, delete the topics using the DeleteTopic API. • If you're not an owner or co-owner of the topics: Opting out of Amazon Q in QuickSight 1253 Amazon QuickSight User Guide • Identify the owners of each |
amazon-quicksight-user-347 | amazon-quicksight-user.pdf | 347 | delete user groups using the steps in Managing user access. 2. Ensure there are no topics in the account by performing the following steps: a. Use the ListTopics API to list all topics in the account for each AWS Region where topics are used. b. For each topic, do one of the following: • If you are an owner or co-owner of the topics, delete the topics using the DeleteTopic API. • If you're not an owner or co-owner of the topics: Opting out of Amazon Q in QuickSight 1253 Amazon QuickSight User Guide • Identify the owners of each topic using the DescribeTopicPermissions API, then ask them to delete their topics using the DeleteTopic API. • Make yourself a co-owner of the topics using the UpdateTopicPermissions API , then delete the topics using the DeleteTopic API. 3. Ensure that dashboard and visual indexing and Dashboard Q&A are disabled by performing the following steps: • To disable dashboard and visual indexing and Dashboard Q&A using APIs: a. Disable dashboard and visual indexing using the UpdateQuickSightQSearchConfiguration API. b. Disable Dashboard Q&A using the UpdateDashboardsQAConfiguration API. • To disable dashboard and visual indexing and Dashboard Q&A using the QuickSight console: a. Open the QuickSight console. b. Choose the profile icon, then choose Manage QuickSight. c. d. In the left navigation pane, choose Security & permissions. In Amazon Q, choose Manage. e. Disable each of the options. Working with data stories in Amazon QuickSight With Amazon Q in QuickSight, authors and readers can generate a first draft of their data story quickly. Use Amazon Q prompts and visuals to produce a draft that incorporates the details that you provide. Data story drafts are not meant to replace your own ideas or to perform analysis. Rather, data stories are a starting point to customize and expand on as needed. Amazon Q's contextual recommendations and suggestions combine your prompt with selected visuals to provide relevant details that are tailored to your data story. For more information about Amazon Q in QuickSight, see Using Generative BI with Amazon Q in QuickSight. Use the following topics to create, modify, and share an Amazon Q in QuickSight data story. Topics • Creating a data story with Amazon Q in QuickSight • Personalize data stories in Amazon QuickSight Working with data stories in Amazon QuickSight 1254 Amazon QuickSight User Guide • Viewing a generated data story in Amazon QuickSight • Editing a generated data story in Amazon QuickSight • Adding themes and animations to a data story in Amazon QuickSight • Sharing a data story in Amazon QuickSight Creating a data story with Amazon Q in QuickSight Use the following procedure to create a data story with Amazon Q in QuickSight. To create a data story 1. Open the QuickSight console. 2. 3. In the QuickSight console, open the dashboard that you want to create a data story for, choose the Build icon at the top of the page, and then choose Data data story. Alternatively, navigate to the Amazon QuickSight start screen, choose Stories, and then choose NEW STORY. In the Story screen that appears, navigate to the Build data story modal and input a data story prompt that you would like to generate. For the best results, don't phrase the prompt like a question. Instead, type the data story that you want QuickSight to build. For example, say you want to create a data story about the most commonly performed medical procedures by region. A good prompt for this use case is "Build a data story about most commonly performed procedures by physicians in various regions. Also, show the specialties where patients are admitted the most. Recommend where we need to staff more physicians by specialty, and include at least four points of supporting data." You can optionally skip this step and manually create your data story. If you choose to forego entering a prompt, you still need to add a visual to the data story. 4. To open the Add visuals modal, choose Add visuals . 5. Choose the dashboard that contains the visuals that you want to use, and then choose the visuals that you want. You can add up to 20 visuals to a data story. If you don't see the dashboard that you want to use, use the Find your dashboards search bar at the top of the modal. You can choose visuals from any number of dashboards that you have sharing permissions to. Visuals that show a Restricted badge have permissions that restrict them from being added to a data story. A visual might be restricted for one of the following reasons: Creating a data story 1255 Amazon QuickSight User Guide • The dataset is connected to a data source that uses trusted identity propagation with Amazon Redshift. • The dataset is |
amazon-quicksight-user-348 | amazon-quicksight-user.pdf | 348 | data story. If you don't see the dashboard that you want to use, use the Find your dashboards search bar at the top of the modal. You can choose visuals from any number of dashboards that you have sharing permissions to. Visuals that show a Restricted badge have permissions that restrict them from being added to a data story. A visual might be restricted for one of the following reasons: Creating a data story 1255 Amazon QuickSight User Guide • The dataset is connected to a data source that uses trusted identity propagation with Amazon Redshift. • The dataset is located inside of a restricted folder. 6. When you are finished choosing the visuals that you want, choose Add. 7. (Optional) Use the Select documents section to upload up to 5 documents to be used in the data story. Each document can't exceed 10MB. These documents are only used to generate the data story and are not stored in QuickSight. The following image shows the Select documents section of the Build story screen. 8. (Optional) If your QuickSight account is connected to an Amazon Q Business application, check the Use insights from Amazon Q Business checkbox to augment your data story with unstructured data sources from Amazon Q Business. For more information about connecting a QuickSight account to a Amazon Q Business application, see Augmenting Amazon QuickSight insights with Amazon Q Business. 9. Choose Build. After the data story generates, review the data story and choose from the following options: • Keep – Saves the generated content to the canvas. When you choose this option, the Build a data story modal closes and you can start editing your data story. • Try again – Allows users to edit the prompt and generate a new data story. • Discard – Deletes the generated data story. Creating a data story 1256 Amazon QuickSight User Guide Personalize data stories in Amazon QuickSight Amazon Q in QuickSight leverages user location and job-related information from your IAM Identity Center instance to generate personalized data stories that are more relevant to authors and readers. For example, when an author in the US issues the prompt “Write a business strategy focusing on a plan on how to increase the revenue in my location", Amazon Q in QuickSight automatically includes insights related to the US in the data story's narrative. If the author wants the data story to focus on another country such as Canada, they can specify this in the prompt. For personalization to work, you must add country and job title for users in the IAM Identity Center instance that is connected to your QuickSight account. For more information, see Add users to your IAM Identity Center directory in the IAM Identity Center User Guide. User data in your IAM Identity Center instance is connected to your Amazon Q in QuickSight application environment by default. This means that all data stories are personalized by default. You can choose to opt out of personalization at any time in the Account settings menu in the QuickSight administration console. Note Personalization in data stories is currently available in the US East (N. Virginia) and US West (Oregon) AWS Regions. Viewing a generated data story in Amazon QuickSight After you generate and keep a data story, you can access that data story from the Data stories page. To view a data story, choose the data story that you want to view to open the story editor. As you create and modify a data story, you can preview how the data story looks to readers. To preview a generated data story, choose the Preview icon at the top of the page. To exit the preview, choose BACK TO EDITOR. Editing a generated data story in Amazon QuickSight After you create and keep a data story, you can modify its content to better fit your needs. You can format data story text, add images, edit visuals, and add new blocks. Personalize data stories in Amazon QuickSight 1257 Amazon QuickSight User Guide Stories are made up of different blocks that act as containers for text, visuals, and images that you want to include in your data story. Each block can be formatted indepenently from other blocks in the data story, similar to the sections of a paginated report. To format the text of a data story, use the toolbar at the top of the page. The toolbar offers font settings so you can customize the font type, style, color, size, spacing, text highlights, and alignment. You can also use the toolbar to add columns to a data story block. Use one of the following options to add a visual to a data story. • Use the Visuals pane to drag and drop a visual into a data story. Only the visuals that you |
amazon-quicksight-user-349 | amazon-quicksight-user.pdf | 349 | from other blocks in the data story, similar to the sections of a paginated report. To format the text of a data story, use the toolbar at the top of the page. The toolbar offers font settings so you can customize the font type, style, color, size, spacing, text highlights, and alignment. You can also use the toolbar to add columns to a data story block. Use one of the following options to add a visual to a data story. • Use the Visuals pane to drag and drop a visual into a data story. Only the visuals that you chose when you generated the data story are shown in the Visuals pane. You can also choose the Add (+) icon in the Visuals pane to add new visuals that can be dragged and dropped into the data story. Each data story can contain up to 20 visuals. • Choose the data story block that you want to add an image to. When a cursor appears, enter a forward slash ("/") to insert an image or visual to that data story block. Editing a generated data story in Amazon QuickSight 1258 Amazon QuickSight User Guide To edit a visual in a data story, choose the visual that you want to change, and then choose the Properties icon. In the properties pane that appears, you can perform the following actions: • Change, hide, or show the visual's title. By default, the visual title is displayed. • Change, hide, or show the visual's subtitle. By default, the visual subtitle is hidden. • Hide or show data labels. By default, data labels are hidden. • Hide, show, or change the position of the legend. By default, the legend is hidden. To add a new block to a data story, choose the plus (+) icon at the bottom of any existing block. Then choose the layout option that you want. You can also move, duplicate, or delete a block from the Block options (three dots) icon at the top of each block. Editing a generated data story in Amazon QuickSight 1259 Amazon QuickSight User Guide To change the layout of items in a block, you can drag and drop the items wherever you want with the six-dot icon next to each item. Adding themes and animations to a data story in Amazon QuickSight You can add themes and animations to the stories that you generate. To add a theme or animation to a data story, choose the Story style icon. The icon for Story style is as follows. In the Story style pane that appears, you can perform the following actions: • For THEMES, choose a theme that you think best fits your data story. • For ANIMATIONS, choose an animation style and speed. For animation types, you can choose None, Fade, or Slide. The default animation is None. For Speed, choose Slow, Medium, or Fast. The default speed is Medium. Sharing a data story in Amazon QuickSight Use the following procedure to share a data story. Themes and animations 1260 Amazon QuickSight To share a data story User Guide 1. 2. In the story editor of the data story that you want to share, choose the Share icon at the top right. Alternatively, you can choose the Share icon at the top of a data story preview. In the Share data story modal that appears, enter the users or groups that you want to share the data story with. 3. (Optional) To save a link for the published data story to your clipboard, choose COPY LINK. 4. Choose PUBLISH & SHARE. If you try to share a story and receive a message that the story cannot be shared, contact the owner of the dashboard ask them to toggle on the Allow sharing data stories switch. For more information about this switch, see Tutorial: Create an Amazon QuickSight dashboard. If you try to share a data story and receive an error message, contact the owner of the dashboard or your QuickSight account admin for assistance. After you share a data story, users you shared the story with receive a notification email with a link to the story. You can access the data story from the Data stories page of their QuickSight accounts. You can also share the copied link to the data story with users that can access the data story. You can't share a data story that contains restricted data. If you try to share a story that contains restricted data, an error message appears that lists all restricted visuals that are a part of the story. If desired, remove the restricted visuals from your data story before sharing it with users. When you edit a published data story, republish the data story for the changes to propagate to your end users. Sharing |
amazon-quicksight-user-350 | amazon-quicksight-user.pdf | 350 | the Data stories page of their QuickSight accounts. You can also share the copied link to the data story with users that can access the data story. You can't share a data story that contains restricted data. If you try to share a story that contains restricted data, an error message appears that lists all restricted visuals that are a part of the story. If desired, remove the restricted visuals from your data story before sharing it with users. When you edit a published data story, republish the data story for the changes to propagate to your end users. Sharing a data story in Amazon QuickSight 1261 Amazon QuickSight User Guide Working with scenarios in Amazon QuickSight QuickSight users with Admin Pro, Author Pro, or Reader Pro roles can use scenarios with Amazon Q in QuickSight to analyze complex business problems with simple natural language. To get started with scenarios, a QuickSight user describes a problem that they want to solve and adds relevant data from QuickSight or from their computer to be used in the data analysis. Alternatively, users can let Amazon Q in QuickSight search for all relevant data that can be used to solve the problem. Amazon Q returns a series of analyses or prompts to dive deeper into the data. Users can also enter their own prompts to create a custom analysis. After a new prompt is received, Amazon Q breaks down the analysis into steps and executes them. Outputs include specific data insights, interactive visuals, and an analysis of what the findings might mean for the business with suggested next actions. The following screenshot shows the Amazon QuickSight scenarios workspace. Scenarios can help QuickSight Pro users to perform the following tasks: • Automate tedious, error-prone, and inefficient manual data tasks • Modify, extend, or reuse past analyses to quickly adapt to business changes • Dive deeper into data than spreadsheets allow Use the following topics to create and work with scenarios in Amazon QuickSight. Working with scenarios in Amazon QuickSight 1262 Amazon QuickSight Topics • Considerations for QuickSight scenarios • Creating an Amazon QuickSight scenario • Working with threads in an Amazon QuickSight scenario • Working with data in an Amazon QuickSight scenario User Guide Considerations for QuickSight scenarios The following considerations apply to Amazon QuickSight scenarios. • Amazon QuickSight scenarios are available to users that have Admin Pro, Author Pro, or Reader Pro roles in QuickSight. For information about updating a user to a QuickSight Pro role, see Get started with Generative BI. • Scenarios are available in the following AWS Regions: • US East (N. Virginia) (us-east-1) • US West (Oregon) (us-west-2) • Europe (Ireland) (eu-west-1) • Europe (Frankfurt) (eu-central-1) After you review the considerations for QuickSight scenarios, see Creating an Amazon QuickSight scenario to get started with scenarios in Amazon QuickSight. Creating an Amazon QuickSight scenario Amazon QuickSight Pro users can create scenarios from QuickSight dashboards, or from the Scenarios section on the QuickSight home page. Users can create as many scenarios as they need. Each user can have up to 3 active scenarios at a time. Each QuickSight account supports up to 10 active scenarios at a time. Use the following procedure to create a scenario in Amazon QuickSight. Create a new scenario 1. Open the QuickSight console. 2. Perform one of the following actions: a. Open any dashboard, and look for one of the following: Considerations 1263 Amazon QuickSight User Guide • Choose Analyze this dashboard in a Scenario, if available, at the top of the dashboard. • From a visual on the dashboard, open the drop-down menu and choose Explore Scenario. • Choose Build, and then choose Scenario. b. On the QuickSight home page, choose Scenarios from the options pane. On the Scenarios page that opens, choose New scenario. 3. The new scenario appears. In the text box, describe the problem that you want to solve. This input is the starting point for all of the data pivots and manipulations that will occur in the scenario. The description that you provide can be as broad or as specific as you want, for example "analyze usage trends" or “compute month-over-month and year-over-year changes in usage based on last month's data." The following screenshot shows a new Amazon Q in QuickSight scenario. 4. Add the data that you want to use in the scenario. You can choose data from QuickSight dashboards, or you can upload files from your computer. When you choose data from a dashboard, a preview of the selected data is generated for you to review. For more information Creating an Amazon QuickSight scenario 1264 Amazon QuickSight User Guide about previewing and editing data in QuickSight scenarios, see Working with data in an Amazon QuickSight scenario. The following limits apply to the data that is used in a scenario: |
amazon-quicksight-user-351 | amazon-quicksight-user.pdf | 351 | The following screenshot shows a new Amazon Q in QuickSight scenario. 4. Add the data that you want to use in the scenario. You can choose data from QuickSight dashboards, or you can upload files from your computer. When you choose data from a dashboard, a preview of the selected data is generated for you to review. For more information Creating an Amazon QuickSight scenario 1264 Amazon QuickSight User Guide about previewing and editing data in QuickSight scenarios, see Working with data in an Amazon QuickSight scenario. The following limits apply to the data that is used in a scenario: • You can add up to 10 data sources to a scenario. • Up to 20 visuals can be selected from a dashboard at a time. • Uploaded files must be in .xlsx or .csv format and can't exceed 1 GB. • Data sources can have up to 200 columns. If you don't add data to the scenario, Amazon Q automatically searches your QuickSight dashboards to find data related to your problem statement from the previous step. 5. Choose START ANALYSIS. When you start an analysis in a QuickSight scenario, QuickSight prepares your data for analysis and returns a new thread. The thread contains generated prompts that can be used to solve the problem that you described in the scenario. A thread is a turn based contextual conversation that consists of user prompts and Amazon Q responses that you can use to drill down on a specific scenario. You can use threads to write prompts that assume that Amazon Q remembers what was previously discussed in the thread. You can choose a prompt to continue the thread, or you can choose the plus sign (+) above the thread to start a new thread. The new thread uses a different prompt than the first thread that you created. For more information about working with threads, see Working with threads in an Amazon QuickSight scenario. Working with threads in an Amazon QuickSight scenario After you create a scenario in QuickSight, the data that Amazon Q generates is presented in threads and blocks. A thread is a vertical chain of prompts and responses. A block is a single prompt and response pair. Each thread can contain up to 15 blocks, and each scenario can contain up to 50 blocks total across multiple threads. When a new thread is created, a list of Amazon Q-generated prompts appears inside of a new block. When you choose one of the prompts to drill down on, Amazon Q analyzes the data that is relevant to the chosen prompt and returns a summary of all data findings, forecasts, and conclusions that can be drawn from the analysis. The following screenshot shows a block that has generated a list of prompts to be considered for a new thread analysis. Working with threads in an Amazon QuickSight scenario 1265 Amazon QuickSight User Guide To continue the thread and dive deeper into the prompt, choose the plus sign (+) located below the block to create a new block that contains a new list of generated prompts that factor in the findings from the previous block. To start a new thread that analyzes a different aspect of the data, choose the plus sign (+) above any block in the scenario to create a new thread. The following image shows a scenario that contains multiple threads. Working with threads in an Amazon QuickSight scenario 1266 Amazon QuickSight User Guide Blocks can be collapsed, duplicated, or deleted from a scenario, as long as the block that you want to change has finished loading. Use the following procedures to make changes to a scenario block. To collapse, duplicate, or delete a block 1. Open the QuickSight console. 2. Choose Scenarios from the options pane, and then choose the scenario that you want to change. 3. Navigate to the block that you want to change and choose the ellipsis (…) in the top right of the block. 4. Perform one of the following actions: • To collapse the block, choose Collapse. To expand a collapsed block, choose the ellipsis in the top right of the block, and then choose Expand. Working with threads in an Amazon QuickSight scenario 1267 Amazon QuickSight User Guide • To duplicate the block, choose Duplicate. The block is duplicated and placed in a new thread next to the original block. • To delete the block, choose Delete. You can also modify the prompt of a block to better match your use case. Use the following procedure to modify a block prompt. To modify the prompt of a block 1. Open the QuickSight console. 2. Choose Scenarios from the options pane, and then choose the scenario that you want to change. 3. Navigate to the block that you want to change and |
amazon-quicksight-user-352 | amazon-quicksight-user.pdf | 352 | QuickSight scenario 1267 Amazon QuickSight User Guide • To duplicate the block, choose Duplicate. The block is duplicated and placed in a new thread next to the original block. • To delete the block, choose Delete. You can also modify the prompt of a block to better match your use case. Use the following procedure to modify a block prompt. To modify the prompt of a block 1. Open the QuickSight console. 2. Choose Scenarios from the options pane, and then choose the scenario that you want to change. 3. Navigate to the block that you want to change and choose Modify block. 4. In the Modify block popup that appears, enter a new description for the block, and then choose Apply. After you modify a prompt, Amazon Q analyzes the data and returns a new generated analysis that reflects the changes that were made to the prompt. Working with data in an Amazon QuickSight scenario When you create a scenario in Amazon QuickSight, you can preview and modify the data that the scenario uses to generate summaries. Use the following sections to learn about the ways QuickSight users can interact with data in a scenario. Topics • Adding more data to a scenario • Editing data in a preview • Editing data in a snapshot Adding more data to a scenario After you create a scenario in Amazon QuickSight, you can add more data to the scenario at any time. Use the following procedure to add data to an Amazon QuickSight scenario. Working with data in an Amazon QuickSight scenario 1268 Amazon QuickSight User Guide To add data to an existing Amazon QuickSight scenario 1. Open the QuickSight console. 2. Choose Scenarios from the options pane, and then choose the scenario that you want to add more data to. 3. Choose the Data Source icon in the actions bar to open the Data pane. The following image shows the Data source icon that opens the Data pane. 4. Perform one of the following actions: a. To add QuickSight data to the scenario, choose FIND DATA, and then choose the dataset or dashboard visuals that you want to add to the scenario. After you have selected all of the QuickSight data that you want to add to the scenario, choose ADD. b. To upload a file from your computer to the scenario, choose UPLOAD FILE. The following limits apply to the data that is added to a scenario: • You can add up to 10 data sources to a scenario. • Up to 20 visuals can be selected from a dashboard at a time. • Uploaded files must be in .xlsx or .csv format and can't exceed 1 GB. • Data sources can have up to 200 columns. After you add new data to a scenario, Amazon Q includes the data in all new analyses. Editing data in a preview When you choose data from a QuickSight dashboard to be used in a scenario, a preview of the data is generated for review before it's added to the analysis. If needed, the following changes can be made to dashboard data in the preview state: • Filters – If you only want to analyze a subset of the available data or if you need to reduce the number of rows that are included in the scenario, you can apply filters to the data. • Sort – If the available data exceeds 1 million rows and you want to prioritize the retention of the values in a specific column, you can sort the data to fit your needs. Working with data in an Amazon QuickSight scenario 1269 Amazon QuickSight Editing data in a snapshot User Guide When you add dashboard or external data to a scenario, QuickSight creates a snapshot of the data sources to be reviewed. To see a snapshot of the data used in a scenario, choose the Data Source icon in the actions bar. This opens the Data pane, and then you can choose the data snapshot that you want to review. You can perform the following actions on a data snapshot: • To update the title of the data snapshot, choose the pencil icon next to the title and enter a new title for the snapshot. • Choose the Filter icon to filter the data that is used in the scenario. This option can be used if you want the scenario to only use a subset of the data that is added to the scenario. • Choose the Sort icon to sort the data that is used in the scenario. This option can be used to prioritize the retention of specific columns if the data exceeds 1 million rows. • Choose the Fields list icon to choose which fields are included in the scenario. This option can be |
amazon-quicksight-user-353 | amazon-quicksight-user.pdf | 353 | and enter a new title for the snapshot. • Choose the Filter icon to filter the data that is used in the scenario. This option can be used if you want the scenario to only use a subset of the data that is added to the scenario. • Choose the Sort icon to sort the data that is used in the scenario. This option can be used to prioritize the retention of specific columns if the data exceeds 1 million rows. • Choose the Fields list icon to choose which fields are included in the scenario. This option can be used to control which columns are used in the scenario. When you are finished updating the scenario data, close the Data pane. Working with data in an Amazon QuickSight scenario 1270 Amazon QuickSight User Guide Sharing and subscribing to data in Amazon QuickSight A dashboard is a read-only snapshot of an analysis that you can share with other Amazon QuickSight users for reporting purposes. A dashboard preserves the configuration of the analysis at the time you publish it, including such things as filtering, parameters, controls, and sort order. The data used for the analysis isn't captured as part of the dashboard. When you view the dashboard, it reflects the current data in the data sets used by the analysis. When you share a dashboard, you specify which users have access to it. Users who are dashboard viewers can view and filter the dashboard data. Any selections to filters, controls, or sorting that users apply while viewing the dashboard exist only while the user is viewing the dashboard, and aren't saved after it's closed. Users who are dashboard owners can edit and share the dashboard, and optionally can edit and share the analysis. If you want them to also edit and share the data set, you can set that up in the analysis. A shared dashboard can also be embedded in a website or app, if you are using Enterprise edition. For more information about embedded dashboards, see Embedded analytics for Amazon QuickSight. Use the following sections to learn how to publish and share dashboards, subscribe to threshold alerts, and send and subscribe to dashboard email reports. Topics • Sharing Amazon QuickSight analyses • Publishing dashboards • Sharing Amazon QuickSight dashboards • Sharing your view of a Amazon QuickSight dashboard • Scheduling and sending QuickSight reports by email • Subscribing to email reports in Amazon QuickSight • Working with threshold alerts in Amazon QuickSight • Printing a dashboard or analysis • Exporting Amazon QuickSight analyses or dashboards as PDFs • Error codes for failed PDF export jobs • Organizing assets into folders for Amazon QuickSight 1271 Amazon QuickSight User Guide Sharing Amazon QuickSight analyses You can share an analysis with one or more other users by emailing them a link, making it easy to collaborate and disseminate findings. You can only share an analysis with other users in your Amazon QuickSight account. After you share an analysis, you can review the other users who have access to it, and also revoke access from any user. Topics • Sharing an analysis • Viewing the users that an analysis is shared with • Revoking access to an analysis Sharing an analysis Use the following procedure to share an analysis. To share an analysis 1. Open the QuickSight console. 2. Open the analysis that you want to change. 3. On the analysis page, choose File on the application bar, and then choose Share. You can only share analyses with users or groups who are in your Amazon QuickSight account. 4. Add a user or group to share with. To do this, for Type a user name or email, enter the first user or group that you want to share this analysis with. Then choose Share. Repeat this step until you have entered information for everyone you want to share the analysis with. To edit sharing permissions for this analysis, choose Manage analysis permissions. The Manage analysis permissions screen appears. On this screen, choose Invite user to edit permissions and add more users or groups. 5. For Permission, choose the role to assign to each user or group. The role determines the permission level to grant to that user or group. 6. Choose Share. Sharing Amazon QuickSight analyses 1272 Amazon QuickSight User Guide The users that you have shared the analysis with get emails with a link to the analysis. Groups don't receive invitation emails. Viewing the users that an analysis is shared with If you have shared an analysis, you can use the following procedure to see which users or groups have access to it. To view which users or groups have access to an analysis 1. Open the QuickSight console. 2. Open the analysis that you want to change. 3. On the analysis |
amazon-quicksight-user-354 | amazon-quicksight-user.pdf | 354 | grant to that user or group. 6. Choose Share. Sharing Amazon QuickSight analyses 1272 Amazon QuickSight User Guide The users that you have shared the analysis with get emails with a link to the analysis. Groups don't receive invitation emails. Viewing the users that an analysis is shared with If you have shared an analysis, you can use the following procedure to see which users or groups have access to it. To view which users or groups have access to an analysis 1. Open the QuickSight console. 2. Open the analysis that you want to change. 3. On the analysis page, choose File on the application bar, and then choose Share. 4. Choose Manage analysis permissions. 5. Review who this analysis has been shared with. You can search to locate a specific account by typing a search term. The search returns any user, group, or email address that contains the search term. Searching is case-sensitive, and wildcards are not supported. Delete the search term to view all users and groups. Revoking access to an analysis Use the following procedure to revoke access to an analysis. To revoke access to an analysis 1. Open the QuickSight console. 2. Open the analysis that you want to change. 3. On the analysis page, choose File on the application bar, and then choose Share. 4. Choose Manage analysis permissions. 5. Locate the user or group whose access you want to revoke, and then choose the trash-can icon next to the user or group. 6. Choose Confirm. Viewing the users that an analysis is shared with 1273 Amazon QuickSight User Guide Publishing dashboards When you publish an analysis, that analysis becomes a dashboard that can be shared and interacted with by users of your Amazon QuickSight account or, in some cases, with anonymous users that aren't on your account. You can choose to publish one sheet of an analysis, all sheets in the analysis, or any other combination of sheets that you want. When you publish an interactive sheet, that sheet becomes an interactive dashboard that users can interact with. When you publish a paginated report sheet, the sheet becomes a paginated report that generates and saves a snapshot of the report's data when you schedule a report in Amazon QuickSight. You can publish a dashboard that contains any combination of interactive sheets and paginated reports from the same analysis. For more information about scheduling a report, see Scheduling and sending QuickSight reports by email . For more information about viewing a report's snapshots, see Consuming paginated reports in Amazon QuickSight. Use the following procedure to publish and optionally share a dashboard. You can also use this procedure to rename a published dashboard. A renamed dashboard retains its security and emailed report settings. 1. Open the analysis that you want to use. Choose Publish. 2. Do one of the following: • To create a new dashboard, choose New dashboard, and then type a dashboard name. • To replace an existing dashboard, do one of the following. Replacing a dashboard updates it without altering security or emailed report settings. • To update it with your changes, choose Replace an existing dashboard and then choose a dashboard from the list. • To rename it, choose Replace an existing dashboard, choose a dashboard from the list, and then select the pencil icon. Enter a new name to rename the existing dashboard and click the checkmark or press enter to confirm. When you publish a dashboard after renaming, it also saves any changes you made to the analysis. Changes to the analysis or dashboard are not persisted until you Publish. An initial version of a dashboard must be published in order to rename it. Publishing dashboards 1274 Amazon QuickSight User Guide 3. (Optional) Choose the sheets that you want to publish in the SHEETS dropdown. When you select sheets to add to the new dashboard, the dropdown shows how many sheets are selected for publishing. The default option is ALL SHEETS SELECTED. If you are replacing an existing dashboard, the sheets that are already published to the existing dashboard are pre-selected in the dropdown, unless you are publishing from an analysis you have not previously published from. You can make changes to this by selecting or de-selecting sheets from the dropdown list. 4. (Optional) Add comments on the changes you have made in the notes section, which is available to view under Version History. 5. 6. (Optional) To allow dashboard readers to share data stories, choose Allow sharing data stories. For more information about data stories, see Working with data stories in Amazon QuickSight. (Optional) Open More Settings. These options are only available if at least one sheet in the new dashboard is an interactive sheet. Note This is a scrollable window. Scroll down in the Publish a dashboard |
amazon-quicksight-user-355 | amazon-quicksight-user.pdf | 355 | make changes to this by selecting or de-selecting sheets from the dropdown list. 4. (Optional) Add comments on the changes you have made in the notes section, which is available to view under Version History. 5. 6. (Optional) To allow dashboard readers to share data stories, choose Allow sharing data stories. For more information about data stories, see Working with data stories in Amazon QuickSight. (Optional) Open More Settings. These options are only available if at least one sheet in the new dashboard is an interactive sheet. Note This is a scrollable window. Scroll down in the Publish a dashboard window to view all available options. There are some options that you can turn off to simplify the experience for this dashboard, as follows: • For Dashboard options: • Leave Expand on-sheet controls by default cleared to show a simplified view. This is disabled by default. To show the controls by default, turn on this option. • Clear Enable advanced filtering on the left pane to remove the ability for dashboard viewers to filter the data themselves. If they create their own filters, the filters exist only while the user is viewing the dashboard. Filters can't be saved or reused. • Clear Enable on-hover tooltip to turn off tooltips. • For Visual options: • Clear Enable visual menu, to turn off the on-visual menu entirely. • Clear Enable download options if your dashboard viewers don't need to be able to download data from the visuals in the dashboard. The CSV file includes only what is Publishing dashboards 1275 Amazon QuickSight User Guide currently visible in the visual at the time they download it. The viewer downloads data by using the on-visual menu on each individual visual. • Clear Enable maximize visual option to turn off the ability to enlarge visuals to fill the screen. • For Data point options: • Clear Enable drill up/down if your dashboard doesn't offer drillable field hierarchies. • Clear Enable on-click tooltip to turn off tooltips that appear when the reader chooses (clicks on) a data point. • Clear Enable sort options to turn off sorting controls. 7. Choose Publish dashboard. If you renamed the existing dashboard, the top of the screen refreshes to show the new name. 8. (Optional) Do one of the following: • To publish a dashboard without sharing, choose x at the upper right of the Share dashboard with users screen when it appears. You can always share the dashboard later by choosing File>Share from the application bar. • To share the dashboard, follow the procedure in Sharing Amazon QuickSight dashboards. After you complete these steps, you complete creating and sharing the dashboard. Subscribers of the dashboard receive email that contains a link to the dashboard. Groups don't receive invitation emails. Copying an Amazon QuickSight dashboard If you have co-owner access or Save as privileges on an existing dashboard, you can copy it. To do this, create a new analysis from the dashboard and then create a new dashboard from the analysis that you copied. After you save the original dashboard as a new analysis, you can collaborate on it by sharing the new analysis with other users. For example, you can use this workflow to preserve a production version of the dashboard, while also developing or testing a new version of it. Copying a dashboard 1276 Amazon QuickSight To copy a dashboard User Guide 1. Sign in to Amazon QuickSight at https://quicksight.aws.amazon.com/ and choose Dashboards from the start page. 2. Open the dashboard that you want to duplicate. 3. At upper right, choose Save As, and then enter a name for the new analysis. When you save an existing dashboard using Save As, it creates an analysis based on the dashboard. Note If you can't see Save as, check with your administrator that you have the right permissions. 4. 5. (Optional) Make changes to the new analysis. (Optional) Share the analysis with other users so you can collaborate on changes. All users who have access can make changes to the new analysis. To share the analysis with other users, choose Share from the top right corner of the page, and then choose Share analysis. 6. (Optional) Create a new dashboard with your changes to the new analysis by choosing Share, and then choosing Publish Dashboard. For more information, see the following: • Sharing Amazon QuickSight dashboards • Sharing Amazon QuickSight analyses Deleting an Amazon QuickSight dashboard When you delete an Amazon QuickSight dashboard, the dashboard is permanently removed from your account and all folders that the dashboard was a part of. You will no longer be able to access the deleted dashboard. You can only delete dashboards that you own or co-own. Use the following procedure to delete a dashboard. Deleting dashboards 1277 Amazon QuickSight To delete a dashboard User |
amazon-quicksight-user-356 | amazon-quicksight-user.pdf | 356 | with your changes to the new analysis by choosing Share, and then choosing Publish Dashboard. For more information, see the following: • Sharing Amazon QuickSight dashboards • Sharing Amazon QuickSight analyses Deleting an Amazon QuickSight dashboard When you delete an Amazon QuickSight dashboard, the dashboard is permanently removed from your account and all folders that the dashboard was a part of. You will no longer be able to access the deleted dashboard. You can only delete dashboards that you own or co-own. Use the following procedure to delete a dashboard. Deleting dashboards 1277 Amazon QuickSight To delete a dashboard User Guide 1. On the Dashboards tab of the Amazon QuickSight start page, choose the details icon (vertical dots ⋮) on the dashboard that you want to delete. 2. Choose Delete. Then choose Delete again to confirm that you want to delete the dashboard. Deleting a dashboard permanently deletes the dashboard from your account, and the dashboard will disappear from all folders that it belonged to. You can still access and create other dashboards from the analysis that the deleted dashboard was published from. Deleting dashboards 1278 Amazon QuickSight User Guide Publishing a previous version of an Amazon QuickSight dashboard Each time you make updates to an analysis and publish it, a new version of the Amazon QuickSight dashboard is created. To revert back to a previous version of a dashboard, you can search for it under the dashboard’s Version History and publish the former version you are interested in. Each dashboard can store up to 1000 versions that are never deleted. Use the following procedure to publish a previous version of a dashboard. To publish a previous version of a dashboard 1. On the Dashboards tab of the Amazon QuickSight start page, choose the dashboard that you want to manage. 2. Choose Version History on the toolbar on the right. The version of the dashboard that is currently published, as well as previous available versions, will appear in a list. Any comments that were added in the notes section will appear with the respective version. 3. Select the version of the dashboard you are interested in. You can see when this version was published and which user published it. 4. To revert to this version, select Publish. Click Confirm to publish the version. Sharing Amazon QuickSight dashboards By default, dashboards in Amazon QuickSight aren't shared with anyone and are only accessible to the owner. However, after you publish a dashboard, you can share it with other users or groups in your QuickSight account. You can also choose to share the dashboard with everyone in your QuickSight account and make the dashboard visible on the QuickSight homepage for all users in your account. Additionally, you can copy a link to the dashboard to share with others who have access to it. Important Users who have access to the dashboard can also see the data used in the associated analysis. After you share a dashboard, you can review the other users or groups that have access to it and control the type of access they have. You can revoke access to the dashboard for any user. You can also remove yourself from it. Publishing previous dashboard versions 1279 Amazon QuickSight User Guide You can also embed interactive dashboards and visuals in websites and apps by copying the dashboard or visual embed code and pasting it in your application. For more information, see Embedding QuickSight visuals and dashboards for registered users with a 1-click embed code. Granting access to a dashboard You can share dashboards and visuals with specific users or groups in your account or with everyone in your Amazon QuickSight account. Or you share them with anyone on the internet. You can share dashboards and visuals by using the QuickSight console or the QuickSight API. Access to a shared visual depends on the sharing settings that are configured for the dashboard that the visual belongs to. To share and embed visuals to your website or application, adjust the sharing settings of the dashboard that it belongs to. For more informaton, see the following: • Granting individual Amazon QuickSight users and groups access to a dashboard in Amazon QuickSight • Granting everyone in your Amazon QuickSight account access to a dashboard • Granting anyone on the internet access to an Amazon QuickSight dashboard • Granting everyone in your Amazon QuickSight account access to a dashboard with the QuickSight API • .Granting anyone on the internet access to an Amazon QuickSight dashboard using the QuickSight API Granting individual Amazon QuickSight users and groups access to a dashboard in Amazon QuickSight Use the following procedure to grant access to a dashboard. To grant users or groups access to a dashboard 1. Open the published dashboard and choose Share at upper right. Then choose Share |
amazon-quicksight-user-357 | amazon-quicksight-user.pdf | 357 | in your Amazon QuickSight account access to a dashboard • Granting anyone on the internet access to an Amazon QuickSight dashboard • Granting everyone in your Amazon QuickSight account access to a dashboard with the QuickSight API • .Granting anyone on the internet access to an Amazon QuickSight dashboard using the QuickSight API Granting individual Amazon QuickSight users and groups access to a dashboard in Amazon QuickSight Use the following procedure to grant access to a dashboard. To grant users or groups access to a dashboard 1. Open the published dashboard and choose Share at upper right. Then choose Share dashboard. Granting access to a dashboard 1280 Amazon QuickSight User Guide 2. In the Share dashboard page that opens, do the following: a. For Invite users and groups to dashboard at left, enter a user email or group name in the search box. Any users or groups that match your query appear in a list below the search box. Only active users and groups appear in the list. b. For the user or group that you want to grant access to the dashboard, choose Add. Then choose the level of permissions that you want them to have. Granting access to a dashboard 1281 Amazon QuickSight User Guide You can select Viewer or Co-owner, depending on the user's QuickSight role. The available permissions for each role are as follows: • Readers – QuickSight readers can only be granted Viewer access to dashboards. They can view, export, and print the dashboard, but they can't save the dashboard as an analysis. They can view, filter, and sort the dashboard data. They can also use any controls or custom actions that are on the dashboard. Any changes that they make to the dashboard exist only while they are viewing it, and aren't saved after they close the dashboard. • Authors – QuickSight authors can be granted Viewer or Co-owner access to dashboards. • Authors with Viewer access can view, export, and print the dashboard. They can view, filter, and sort the dashboard data. They can also use any controls or custom actions that are on the dashboard. Any changes that they make to the dashboard exist only while they are viewing it, and aren't saved after they close the dashboard. However, they can save the dashboard as an analysis, unless the dashboard owner specifies otherwise. This privilege grants them read-only access to the datasets so that they can create new analyses from them. The owner has the option to provide them with the same permissions to the analysis. If the owner wants them also to edit and share the datasets, the owner can set that up inside the analysis. Granting access to a dashboard 1282 Amazon QuickSight User Guide • Authors with Co-owner access can view, export, and print the dashboard. They can also edit, share, and delete it. They can also save the dashboard as an analysis, unless the dashboard owner specifies otherwise. This privilege grants them read-only access to the datasets so that they can create new analyses from them. The owner has the option to provide them with the same permissions to the analysis. If the owner wants them to also edit and share the datasets, the owner can set that up inside the analysis. • Groups – QuickSight groups can only be granted Viewer access to dashboards. They can view, export, and print the dashboard, but they can't save the dashboard as an analysis. After you add a user or group to the dashboard, you can see information about them in the Manage permissions section, under Users & Groups. You can see their user name, email, permission level, and "save as" privileges. To allow a user or group to save the dashboard as an analysis, turn on Allow "save as" in the Save as Analysis column. To change the permission level for a user, choose the permission level menu in the Permissions column and select a permission. Granting access to a dashboard 1283 Amazon QuickSight User Guide c. To add more users to the dashboard, enter another user email or group name in the search box and repeat steps A and B. Granting everyone in your Amazon QuickSight account access to a dashboard Alternatively, you can share your Amazon QuickSight dashboard with everyone in your account. When you do this, everyone in your account can access the dashboard, even if they weren't granted access individually and assigned permissions. They can access the dashboard if they have a link to it (shared by you) or if it's embedded. Sharing the dashboard with everyone in your account doesn't affect email reports. For example, suppose that you choose to share the dashboard with everyone in your account. Suppose also that you choose Send email report to all users with access to dashboard when |
amazon-quicksight-user-358 | amazon-quicksight-user.pdf | 358 | to a dashboard Alternatively, you can share your Amazon QuickSight dashboard with everyone in your account. When you do this, everyone in your account can access the dashboard, even if they weren't granted access individually and assigned permissions. They can access the dashboard if they have a link to it (shared by you) or if it's embedded. Sharing the dashboard with everyone in your account doesn't affect email reports. For example, suppose that you choose to share the dashboard with everyone in your account. Suppose also that you choose Send email report to all users with access to dashboard when setting up an email report for the same dashboard. In this case, the email report is sent only to people who have access to the dashboard. They receive access either through someone explicitly sharing it with them, through groups, or through shared folders. To grant everyone in your account access to a dashboard 1. Open the published dashboard and choose Share at upper right. Then choose Share dashboard. Granting access to a dashboard 1284 Amazon QuickSight User Guide 2. In the Share dashboard page that opens, for Enable access for at bottom left, toggle on Everyone in this account. Accounts that sign in with an Active Directory can't access the Everyone in this account switch. Accounts that use Active Directory can enable this setting with an UpdateDashboardPermissions API call. For more information on UpdateDashboardPermissions, see UpdateDashboardPermissions in the QuickSight API Reference. 3. (Optional) Toggle on Discoverable in QuickSight. When you share a dashboard with everyone in the account, owners can also choose to make the dashboard discoverable in QuickSight. A dashboard that's discoverable appears in everyone's list of dashboards on the Dashboards page. When this option is turned on, everyone in the account can see and search for the dashboard. When this option is turned off, they can only access the dashboard if they have a link or if it's embedded. The dashboard doesn't appear on the Dashboards page, and users can't search for it. Granting access to a dashboard 1285 Amazon QuickSight User Guide Granting anyone on the internet access to an Amazon QuickSight dashboard Applies to: Enterprise Edition You can also share your Amazon QuickSight dashboard with anyone on the internet from the Share menu in the QuickSight console. When you do this, anyone on the internet will be able to access the dashboard, even if they aren't a registered user on your QuickSight account, when you share the dashboard link or embed the dashboard. Use the following sections to grant anyone on the internet access to dashboard when you share it. Topics • Before you start • Granting anyone on the internet access to a dashboard • Updating a publicly shared dashboard • Turning off public sharing settings Before you start Before you can share a dashboard with anyone on the internet, make sure to do the following: 1. Turn on session capacity pricing on your account. If you have not turned on session capacity pricing on your account, you won't be able to update your account's public sharing settings. For more information about session capacity pricing, see https://aws.amazon.com/quicksight/ pricing/. 2. Assign public sharing permissions to an administrative user in the IAM console. You can add these permissions with a new policy or you can add the new permissions to an existing user. Granting access to a dashboard 1286 Amazon QuickSight User Guide The following sample policy provides permissions for use with UpdatePublicSharingSettings. { "Version": "2012-10-17", "Statement": [ { "Action": "quicksight:UpdatePublicSharingSettings", "Resource": "*", "Effect": "Allow" } ] } Accounts that don't want users with administrator access to use this feature can add an IAM policy that denies public sharing permissions. The following sample policy denies permissions for use with UpdatePublicSharingSettings. { "Version": "2012-10-17", "Statement": [ { "Action": "quicksight:UpdatePublicSharingSettings", "Resource": "*", "Effect": "Deny" } ] } For more information on using IAM with QuickSight, see Using Amazon QuickSight with IAM. You can also use the "Deny" policy as a Service Control Policy (SCP) if you don't want any of the accounts in your organization to have the public sharing feature. For more information, see Service control policies (SCPs) in the AWS Organizations User Guide. 3. Turn on public sharing on your QuickSight account. 1. From the Amazon QuickSight start page, choose your user icon at the upper right of your browser window, and then choose Manage QuickSight. 2. In the page that opens, choose Security and permissions at left. Granting access to a dashboard 1287 Amazon QuickSight User Guide 3. Scroll down and, in the Public access to dashboards section, choose Manage. 4. On the page that opens, choose Anyone on the internet. When you turn on this setting, a pop up will appear asking you to confirm your choice. Once you've confirmed your choice, you can grant |
amazon-quicksight-user-359 | amazon-quicksight-user.pdf | 359 | sharing on your QuickSight account. 1. From the Amazon QuickSight start page, choose your user icon at the upper right of your browser window, and then choose Manage QuickSight. 2. In the page that opens, choose Security and permissions at left. Granting access to a dashboard 1287 Amazon QuickSight User Guide 3. Scroll down and, in the Public access to dashboards section, choose Manage. 4. On the page that opens, choose Anyone on the internet. When you turn on this setting, a pop up will appear asking you to confirm your choice. Once you've confirmed your choice, you can grant the public access to specific dashboards and share those dashboards with them with a link or by embedding the dashboard in a public application, wiki, or portal. Granting anyone on the internet access to a dashboard To grant anyone on the internet access to a dashboard 1. In QuickSight, open the published dashboard that you want to share. You must be the owner or a co-owner of the dashboard. 2. 3. In the published dashboard, choose the Share icon at upper-right, and then choose Share dashboard. In the Share dashboard page that opens, choose Anyone on the internet (public) in the Enable access for section at bottom-left. This setting allows you to share the dashboard with anyone on the internet with the share link or when embedded. Turning on this switch also automatically turns on the Everyone Granting access to a dashboard 1288 Amazon QuickSight User Guide in this account option, which means that the dashboard will be shared with anyone in your QuickSight account. If you do not want this, turn off this option. 4. In the Allow public access pop-up that appears, enter confirm in the box to confirm your choice, and then choose Confirm. After you confirm your dashboard's access settings, an orange PUBLIC tag appears at upper right of your dashboard in the Amazon QuickSight console. Additionally, an eye icon appears on the dashboard on the QuickSight Dashboards page, both in tile and list view. Note that when public access is turned on, the dashboard can only be accessed using the link or when embedded using the embed code. For more information about sharing a link to the dashboard, see Sharing a link a shared dashboard. For more information about embedding dashboards for anyone on the internet, see Embedding QuickSight visuals and dashboards for anonymous users with a 1-click embed code. Granting access to a dashboard 1289 Amazon QuickSight User Guide Updating a publicly shared dashboard Use the following procedure to update a shared dashboard that can be accessed by anyone on the internet. To update a public dashboard: 1. From the Amazon QuickSight start page, choose the analysis that is tied to the dashboard that you want to update and make your desired changes. You must be the owner or a co-owner of 2. 3. the analysis. In the analysis, choose Publish. In the pop-up that appears, choose Replace an existing dashboard and select the public dashboard that you want to update. 4. To confirm your choice, enter confirm and then choose Publish dashboard. Once you choose Publish dashboard, your public dashboard is updated to reflect the new changes. Turning off public sharing settings You can turn off public sharing settings for dashboards at anytime. You can turn off public sharing for an individual dashboard, or for all dashboards in your account. Visual sharing settings are determined at the dashboard level. If you turn off public sharing settings to a dashboard that holds a visual that you are embedding, users won't be able to access the visual. The following table describes the different scenarios for when a dashboard is publicly available. Granting access to a dashboard 1290 Amazon QuickSight User Guide Account-level public setting Dashboard-level public setting Public access Visual indicators Off On On Off Off On Off Off Yes Off On No None None An orange badge appears on the dashboard and an eye icon appears on the dashboard in the Dashboards page. A grey badge appears on the dashboard and an eye icon with a slash appears on the dashboard in the Dashboards page. It can take up to two minutes for a dashboard's public access to be revoked. Granting access to a dashboard 1291 Amazon QuickSight User Guide Account-level public setting Dashboard-level public setting Public access Visual indicators To turn off public sharing for a single dashboard 1. In QuickSight, open the published dashboard that you no longer want to share. You must be the owner or a co-owner of the dashboard. 2. 3. In the published dashboard, choose the Share icon at upper-right, and then choose Share dashboard. In the Share dashboard page that opens, toggle off the Anyone on the internet (public) switch in the Enable access for section at |
amazon-quicksight-user-360 | amazon-quicksight-user.pdf | 360 | dashboard's public access to be revoked. Granting access to a dashboard 1291 Amazon QuickSight User Guide Account-level public setting Dashboard-level public setting Public access Visual indicators To turn off public sharing for a single dashboard 1. In QuickSight, open the published dashboard that you no longer want to share. You must be the owner or a co-owner of the dashboard. 2. 3. In the published dashboard, choose the Share icon at upper-right, and then choose Share dashboard. In the Share dashboard page that opens, toggle off the Anyone on the internet (public) switch in the Enable access for section at bottom-left. This action will remove public access to the dashboard. It will now only be accessible to users that it has been shared with. To turn off public sharing settings for all dashboards in a QuickSight user account 1. 2. 3. From the Amazon QuickSight start page, choose your user icon at upper right of your browser window, and then choose Manage QuickSight. In the page that opens, choose Security and permissions at left. Scroll down and, in the Public access to dashboards section, choose Manage. 4. On the page that opens, toggle off the Anyone on the internet switch. When you disable public sharing settings from the Public sharing menu, a pop-up will appear asking you to confirm your choice. Select I have read and acknowledge this change and then choose Confirm to confirm your choice. This action will remove public access to every dashboard on your account. Dashboards that were visible to anyone on the internet will now only be accessible to users that each dashboard has been shared with. Individual dashboards that have their public settings turned on will have Granting access to a dashboard 1292 Amazon QuickSight User Guide a gray badge and the eye icon that appears on the Dashboards page will have a strike through it to indicate that the account level public settings are disabled and that the dashboard can't be viewed. It can take up to two minutes for a dashboard's public access to be revoked. If your session capacity pricing subscription has expired, public sharing settings will be automatically removed across your account. Renew your subscription to restore access to public sharing settings. Granting everyone in your Amazon QuickSight account access to a dashboard with the QuickSight API Intended audience: Amazon QuickSight developers Alternatively, you can grant everyone in your account access to the dashboard with the QuickSight API using the UpdateDashboardPermissions operation. The following example API request illustrates how to do so using an AWS CLI command. It grants link permissions on the dashboard in your account, and allows the following operations: DescribeDashboard, QueryDashboard and ListDashboard. aws quicksight update-dashboard-permissions \ --aws-account-id account-id \ --region aws-directory-region \ --dashboard-id dashboard-id \ --grant-link-permissions Principal="arn:aws:quicksight:aws-directory-region:account-id:namespace/default", Actions="quicksight:DescribeDashboard, quicksight:QueryDashboard, quicksight:ListDashboardVersions" The response for the preceding request looks similar to the following. { "Status": 200, "DashboardArn": "arn:aws:quicksight:AWSDIRECTORYREGION:ACCOUNTID:dashboard/ DASHBOARDID", "DashboardId": "DASHBOARDID", "LinkSharingConfiguration": { "Permissions": [ Granting access to a dashboard 1293 Amazon QuickSight { "Actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:QueryDashboard" ], User Guide "Principal": "arn:aws:quicksight:AWSDIRECTORYREGION:ACCOUNTID:namespace/default" } ] }, "Permissions": [ // other dashboard permissions here ], "RequestId": "REQUESTID" } You can also prevent all users in your account from accessing the dashboard using the same API operation. The following example request illustrates how by using a CLI command. aws quicksight update-dashboard-permissions \ --aws-account-id account-id \ --region aws-directory-region \ --dashboard-id dashboard-id \ --revoke-link-permissions Principal="arn:aws:quicksight:aws-directory-region:account-id:namespace/default", Actions="quicksight:DescribeDashboard, quicksight:QueryDashboard, quicksight:ListDashboardVersions" For more information, see UpdateDashboardPermissions in the Amazon QuickSight API Reference. When all users in a QuickSight user account are granted access to the dashboard, the following snippet is added to AWS CloudTrail log as part of the eventName UpdateDashboardAccess, and the eventCategory Management. "linkPermissionPolicies": [ { "principal": "arn:aws:quicksight:AWSDIRECTORYREGION:ACCOUNTID: namespace/default", "actions": [ "quicksight:DescribeDashboard", Granting access to a dashboard 1294 Amazon QuickSight User Guide "quicksight:ListDashboardVersions", "quicksight:QueryDashboard" ] } ] Granting anyone on the internet access to an Amazon QuickSight dashboard using the QuickSight API Alternatively, you can grant anyone on the internet access to the dashboard with the Amazon QuickSight API using the UpdateDashboardPermissions operation. Before you begin, make sure to grant everyone in your account access to the dashboard. For more information, see Granting everyone in your Amazon QuickSight account access to a dashboard with the QuickSight API. The following example API request illustrates how to grant anyone on the internet access to a dashboard using an AWS CLI command. It grants link permissions on the dashboard in your account, and allows the following operations: DescribeDashboard, QueryDashboard and ListDashboardVersions. aws quicksight update-dashboard-permissions --aws-account-id account-id --region aws-directory-region --dashboard-id dashboard-id --grant-link-permissions Principal="arn:aws:quicksight:::publicAnonymousUser/*", Actions="quicksight:DescribeDashboard, quicksight:QueryDashboard, quicksight:ListDashboardVersions" The response for the preceding request looks similar to the following. { "Status": 200, "DashboardArn": "arn:aws:quicksight:AWSDIRECTORYREGION:ACCOUNTID:dashboard/ DASHBOARDID", "DashboardId": "DASHBOARDID", "LinkSharingConfiguration": { "Permissions": [ { "Actions": [ Granting access to a dashboard 1295 Amazon QuickSight User Guide "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:QueryDashboard" ], |
amazon-quicksight-user-361 | amazon-quicksight-user.pdf | 361 | dashboard with the QuickSight API. The following example API request illustrates how to grant anyone on the internet access to a dashboard using an AWS CLI command. It grants link permissions on the dashboard in your account, and allows the following operations: DescribeDashboard, QueryDashboard and ListDashboardVersions. aws quicksight update-dashboard-permissions --aws-account-id account-id --region aws-directory-region --dashboard-id dashboard-id --grant-link-permissions Principal="arn:aws:quicksight:::publicAnonymousUser/*", Actions="quicksight:DescribeDashboard, quicksight:QueryDashboard, quicksight:ListDashboardVersions" The response for the preceding request looks similar to the following. { "Status": 200, "DashboardArn": "arn:aws:quicksight:AWSDIRECTORYREGION:ACCOUNTID:dashboard/ DASHBOARDID", "DashboardId": "DASHBOARDID", "LinkSharingConfiguration": { "Permissions": [ { "Actions": [ Granting access to a dashboard 1295 Amazon QuickSight User Guide "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:QueryDashboard" ], "Principal": "arn:aws:quicksight:AWSDIRECTORYREGION:ACCOUNTID:namespace/default" }, "Principal": "arn:aws:quicksight:::publicAnonymousUser/*", "Actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:QueryDashboard" ] } ] }, "Permissions": [ // other dashboard permissions here ], "RequestId": "REQUESTID" } You can also prevent anyone on the internet from accessing the dashboard using the same API operation. The following example request illustrates how by using a CLI command. aws quicksight update-dashboard-permissions \ --aws-account-id account-id \ --region aws-directory-region \ --dashboard-id dashboard-id \ --revoke-link-permissions Principal="arn:aws:quicksight:::publicAnonymousUser/*", Actions="quicksight:DescribeDashboard, quicksight:QueryDashboard, quicksight:ListDashboardVersions" For more information, see UpdateDashboardPermissions in the Amazon QuickSight API Reference. When anyone on the internet is granted access to the dashboard, the following snippet is added to AWS CloudTrail log as part of the eventName UpdateDashboardAccess, and the eventCategory Management. "linkPermissionPolicies": [ Granting access to a dashboard 1296 Amazon QuickSight { "principal": "arn:aws:quicksight:::publicAnonymousUser/*", "actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:QueryDashboard" ] } ] User Guide Sharing a link a shared dashboard After you grant users access to a dashboard, you can copy a link to it and send it to them. Anyone with access to the dashboard can access the link and see the dashboard. To send users a link to the dashboard 1. Open the published dashboard and choose Share at upper right. Then choose Share dashboard. 2. In the Share dashboard page that opens, choose Copy link at upper left. The link to the dashboard is copied to your clipboard. It's similar to the following, https://quicksight.aws.amazon.com/sn/accounts/accountid/ dashboards/dashboardid?directory_alias=account_directory_alias Users and groups (or all users on your QuickSight account) who have access to this dashboard can access it by using the link. If they are accessing QuickSight for the first time, they will be asked to sign in with their email address or QuickSight user name and password for the account. After they sign in, they will have access to the dashboard. Sharing a link a shared dashboard 1297 Amazon QuickSight User Guide View who has access to a shared dashboard Use the following procedure to see which users or groups have access to the dashboard. 1. Open the published dashboard and choose Share at upper right. Then choose Share dashboard. 2. In the Share dashboard page that opens, under Manage permissions, review the users and groups, and their roles and settings. You can search to locate a specific user or group by entering their name or any part of their name in the search box at upper right. Searching is case-sensitive, and wildcards aren't supported. Delete the search term to return the view to all users. Revoke access to a shared dashboard Use the following procedure to revoke user access to a dashboard. To revoke user access to a dashboard 1. Open the dashboard and choose Share at top right. Then choose Share dashboard. 2. In the Share dashboard page that opens, under Manage permissions, locate the user that you want to remove and choose the delete icon at far right. Sharing your view of a Amazon QuickSight dashboard While interacting with a published dashboard, you can choose to share a unique link to the dashboard with only your changes. For example, if you filter the data in the dashboard, you can share what you see with others who have permissions to see the dashboard. That way, they can see what you see, without your having to create a new dashboard. When others access your view of the dashboard by using the link that you sent them, they see the dashboard exactly as it was when the link was created. They see any parameters, filters, or controls that you changed. To share your view of a dashboard 1. Open the published dashboard, and make any changes that you want. 2. Choose Share at upper right, and then choose Share this view. View who has access 1298 Amazon QuickSight User Guide 3. On the Share using a link page that opens, choose Copy link. 4. Paste the link in an email or IM message to share it with others. Only people with permissions to see the dashboard in QuickSight can access the link. Scheduling and sending QuickSight reports by email Important Amazon QuickSight in the Europe (Spain) (eu-south-2) region uses an internal email service (Amazon SES) in the Europe (Ireland) (eu-west-1) to send emails to QuickSight users. Customer data that's |
amazon-quicksight-user-362 | amazon-quicksight-user.pdf | 362 | 2. Choose Share at upper right, and then choose Share this view. View who has access 1298 Amazon QuickSight User Guide 3. On the Share using a link page that opens, choose Copy link. 4. Paste the link in an email or IM message to share it with others. Only people with permissions to see the dashboard in QuickSight can access the link. Scheduling and sending QuickSight reports by email Important Amazon QuickSight in the Europe (Spain) (eu-south-2) region uses an internal email service (Amazon SES) in the Europe (Ireland) (eu-west-1) to send emails to QuickSight users. Customer data that's included in scheduled reports, alerts, and other features are passed by email from Europe (Spain) to Europe (Ireland) before it reaches QuickSight users. As a privacy protection measure, the following features that send customer data in emails have been limited or disabled by default. • File attachments and sheet previews in Scheduled Report emails. The download link option is the default. • Emails that use threshold alerts. • Anomaly detection alerts. For more information about AWS privacy features, see Privacy Features of AWS Services. In Enterprise edition, you can send a dashboard in report form either once or on a schedule (daily, weekly, monthly, or yearly). You can email the reports to users or groups who share your Amazon QuickSight subscription. To receive email reports, the users or group members must meet the following conditions: • They are part of your Amazon QuickSight subscription. • You already shared the dashboard with them. • They have completed sign-up process to activate their subscription as Amazon QuickSight readers, authors, or admins. • Amazon QuickSight can't send scheduled emails to more than 5,000 members. Sending reports 1299 Amazon QuickSight User Guide Amazon QuickSight generates a custom email snapshot for each user or group based on their data permissions, which are defined in the dashboard. Row Level Security (RLS), Column Level Security (CLS) and Dynamic Default Parameters for email reports works for both scheduled and ad hoc (one-time) emails. QuickSight authors can run scheduled reports with the Report now button in the QuickSight console or with the StartDashboardSnapshotJobSchedule API. Subscribers who are readers see an option for Reports on the dashboard when an email report is available for that dashboard. They can use the Schedules menu to subscribe to or unsubscribe from the emails. For more information, see Subscribing to email reports in Amazon QuickSight. You can create up to five schedules for each dashboard. QuickSight dashboard viewers can also schedule their own reports for themselves from a QuickSight dashboard. For more information about reader generated reports, see Creating a reader generated report in Amazon QuickSight. Use the following topics to learn more about email report settings and report billing. Topics • Configuring email report settings for a QuickSight dashboard • How billing works for email reports Configuring email report settings for a QuickSight dashboard Applies to: Enterprise Edition In Amazon QuickSight Enterprise edition, you can email a report from any sheet in a dashboard. You can send reports from interactive dashboards and paginated report sheets. Schedules include settings for when to send them, the contents to include, and who receives the email. You can view a sample report and a list of the datasets used in the report. To set up or change the schedule sent from a dashboard, make sure that you're an owner or co-owner of the dashboard. If you have access to the dashboard, you can change your subscription options by opening your view of the dashboard. For more information on how this works, see Subscribing to email reports in Amazon QuickSight. Configuring email reports 1300 Amazon QuickSight User Guide Scheduling options that are available for an email report include the following: • Once (Does not repeat) – Sends the report only once at the date and time that you choose. • Daily – Repeats daily at the time that you choose. • Weekly – Repeats each week on the same day or days at the time that you choose. You can also use this option to send reports in weekly intervals, such as every other week or every three weeks. • Monthly – Repeats each month on the same day of the month at the time that you choose. You can also use this option to send reports on specific days of the month, such as the second Wednesday or the last Friday of each month. • Yearly – Repeats each year on the same day of the month or months selected at the time that you choose. You can also use this option to send reports on specific days or sets of days in selected months. For example, you can configure a report to be sent on the first Monday of January, March, and September, or on July |
amazon-quicksight-user-363 | amazon-quicksight-user.pdf | 363 | day of the month at the time that you choose. You can also use this option to send reports on specific days of the month, such as the second Wednesday or the last Friday of each month. • Yearly – Repeats each year on the same day of the month or months selected at the time that you choose. You can also use this option to send reports on specific days or sets of days in selected months. For example, you can configure a report to be sent on the first Monday of January, March, and September, or on July 14th, or on the second day of February, April, and June each year. • Custom – Configure your own scheduled report that best fits your business needs. You can customize the title of the report, the optional email subject, and the body text. Although you can configure the report so that everyone who has access receives a copy, this is not usually the best plan. We recommend limiting automated emails, especially those sent to groups. You can start with a small number of subscribers by choosing specific people from the access list. Verify your company's policy before subscribing anyone to a subscription. You can directly add people to a report subscription in these ways: • (Recommended) Choose recipients from the provided access list to specify and maintain a list of people who you want to email reports to. You can use the search box to find people by email or group name. • To send reports to all of the dashboard's subscribers, choose Send email report to all users with access to dashboard when prompted. Anyone else who wants to get the emails can open the dashboard and set their own subscription options to either opt in or opt out. Configuring email reports 1301 Amazon QuickSight Important User Guide When you share the dashboard with new QuickSight user names or groups, they automatically start receiving the email reports. If you don't want this to happen, you need to edit the report settings each time you add people to the dashboard. For existing email schedules, you can pause the schedule in Amazon QuickSight while you make changes. In the Schedules pane, you can pause or resume a scheduled report with the toggle that appears under each report. Pausing a report does not delete the report's schedule from QuickSight. If your report includes custom visuals, be aware that you can't include images from a private network in an email report, even if you can access the images. If you want to include an image, use a publicly available one. Before you begin, make sure that you are using Amazon QuickSight Enterprise edition and that you have shared the dashboard with intended recipients. To create or change an email report 1. Open Amazon QuickSight and choose Dashboards on the navigation pane at left. 2. Open a dashboard to configure its email report. 3. At top right, choose Schedules, and then choose Schedules. 4. Choose ADD SCHEDULE. Configuring email reports 1302 Amazon QuickSight User Guide 5. In the New schedule pane that appears, enter the schedule name. Optionally, add a description for the new schedule. 6. 7. In the Content tab, toggle the PDF, CSV, or Excel switches to choose the report format. CSV and Excel format are currently supported for paginated reports. In the Sheet dropdown on the Content tab, choose the sheet that you want to schedule a report for. If you choose CSV or Excel, choose the table or pivot table visuals from any sheet of the dashboard that you want to include in the report. You can select up to 5 visuals for each schedule. If you choose Excel, one Excel workbook is generated as a final output. Configuring email reports 1303 Amazon QuickSight User Guide 8. In the Dates tab, choose the frequency for the report in the Repeat dropdown. If you're not sure, choose Send once (Does not repeat). Configuring email reports 1304 Amazon QuickSight User Guide 9. For Start date, choose the start date and runtime that you want to send the first report on. 10. For Timezone, choose the time zone from the dropdown. 11. In the Email tab, for E-mail subject line, enter a custom subject line, or leave it blank to use the report title. 12. Enter the email addresses of the QuickSight group name of the users or groups that you want to receive the report. You can also select the Send to all users with access box to send the report to everyone that has access to the dashboard in your account. 13. For Email header, enter the header that you want the emal report to show. 14. (Optional) For E-mail body text, leave it blank or enter a custom message to |
amazon-quicksight-user-364 | amazon-quicksight-user.pdf | 364 | the Email tab, for E-mail subject line, enter a custom subject line, or leave it blank to use the report title. 12. Enter the email addresses of the QuickSight group name of the users or groups that you want to receive the report. You can also select the Send to all users with access box to send the report to everyone that has access to the dashboard in your account. 13. For Email header, enter the header that you want the emal report to show. 14. (Optional) For E-mail body text, leave it blank or enter a custom message to display at the beginning of the email. Configuring email reports 1305 Amazon QuickSight User Guide 15. (Optional) For PDF attachments, you can choose Include sheet in email body to show the first page of the PDF snapshot in the email's body. Configuring email reports 1306 Amazon QuickSight User Guide 16. Choose the method of attachment that you want the report to use. The following options are available. • File attachment– uploads an attachment of the snapshot to the email. The email size can't exceed 10 MB. This limit includes all attachments. • Download link– adds a link to the email body that users can access to download the snapshot report. When a user chooses the download link, they are prompted to sign in before the report starts to download. The link expires one year after the report is sent. Configuring email reports 1307 Amazon QuickSight User Guide 17. (Optional, recommended) To send a sample of the report before you save changes, choose Send test report. This option displays beside the user name of the owner of the dashboard. 18. Do one of the following: • (Recommended) Choose Save to confirm your entries. • To immediately send a report, choose Save and run now. The report is sent immediately, even if your schedule's start date is in the future. How billing works for email reports Authors and admins can receive any number of email reports at no extra charge. For readers (users in the reader role), it costs one session per report, up to the monthly maximum. After receiving an email report, the reader gets a session credit to access the dashboard at no additional cost during the same month. Reader session credits don't carry over to the next billing month. For a reader, charges for email reports and interactive sessions both accrue up to the monthly maximum charge. For readers who hit the monthly max charge, there are no further charges, and they can receive as many additional email reports as they need. Subscribing to email reports in Amazon QuickSight In Enterprise edition, Amazon QuickSight authors can set up subscriptions to a dashboard in report form. For more information, see Scheduling and sending QuickSight reports by email. QuickSight readers and authors can then subscribe to a dashboard and adjust their report settings. For more information about subscribing to dashboards as a reader, see Subscribing to Amazon QuickSight dashboard emails and alerts. Use the following procedure to change your subscription and report settings for a specific dashboard. 1. First, open a dashboard that is shared with you, or a dashboard that you own or co-own. 2. Choose the Reports icon at top right. Report billing 1308 Amazon QuickSight User Guide 3. The Change report preferences screen appears. This screen shows the current report schedule, in addition to the subscription and optimization options. For Subscription, choose Subscribe to start receiving reports, or Unsubscribe to stop receiving reports. Under Optimize, choose the device you prefer to view the report on. • If you usually use a mobile device or you prefer to view reports in a portrait format, choose Viewing on a mobile device. When you receive the report, the visuals display in a single vertical column. • If you usually use a desktop or you prefer to view reports in a landscape format, choose Viewing on a desktop. When you receive the report, the visuals display in the same layout shown in your dashboard on your desktop. 4. Choose Update to confirm your choices, or choose Cancel to discard your changes. Subscribing to reports 1309 Amazon QuickSight User Guide Working with threshold alerts in Amazon QuickSight Applies to: Enterprise Edition To stay informed about important changes in your data, you can create threshold alerts using KPI, Gauge, Table, and Pivot table visuals in an Amazon QuickSight dashboard. With these alerts, you can set thresholds for your data and be notified by email when your data crosses them. You can also view and manage your alerts at anytime in a QuickSight supported web browser. For example, let's say that you're a customer success manager for a large organization and you want to know when the number of tickets in a support queue exceeds |
amazon-quicksight-user-365 | amazon-quicksight-user.pdf | 365 | alerts in Amazon QuickSight Applies to: Enterprise Edition To stay informed about important changes in your data, you can create threshold alerts using KPI, Gauge, Table, and Pivot table visuals in an Amazon QuickSight dashboard. With these alerts, you can set thresholds for your data and be notified by email when your data crosses them. You can also view and manage your alerts at anytime in a QuickSight supported web browser. For example, let's say that you're a customer success manager for a large organization and you want to know when the number of tickets in a support queue exceeds a certain number. Let's say too that you have a dashboard with a KPI, Gauge, Table or Pivot table visual that tracks the number of tickets in this queue. In this case, you can create an alert and be notified by email when the number exceeds the threshold you specified. That way, you can take action as soon as you're notified. You can create multiple alerts for a single visual. If the visual is updated or deleted by the author after you create an alert, your alert settings don't change. When you create an alert, the alert takes on any filters applied to the visual at that time. If you or the author changes the filter, your existing alert doesn't change. However, if you create a new alert, your new alert takes on the new filter settings. For example, let's say you have a dashboard with a filter control that you can use to switch the data for each visual in the dashboard from one US city to another. You have a KPI visual on the dashboard that shows average flight delays, and you're interested in delays for flights leaving from Seattle, Washington, in the US. You change the filter control to Seattle and set an alert on the visual. This alert tracks flight delays from Seattle. Tomorrow, let's say that you want to also track flight delays from Portland, Oregon, so you change the filter control to Portland and create another alert. This new alert tracks flight delays from Portland. You now have two alerts, one on Seattle and one on Portland, working independently. Threshold alerts are not available in the eu-central-2 Europe (Zurich) region. For more information on KPI, Gauge, Table, or Pivot table visuals, see Visual types in Amazon QuickSight. Threshold alerts 1310 Amazon QuickSight Note User Guide You can't create alerts for visuals in an embedded dashboard or from the QuickSight mobile app. For table visuals, threshold alerts can't be created for values that are located in the Group by field well. Alerts can only be created for values that are located in the Value field well. KPI visuals that don't use a date-time field as a trend don't support alerts. An example is a KPI that shows the difference in flights between carriers X and Y instead of a KPI that shows the difference in flights between dates A and B. Use the sections below to create and configure threshold alerts for KPI, Gauge, Table, and Pivot table visuals in QuickSight. Topics • Alert Permissions • Creating Alerts • Managing Threshold Alerts • Investigating Alert Failures • Alert Scheduling Alert Permissions If you're an administrator, you can control who in your organization can set threshold alerts in QuickSight by creating a custom permissions policy. To set custom permissions in QuickSight, choose your user name at the upper-right corner of any QuickSight page, choose Manage QuickSight, and then choose Manage permissions. Creating Alerts Use the following procedure to create threshold alerts for KPI or Gauge visuals in a dashboard. To create an alert 1. Open QuickSight and navigate to the dashboard that you want. Alert Permissions 1311 Amazon QuickSight User Guide For more information about viewing dashboards as a dashboard subscriber in QuickSight, see Interacting with Amazon QuickSight dashboards. 2. In the dashboard, select the visual that you want to create an alert for, open the menu at the upper-right, and choose Create alert. 3. On the menu at upper-right on the visual, choose the Create alert icon. Alternatively, you can choose the alert icon in the blue toolbar at upper right. Then, in the Create alert page that opens, select the KPI, Gauge, Table or Pivot table visual that you want to create an alert for, and then choose Next. You can also create alerts on table or pivot table visuals by selecing a cell and choosing Create alert. You can only create alerts for single cells. Alerts can't be created for entire columns or for values that use a custom aggregation. For more information about custom aggregations, see Aggregate functions. Creating Alerts 1312 Amazon QuickSight User Guide 4. On the Create alert page that opens at right, do the following: a. For Name, enter |
amazon-quicksight-user-366 | amazon-quicksight-user.pdf | 366 | alert page that opens, select the KPI, Gauge, Table or Pivot table visual that you want to create an alert for, and then choose Next. You can also create alerts on table or pivot table visuals by selecing a cell and choosing Create alert. You can only create alerts for single cells. Alerts can't be created for entire columns or for values that use a custom aggregation. For more information about custom aggregations, see Aggregate functions. Creating Alerts 1312 Amazon QuickSight User Guide 4. On the Create alert page that opens at right, do the following: a. For Name, enter a name for the alert. By default, the visual name is used for the alert name. You can change it if you want. b. For Value to track, choose a value that you want to set the threshold for. The information presented will vary based on the visual type you're creating an alert for. The values that are available for this option are based on the values the dashboard author sets in the visual. For example, let's say you have a KPI visual that shows a percent difference between two dates. Given that, you see two alert value options: percent difference and actual. If there is only one value in the visual, you can't change this option. It is the current value and it is displayed here so that you can use it as a reference while you choose a threshold. Creating Alerts 1313 Amazon QuickSight User Guide For example, if you're setting an alert on average cost, this value will show you what the current average cost is (say, $5). With this reference value you can make more informed decisions while setting your threshold. c. For Condition, choose a condition for the threshold. You can choose the following conditions. • Is above – Sets a rule that the alert triggers if the alert value goes above the threshold you set. • Is below – Sets a rule that the alert triggers if the alert value goes below the threshold that you set. • Is equal to – Sets a rule that the alert triggers if the alert value is equal to the threshold you set. For Threshold, enter a value to prompt the alert. For Notification preference, choose how often you want to be notified about a breach to the threshold you set. d. e. You can choose from the following options. • As frequently as possible - This option alerts you whenever the threshold is breached. If you choose this option, you might get alerts multiple times a day. • Daily at most - This option alerts you once per day when the threshold is breached. • Weekly at most - This option alerts you once per week when the threshold is breached. f. (Optional) Choose Email me when there is no data - When you select this option, you're notified when there's no data to check your alert rule against. g. Choose Save. A message at upper-right appears indicating that the alert has been saved. If your data crosses the threshold you set, you get a notification by email at the address that's associated with your QuickSight account. Creating Alerts 1314 Amazon QuickSight User Guide Managing Threshold Alerts You can edit your existing alerts, turn them on or off, or view the history of times when the alert was triggered. Use the following procedures to do so. To edit an existing alert 1. Open QuickSight, choose Dashboards, and then navigate to the dashboard that you want to edit an alert for. 2. On the Dashboards page, choose Alerts at upper-right. Managing Threshold Alerts 1315 Amazon QuickSight User Guide 3. On the Manage alerts page that opens, find the alert that you want to edit, and then choose Edit beneath the alert name. You can edit the alert name, condition, and threshold. 4. Choose Save. To view the history of when an alert was triggered 1. Open QuickSight, choose Dashboards, and then navigate to the dashboard that you want to view alert history for. 2. On the Dashboards page, choose Alerts at upper-right. 3. On the Manage alerts page that opens, find the alert that you want to view the history for, and then choose History beneath the alert name. To turn on or turn off an existing alert 1. Open QuickSight, choose Dashboards, and navigate to the dashboard that you want to turn on or turn off an alert for. 2. On the Dashboards page, choose Alerts at upper-right. 3. On the Manage alerts page that opens, find the alert that you want to turn on or off, and then select or clear the toggle by the alert name. The alert is turned on when the toggle is blue, and turned off when the toggle is gray. |
amazon-quicksight-user-367 | amazon-quicksight-user.pdf | 367 | view the history for, and then choose History beneath the alert name. To turn on or turn off an existing alert 1. Open QuickSight, choose Dashboards, and navigate to the dashboard that you want to turn on or turn off an alert for. 2. On the Dashboards page, choose Alerts at upper-right. 3. On the Manage alerts page that opens, find the alert that you want to turn on or off, and then select or clear the toggle by the alert name. The alert is turned on when the toggle is blue, and turned off when the toggle is gray. To delete an existing alert 1. Open QuickSight, choose Dashboards, and navigate to the dashboard that you want to delete an alert from. 2. On the Dashboards page, choose Alerts at upper-right. 3. On the Manage alerts page that opens, find the alert that you want to turn on or off, choose the three-dot menu next to the alert, and then choose Delete from the dropdown. Managing Threshold Alerts 1316 Amazon QuickSight User Guide Investigating Alert Failures When an alert fails, QuickSight sends you an email notification about the failure. Alerts can fail for many reasons, including the following: • The dataset the alert is using was deleted. • The owner of the alert lost permissions to the dataset or to certain rows or columns in the dataset. • The owner of the alert lost access to the dashboard. • There is no data for the data tracked by the alert. When a failure occurs, QuickSight sends you a notification and disables the alert if the reason for the failure isn't likely to be fixed. For example, if the alert fails due to the loss of access to a dashboard, or if the dashboard was deleted. Otherwise, QuickSight attempts to check your data for threshold breaches again. After four failures, QuickSight turns off the alert and notifies you that the alert is turned off. If the alert can be checked again, QuickSight sends you a notification. To investigate why an alert failed, check that you still have access to the dashboard. Also check that you have permissions to the correct dataset and to the correct rows and columns in the dataset. If you have lost access or permissions, contact the dashboard owner. If you have the necessary access and permissions, you might need to edit your alert to avoid future alert failures. Investigating Alert Failures 1317 Amazon QuickSight Alert Scheduling User Guide When you create an alert, QuickSight checks your data for any breaches against the thresholds you set based on when your dataset is scheduled to refresh. The information presented in the alert varies based on the visual type that you're creating an alert for. For SPICE datasets, alert rules are checked after a successful refresh of your SPICE dataset. For direct query datasets, alert rules are checked at a random time between 6:00 PM and 8:00 AM in the AWS Region that holds the dataset by default. If you're a dataset owner, you can set an alert evaluation schedule in the dataset settings. See the following procedure to learn how. To set an alert evaluation schedule for a dataset 1. In QuickSight, choose Datasets in the navigation bar at left. 2. Choose the dataset name that you want to schedule alert evaluations for. 3. Choose Set alert schedule. 4. In the Set alert schedule page that opens, do the following. • For Time zone, choose a time zone. • For Repeats, choose how often you want the data to be evaluated. • For Starts, enter the time that you want the alert evaluation to start. Printing a dashboard or analysis You can print a dashboard or an analysis in Amazon QuickSight. Use the following procedure to print. 1. Open the dashboard or the analysis that you want to print. 2. Choose the Print icon at top right. 3. On the Prepare for printing screen, choose the paper size and orientation that you want to use. 4. Choose Go to Preview. 5. Do one of the following: • To proceed to printing, choose Print to open your operating system's print dialog. Alert Scheduling 1318 Amazon QuickSight User Guide • To make changes to the paper size or orientation, choose Configure. 6. To exit the preview screen, choose Exit preview. Exporting Amazon QuickSight analyses or dashboards as PDFs You can export content from a dashboard into a Portable Document Format file (PDF). Similar to a print-out, this format provides a snapshot of the current sheet as it appears on-screen at the time of download. To export a dashboard sheet as a PDF 1. Open Amazon QuickSight and choose Dashboards on the navigation pane at left. 2. Open the dashboard that you want to export. 3. At upper right, choose Export, |
amazon-quicksight-user-368 | amazon-quicksight-user.pdf | 368 | To make changes to the paper size or orientation, choose Configure. 6. To exit the preview screen, choose Exit preview. Exporting Amazon QuickSight analyses or dashboards as PDFs You can export content from a dashboard into a Portable Document Format file (PDF). Similar to a print-out, this format provides a snapshot of the current sheet as it appears on-screen at the time of download. To export a dashboard sheet as a PDF 1. Open Amazon QuickSight and choose Dashboards on the navigation pane at left. 2. Open the dashboard that you want to export. 3. At upper right, choose Export, Download as PDF. The download is prepared in the background. When the file is ready to download, a message appears saying Your PDF is ready.. 4. Choose Download now to download the file. Choose Close to close without downloading. If you close this dialog box without downloading the file and want to recreate the file, repeat the previous step. Also, the downloadable file is available only temporarily for five minutes. If you wait too long to download it, the file expires. If this happens, QuickSight instead displays an error message saying that the request has expired. 5. Repeat the previous steps for each sheet that you want to export. You can also attach PDFs to dashboard email reports. For more information, see Scheduling and sending QuickSight reports by email. Error codes for failed PDF export jobs When you generate PDF reports in Amazon QuickSight, you may encounter instances where your request to generate a PDF report fails. There are many reasons why a failure might occur. QuickSight provides error codes that can help you understand why the error occured and provide guidance to troubleshoot the issue. The following table lists the error codes that QuickSight returns when a PDF export job fails. Exporting as PDFs 1319 Amazon QuickSight Error code INVALID_DATAPREP_SYNTAX POST_AGGREGATED_METRIC_AS_DIMENSION SPICE_TABLE_NOT_FOUND FIELD_NOT_FOUND FIELD_ACCESS_DENIED User Guide Guidance Check the syntax for your calculated fields, and try again. Aggregated metrics/operands can't be used as visual's grouping dimensions. Choose a valid visual's grouping dimensions, and try again. The dataset has been deleted or is unavailable. Import a valid dataset, and try again. A field is no longer available. Update or replace the missing fields in this dataset, and try again. You don't have access to some fields in this dataset. Request access, and try again. PERMISSIONS_DATASET_INVALID_COLUMN_V ALUE An invalid row level permission column value was found. Check your parent dataset rules, COLUMN_NOT_FOUND INVALID_COLUMN_TYPE PERMISSIONS_DATASET_USER_DENIED DATA_SOURCE_TIMEOUT and try again. Replace the missing columns in your filters or parameters, and try again. Some fields' data types have been changed and can not be automatically updated. Adjust these fields in your dataset, and try again. You don't have access to this dataset. Request access to this dataset, and try again. Your query has timed out. Reduce the amount of data, or import the data into SPICE, and try again. PDF Error codes 1320 Amazon QuickSight Error code MAX_PAGE_EXCEEDED_ERROR INSUFFICIENT_BODY_HEIGHT_ERROR FIRST_PAGE_HEIGHT_TOO_SMALL_ERROR INTERNAL_ERROR User Guide Guidance Your file is ready but content is not complete. PDFs have a 1,000 page limit. Choose a shorter PDF, and try again. Adjust the header and footer to be less than the page height, and try again. Adjust sections to make room for your tables, and try again. We can't create your PDF right now. Wait a few minutes, and try again. Organizing assets into folders for Amazon QuickSight Applies to: Enterprise Edition In Amazon QuickSight Enterprise edition, your team members can create personal and shared folders to add hierarchical structure to QuickSight asset management. Using folders, people can more easily organize, navigate through, and discover dashboards, analyses, datasets, data sources, and topics. Within a folder, you can still use your usual tools to search for assets or to add assets to your favorites list. You can use the following types of folders with QuickSight: • Personal folders to organize work for yourself. Personal folders are visible only to the person who owns them. You can't transfer ownership of personal folders to anyone else. • Shared folders: • Shared folders organize work and simplify sharing among multiple people. To create and manage shared folders, you need to be a QuickSight administrator. • Shared restricted folders are a type of shared folder in QuickSight that ensure that assets remain in the shared folder. Assets that are created from assets that exist within a shared Organizing assets into folders 1321 Amazon QuickSight User Guide restricted folder must also stay in the restricted folder. Assets that are located in restricted folders can't be moved or shared outside of the restricted folder. For example, if you create a dataset that uses a data source that's located in a shared restricted folder, the new dataset can't be moved outside of that shared restricted folder. Assets |
amazon-quicksight-user-369 | amazon-quicksight-user.pdf | 369 | administrator. • Shared restricted folders are a type of shared folder in QuickSight that ensure that assets remain in the shared folder. Assets that are created from assets that exist within a shared Organizing assets into folders 1321 Amazon QuickSight User Guide restricted folder must also stay in the restricted folder. Assets that are located in restricted folders can't be moved or shared outside of the restricted folder. For example, if you create a dataset that uses a data source that's located in a shared restricted folder, the new dataset can't be moved outside of that shared restricted folder. Assets that are located in a restricted folder can be moved within the restricted folder tree into one or more subfolders. Subfolders of restricted folders behave like restricted folders, but dependent assets can exist in different subfolders under the same root restricted folder. The root restricted folder acts as a boundary that all assets in all subfolders can exist in as long as they remain within the root folder tree. For example, a dataset that is located in one subfolder can use a data source that is located either another subfolder in the same folder tree or in the root folder. Any supported asset type can be created in a root folder or in any of its subfolders. Users can have different roles in different subfolders. Subfolder permissions are inherited from the parent folders of that subfolder. Restricted folders can only be created with the QuickSight CreateFolder API operation. • Users that are viewers on a folder and have the Author or Admin role in QuickSight can view all asset types that are in the folder. Users that are viewers on a folder and have the Reader role in QuickSight can only see dashboards and stories that are in the folder. All shared folders are visible to people who have access to them. Use the following topics to learn more about creating and configuring a folder or subfolder in QuickSight. Topics • Considerations for QuickSight folders • Overview of QuickSight folders • Permissions for QuickSight shared folders • Create and manage membership permissions for QuickSight shared folders • Creating QuickSight scaled folders with the QuickSight APIs Considerations for QuickSight folders Before you get started creating and modifying folders in Amazon QuickSight, review the following limitations that apply to QuickSight folders. Considerations 1322 Amazon QuickSight User Guide • You can't share folders in your AWS account with people in other AWS accounts. • For people who have QuickSight reader permissions, the following limitations apply: • Readers can't own a personal or shared folder. • Readers can't create or manage folders or folder content. • Readers can't have the contributor access level. • In shared folders, readers can only see dashboard assets. In addition, these limitations apply specifically to shared folders: • The name of a shared folder (at the top level of the tree) must be unique in your AWS account. • In a single folder, multiple assets can't have the same name. For example, in your top-level folder, you can't create two subfolders with the same name. In the same folder, you can't add two assets with the same name, even if they have different asset IDs. The path to each asset behaves like an Amazon S3 key name. It must be unique in your AWS account. • Restricted shared folders can only be created with the QuickSight CLI. For Amazon QuickSight quotas, the Service Quotas console provides the most accurate and up-to- date information. You can do the following in the Service Quotas console: • View the default Amazon QuickSight quotas for each AWS Region • Request quota increases for adjustable quotas When you finish reviewing the folder limitations, see Overview of QuickSight folders to learn more about the different types of folder available in Amazon QuickSight. Overview of QuickSight folders In Amazon QuickSight, you can create personal and shared folders. You can also favorite your personal or shared folders for quick access by choosing the favorite ( icon next to it. You can do the following with personal folders: • Create subfolders. Overview of QuickSight folders ) 1323 Amazon QuickSight User Guide • Add assets to your folder, including analyses, dashboards, datasets, and data sources. To add assets to a personal folder, you must already have access to the assets. Multiple assets can have the same name. Shared folders (unrestricted) QuickSight administrators can perform the following tasks with shared folders. • Create or delete a shared folder and subfolders inside of it. You can move either of these around within the top-level folder. • Add or remove owners, contributors, and viewers. When you make a person an owner of the folder, you give them ownership of every asset in the folder. For more information, see Permissions for QuickSight shared |
amazon-quicksight-user-370 | amazon-quicksight-user.pdf | 370 | analyses, dashboards, datasets, and data sources. To add assets to a personal folder, you must already have access to the assets. Multiple assets can have the same name. Shared folders (unrestricted) QuickSight administrators can perform the following tasks with shared folders. • Create or delete a shared folder and subfolders inside of it. You can move either of these around within the top-level folder. • Add or remove owners, contributors, and viewers. When you make a person an owner of the folder, you give them ownership of every asset in the folder. For more information, see Permissions for QuickSight shared folders. The following table summarizes the actions that a QuickSight user can take when working with unrestricted shared folders based on their role. Action Owner Contributor Viewer Share an asset in a folder with users that don't have access to the folder Modify folder permissions Create assets in the folder Modify assets in the folder Delete assets in the folder Yes No Yes Yes Yes Yes No Yes Yes Yes No No No No No Overview of QuickSight folders 1324 Amazon QuickSight User Guide Action Owner Contributor Viewer Add an existing asset to a folder Remove an asset from a shared folder View assets in the folder Create downstream assets outside of the shared folder that use assets that are located in the shared folder Create downstream assets in the folder that use assets that are located outside of the folder Create subfolders Delete subfolders Manage subfolder permissons Yes Yes Yes Yes Yes No Yes Yes No No Yes Yes* Yes Yes No Yes Yes Yes Yes No No No No No Overview of QuickSight folders 1325 Amazon QuickSight User Guide Action Owner Contributor Viewer Add existing assets to subfolders Create new assets in subfolders Yes No Yes Yes Delete assets in subfolders Yes Yes No No No *The user must be assigned an admin or author role to create assets. Restricted shared folders Restricted shared folders provide an additional security boundary that restricts the sharing of data outside of the folder. Administrators with the appropriate IAM permissions can perform the following tasks with restricted shared folders. • Restricted folders can be created using the CreateFolder API operation. For more information about the CreatFolder API operation, see CreateFolder. • The contributor role is assigned to users that can create and edit assets within the restricted folders. Contributors can't manage the permissions of the folder or of the assets that are in the restricted folder. • Administrators can assign folder contributor and viewer permissions to users with the UpdateFolderPermissions API operation. For more information about the UpdateFolderPermissions API operation, see UpdateFolderPermissions. The following table summarizes the actions that a QuickSight user can take when working with restricted shared folders based on their role. Overview of QuickSight folders 1326 Amazon QuickSight User Guide Action Contributor Viewer No No No No No No No Yes No Share an asset in a folder with users that don't No have access to the folder No Yes Yes Yes No No Yes No Modify folder permissio ns Create assets in the folder Modify assets in the folder Delete assets from the folder Add an existing asset to a folder Remove an asset from a shared folder View assets in the folder Create downstream assets outside of the shared folder that use assets that are located in the shared folder Create downstream assets in the folder that use assets that are located outside of the folder No No Overview of QuickSight folders 1327 Amazon QuickSight User Guide Action Contributor Viewer Create subfolders Delete subfolders Manage subfolder permissions Add existing assets to subfolders Create new assets in subfolders Delete assets from subfolders Yes No No No Yes Yes No No No No No No The owner role is not supported for restricted shared folders. After you choose which folder type best fits your use case, see Permissions for QuickSight shared folders and Create and manage membership permissions for QuickSight shared folders to create folders and set up folder permissions. Permissions for QuickSight shared folders Shared folders have three permission levels. To set folder-level permissions for a user or group, see Create and manage membership permissions for QuickSight shared folders. • Owners - The folder owner owns everything (folders, analyses, dashboards, datasets, data sources, topics) inside of the folder. They can create, edit, and delete the assets in the folder, modify permissions on the folder and its assets, and delete the folder entirely. The owner role is not supported for restricted shared folders. • Contributors - A contributor can create, edit, and delete assets in a folder just like an owner. They can't delete the folder or modify permissions on the folder or on assets where they have contributor access that they inherited from the folder. Permissions 1328 Amazon |
amazon-quicksight-user-371 | amazon-quicksight-user.pdf | 371 | folders. • Owners - The folder owner owns everything (folders, analyses, dashboards, datasets, data sources, topics) inside of the folder. They can create, edit, and delete the assets in the folder, modify permissions on the folder and its assets, and delete the folder entirely. The owner role is not supported for restricted shared folders. • Contributors - A contributor can create, edit, and delete assets in a folder just like an owner. They can't delete the folder or modify permissions on the folder or on assets where they have contributor access that they inherited from the folder. Permissions 1328 Amazon QuickSight User Guide • Viewers - A viewer can only view the assets (folders, dashboards, datasets, data sources, topics) in the folder. A viewer can't edit or share those assets. The following rules also apply to security for shared folders: • QuickSight readers' sharing status for a folder gets shared with the folder. However, a reader gets only read access to folders, and only dashboard access to visuals. • AWS security is enforced on every object within a folder. The folder applies the same type of security to the assets of whoever the folder is shared with according to their access level (admin, author, or reader). • The top-level folder is the root folder of any subfolders. When a subfolder is shared at any level, the person whom the folder was shared with sees the root folder in the top-level folders view. • The folder permission is the permission on the current folder, combined with permissions of all the folders leading to the root folder. • A shared asset inherits its permission from the folder. A shared asset is created when an asset that belongs to the folder owner is added to a shared folder. • If you own an unrestricted shared folder, you can transfer ownership of the folder to another QuickSight admin. • The owner role is not supported for restricted folders. The contributor role is assigned to authors that create and edit assets within the restricted folders. Folder contributors can't manage the permissions of the restricted folder or its assets. • The correct IAM permissions are required to update the permissions of a restricted shared folder with the UpdateFolderPermissions API. To create and manage permissions of a shared folder, see Create and manage membership permissions for QuickSight shared folders. Create and manage membership permissions for QuickSight shared folders Shared folders (unrestricted) To create a shared folder and to share the folder with one or more groups in the QuickSight console, you must be an Amazon QuickSight administrator. You can also create a shared folder Create a shared folder 1329 Amazon QuickSight User Guide with the CreateFolder API operation. Use the following procedure to share or modify the membership permissions of a shared folder. 1. From the left navigation, choose Shared folders and find the folder that you want to share or manage permissions for. 2. To open the actions menu for that folder's row, choose the ellipsis (three dots). 3. Choose Share. 4. 5. In the Share folder modal, add the groups and users with whom you want to share the contents of the folder. For each user and group that you add, choose a permission level from the Permissions menu in that row. 6. To update the permission type for an existing user, choose Manage folder access. 7. When you're done setting user and group permissions for the folder, choose Share. Users are not notified that they now have access to the folder. Restricted shared folders Restricted shared folders can only be created with the CreateFolder API operation. The following example creates a restricted shared folder. aws quicksight create-folder \ --aws-account-id AWSACCOUNTID \ --region us-east-1 \ --folder-id example-folder-name \ --folder-type RESTRICTED \ --name "Example Folder" \ After you create a restricted shared folder, assign folder contributor and viewer permissions with a UpdateFolderPermissions API call. The following example updates the permissions of a restricted shared folder to grant contributor permissions to a user. aws quicksight update-folder-permissions \ --aws-account-id AWSACCOUNTID \ --region us-east-1 \ --folder-id example-folder-name \ --grant-permissions Principal=arn:aws:quicksight::us-east- 1::AWSACCOUNTID:user/default/:username,Actions=quicksight:CreateFolder ,quicksight:DescribeFolder, \ Create a shared folder 1330 Amazon QuickSight User Guide quicksight:CreateFolderMembership,quicksight:DeleteFolderMembership,qu icksight:DescribeFolderPermissions \ The permissions that you pass to the user depend on the type of folder role that you want to grant them. Use the following lists to determine which permissions are needed for the user that you want to grant folder access to. Folder owner • quicksight:CreateFolder • quicksight:DescribeFolder • quicksight:UpdateFolder • quicksight:DeleteFolder • quicksight:CreateFolderMembership • quicksight:DeleteFolderMembership • quicksight:DescribeFolderPermissions • quicksight:UpdateFolderPermissions Folder contributor • quicksight:CreateFolder • quicksight:DescribeFolder • quicksight:CreateFolderMembership • quicksight:DeleteFolderMembership • quicksight:DescribeFolderPermissions Folder viewer • quicksight:DescribeFolder After you create a shared folder, you can begin using the folder in QuickSight. You can also use the QuickSight APIs to create special scaled folders that can |
amazon-quicksight-user-372 | amazon-quicksight-user.pdf | 372 | pass to the user depend on the type of folder role that you want to grant them. Use the following lists to determine which permissions are needed for the user that you want to grant folder access to. Folder owner • quicksight:CreateFolder • quicksight:DescribeFolder • quicksight:UpdateFolder • quicksight:DeleteFolder • quicksight:CreateFolderMembership • quicksight:DeleteFolderMembership • quicksight:DescribeFolderPermissions • quicksight:UpdateFolderPermissions Folder contributor • quicksight:CreateFolder • quicksight:DescribeFolder • quicksight:CreateFolderMembership • quicksight:DeleteFolderMembership • quicksight:DescribeFolderPermissions Folder viewer • quicksight:DescribeFolder After you create a shared folder, you can begin using the folder in QuickSight. You can also use the QuickSight APIs to create special scaled folders that can be shared with up to 3000 namespaces. To learn more about creating a scaled folder, see Creating QuickSight scaled folders with the QuickSight APIs. Create a shared folder 1331 Amazon QuickSight User Guide Creating QuickSight scaled folders with the QuickSight APIs You can use the Amazon QuickSight APIs to create special scaled folders that can be shared with up to 3000 namespaces. Each namespace that is added to a folder can contain up to 100 principals. A principal is a user or a group of users. After you create a scaled folder and add the principals that you want, any QuickSight asset can be added to the folder. It can then be shared to every principal in the namespaces that the folder principals are assigned to. This streamlines the process to share QuickSight assets with thousands of users. Scaled folders can only be created with the QuickSight APIs. When you create a scaled folder, you can share the folder with up to 100 principals that are in the same namespace. You can add principals that belong to a different namespace with an UpdateFolderPermissions API call. After the folder is created, you can add and remove assets from the folder with the QuickSight APIs or the QuickSight console. Each Amazon QuickSight account holds up 100 scaled folders. You can add up to 100 assets to a scaled folder. If you want to share a scaled folder with more than 3000 namespaces, contact AWS support. Examples The following examples show how to create a scaled folder with the QuickSight APIs. Prerequisites Before you begin, verify that you have an AWS Identity and Access Management role that grants the API user access to call the QuickSight API operations. The following example shows an IAM policy that you can add to an existing IAM role to create, delete, or modify a scaled folder. With the sample policy, users can add dashboards, analyses, and datasets to a scaled folder. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "quicksight:CreateFolder", "quicksight:CreateFolderMembership", "quicksight:DeleteFolderMembership", "quicksight:DeleteFolder", "quicksight:DescribeFolderPermissions", Creating scaled folders with the QuickSight APIs 1332 Amazon QuickSight User Guide "quicksight:DescribeFolderResolvedPermissions", "quicksight:UpdateFolderPermissions", "quicksight:UpdateDashboardPermissions", "quicksight:UpdateAnalysisPermissions", "quicksight:UpdateDataSetPermissions" ], "Resource": "*" } ] } The following example creates a scaled folder. aws quicksight create-folder \ --aws-account-id "AWSACCOUNTID" \ --region "us-east-1" \ --name "eastcoast-users" \ --sharing-model "NAMESPACE" \ --folder-id "eastcoast-users" After you create a scaled folder, share the folder with a principal in your account. You can only grant or revoke permissions to users and groups that are within the same namespace in each API call. The following example shares a scaled folder with a user in the same account that the folder exists in. aws quicksight update-folder-permissions \ --aws-account-id "AWSACCOUNTID" \ --region "us-east-1" \ --folder-id "eastcoast-users" \ --grant-permissions \ '[ {"Actions": ["quicksight:DescribeFolder", "quicksight:UpdateFolder", "quicksight:DeleteFolder", "quicksight:DescribeFolderPermissions", "quicksight:UpdateFolderPermissions", "quicksight:CreateFolderMembership", "quicksight:DeleteFolderMembership", "quicksight:CreateFolder" ], "Principal":"arn:aws:quicksight:us-east-1:AWSACCOUNTID:user/default/my-user" Creating scaled folders with the QuickSight APIs 1333 Amazon QuickSight } ]' User Guide After you share the folder with a new principal, validate the new folder permissions with a describe-folder-permissions API call. aws quicksight describe-folder-permissions \ --aws-account-id "AWSACCOUNTID" \ --region "us-east-1" \ --folder-id "eastcoast-users" \ --namespace "default" After you validate the new folder permissions, create a subfolder within the scaled folder. The subfolder inherits the permissions of the scaled folder that it's created in. aws quicksight create-folder \ --aws-account-id "AWSACCOUNTID" \ --region "us-east-1" \ --name "new-york-users" \ --sharing-model "NAMESPACE" \ --folder-id "new-york-users" \ --parent-folder-arn "arn:aws:quicksight:us-east-1:AWSACCOUNTID:folder/eastcoast-users" The following example validates the inherited permissions of the new subfolder. aws quicksight describe-folder-resolved-permissions \ --aws-account-id "AWSACCOUNTID" \ --region "us-east-1" \ --folder-id "new-york-users" \ --namespace "default" After you validate the permissions of the subfolder, add the asset that you want to share to the folder. After you add the asset to the subfolder, the asset is shared with every principal that the subfolder is shared with. The following example adds a dashboard to a subfolder. aws quicksight create-folder-membership \ --aws-account-id "AWSACCOUNTID" \ --folder-id "new-york-users" \ --member-id "my-dashboard" \ --member-type "DASHBOARD" \ Creating scaled folders with the QuickSight APIs 1334 Amazon QuickSight --region "us-east-1" User Guide Creating scaled folders with the QuickSight APIs 1335 Amazon QuickSight User Guide Exploring interactive dashboards in Amazon QuickSight Intended audience: Amazon QuickSight Dashboard subscribers or viewership In Amazon QuickSight, a |
amazon-quicksight-user-373 | amazon-quicksight-user.pdf | 373 | the asset that you want to share to the folder. After you add the asset to the subfolder, the asset is shared with every principal that the subfolder is shared with. The following example adds a dashboard to a subfolder. aws quicksight create-folder-membership \ --aws-account-id "AWSACCOUNTID" \ --folder-id "new-york-users" \ --member-id "my-dashboard" \ --member-type "DASHBOARD" \ Creating scaled folders with the QuickSight APIs 1334 Amazon QuickSight --region "us-east-1" User Guide Creating scaled folders with the QuickSight APIs 1335 Amazon QuickSight User Guide Exploring interactive dashboards in Amazon QuickSight Intended audience: Amazon QuickSight Dashboard subscribers or viewership In Amazon QuickSight, a data dashboard is a collection of charts, graphs, and insights. It's like a newspaper that's all about the data that you're interested in, except it has digital pages. Instead of reading it, you interact with it. Dashboards come in a wide variety of designs, depending on what you do and the analytics that you need to do it well. Using QuickSight, you can interact with your data on a webpage or your mobile device. If you also subscribe by mail, you can see a static preview of it. The story told by your data reflects the expertise of the analysts and data scientists who built the dashboards. They refine the data, add calculations, find angles on the story, and decide how to present it. The publisher designs the dashboard and fills it with interactive data visualizations and controls that adjust your view. Publishers can customize the level of interactivity that you have, including filter and search options. You can interact with the active items on the screen to filter, sort, drill down, or jump to another tool. When you view a dashboard, you're seeing the most recently received data. As you interact with the items on the screen, any changes you make change your view of the dashboard, and no one else's. Thus, your device's privacy is assured, although the publisher can tell what you looked at. After you close the dashboard, your explorations aren't preserved and neither is the data. As always, while you're an Amazon QuickSight reader, your monthly subscription is provided by the publishers of the dashboards at no additional cost to you. If you're also a dashboard publisher—we call them authors, because they write reports—you can also save a copy of the dashboard for further analysis. If you find a new feature of the data that you want to publish, work with the original authors to update it. That way, everyone can see the same version of the story. However, you can also use your copy to learn how their design works or to inspire your work on something entirely new. Then, when you're finished, you can publish your analysis as a new dashboard. To learn to set up dashboards, see Sharing and subscribing to data in Amazon QuickSight. Topics 1336 Amazon QuickSight User Guide • Interacting with Amazon QuickSight dashboards • Interacting with paginated reports in Amazon QuickSight • Subscribing to Amazon QuickSight dashboard emails and alerts • Creating a reader generated report in Amazon QuickSight • Bookmarking views of a Amazon QuickSight dashboard Interacting with Amazon QuickSight dashboards To access a dashboard that you've been invited to share, follow the instructions in the invitation email. You can also access a dashboard if it's embedded into an application or website that you already have access to. When you open the dashboard, the screen should look something like the following example. To fit the dashboard to your screen, open the View menu at upper right and select Fit to window. Depending on how the dashboard is configured, you can find all or some of the following elements: • The menu bar – This displays the name of the dashboard. Also, the menu bar shows what you can do with the dashboard, including Undo, Redo, and Reset, on the left. As you interact with the dashboard, you can use these as tools to help you explore, knowing that you can change your view without losing anything. On the right, you can find options to Print the dashboard, work Interacting with dashboards 1337 Amazon QuickSight User Guide with Data, choose a different AWS Region, and open your User Profile. The user profile menu has options so you can choose the language that Amazon QuickSight displays. It also has links to the Amazon QuickSight Community and the online documentation (Help). • The dashboard sheets – If your dashboard has multiple sheets, these display as tabs across the top of the dashboard. • The Filter menu – This option displays to the left of the dashboard, if the dashboard publisher allows filtering. • The Controls palette – If your dashboard includes controls, you can use them to choose the options (parameters) that you want to apply to your dashboard. Sometimes |
amazon-quicksight-user-374 | amazon-quicksight-user.pdf | 374 | Profile. The user profile menu has options so you can choose the language that Amazon QuickSight displays. It also has links to the Amazon QuickSight Community and the online documentation (Help). • The dashboard sheets – If your dashboard has multiple sheets, these display as tabs across the top of the dashboard. • The Filter menu – This option displays to the left of the dashboard, if the dashboard publisher allows filtering. • The Controls palette – If your dashboard includes controls, you can use them to choose the options (parameters) that you want to apply to your dashboard. Sometimes a control value is selected for you, and sometimes it's set to ALL. • The dashboard title – If your dashboard has a title, it is usually a larger heading. It might have some status information or instructions below it. • The dashboard widgets – The items on the screen can include charts, graphs, insights, narratives, or images. To see them all, you might need to scroll vertically or horizontally. The following screenshot shows more of the previous example dashboard: Using filters on Amazon QuickSight dashboard data You can use filters to refine the data displayed in a visual. Filters are applied to the data before any aggregate functions. If you have multiple filters, all top-level filters apply together using AND. If the filters are grouped inside a top-level filter, the filters in the group apply using OR. Using filters 1338 Amazon QuickSight User Guide Amazon QuickSight applies all of the enabled filters to the field. For example, suppose that there is one filter of state = WA and another filter of sales >= 500. In this case, the dataset contains only records that meet both of those criteria. If you disable one of these, only one filter applies. Take care that multiple filters applied to the same field aren't mutually exclusive. Viewing filters To see the existing filters, choose Filter on the element settings menu, then choose to view filters. The filters display in the Applied filters panel in order of creation, with the oldest filter on top. Understanding filter icons in an Amazon QuickSight dashboard Filters in the Applied filters panel display icons to indicate how they are scoped and whether they are enabled. A filter that isn't enabled is grayed out, and you can't select its check box. One of several scope icons displays to the right of the filter name to indicate the scope set on that filter. The scope icon resembled four boxes in a square. If all boxes are filled, the filter applies to all visuals on the analysis sheet. If only one box is filled, the filter applies to the selected visual only. If some boxes are filled, the filter applies to some of the visuals on the sheet, including the one currently selected. The scope icons match the ones that display on the filter menu when you are choosing the scope for the filter. Using filters 1339 Amazon QuickSight User Guide Viewing filter details in an Amazon QuickSight dashboard To see filter details, choose Filter at left. The filter view retains your last selection. So when you open Filter, you see either the Applied filters or the Edit filter view. In the Applied filters view, you can choose any filter to view its details. The filters in this list can change depending on the scope of the filter, and which visual you currently have selected. You can close the Edit filter view by choosing the selector on the right. Doing this resets the Filter view. Filtering data during your session in Amazon QuickSight While your dashboard session is active, you can filter data in three ways: 1. If your dashboard has controls at the top of the screen, you can use them to filter data by choosing from a preset list of values. 2. You can use the filter icon on each widget's settings menu. Filtering dashboard data 1340 Amazon QuickSight User Guide 3. You can create your own filters by using the filter panel on the left side of the page. The filter icon looks like the following. To create a filter, choose the Filter icon at left. The first step is to choose which dashboard element you want to filter. Click on the item you choose, so that a highlight appears around the selected item. Also, if any filters are already there, they display in a list. If there aren't any filters, you can add one by using the plus sign (+) near Filters. Filtering dashboard data 1341 Amazon QuickSight User Guide Filtering options vary depending on the data type of the field you want to filter, and on the options you choose inside the filter. The following screenshot shows some of the options available for a time-range date filter. |
amazon-quicksight-user-375 | amazon-quicksight-user.pdf | 375 | is to choose which dashboard element you want to filter. Click on the item you choose, so that a highlight appears around the selected item. Also, if any filters are already there, they display in a list. If there aren't any filters, you can add one by using the plus sign (+) near Filters. Filtering dashboard data 1341 Amazon QuickSight User Guide Filtering options vary depending on the data type of the field you want to filter, and on the options you choose inside the filter. The following screenshot shows some of the options available for a time-range date filter. Filtering dashboard data 1342 Amazon QuickSight User Guide For each filter, you can choose whether to apply it to one, some, or all dashboard elements. You can also enable or disable filters by using the check box next to the name of the filter. To delete a filter, edit it and scroll to the bottom to see the options. Remember that your filters aren't saved from one session to the next. Filtering dashboard data 1343 Amazon QuickSight User Guide For more detailed information on creating filters, see Filtering data in Amazon QuickSight. Using the elements on the Amazon QuickSight dashboard Each widget has a settings menu that appears when you select that widget. This menu provides options to zoom in or out, filter the data, export the data, and more. The options vary depending on what type of widget the element is. When you choose a data point, several actions are available. You can click or tap on a data point, for example on a bar in a bar chart, on a point where the line bends on a line chart, and so on. The available options vary based on what type of item it is. The following screenshot shows a list of actions available on most chart types. Using dashboard elements 1344 Amazon QuickSight User Guide These actions are as follows: • Focus on or exclude. You can focus on or exclude specific data in a field, for example regions, metrics, or dates. • Drill up or drill down. If your dashboard contains data on which you can drill down or up, you can drill up to a higher level or drill down to explore deeper details. • Custom URL actions. If your dashboard contains custom actions, you can activate them by choosing a data point or by right-clicking it. For example, you might be able to email someone directly from the dashboard. Or you might open another sheet, website, or application, and send it the value you chose from this one. • Change chart colors or specific field colors. You can change all the chart colors to a specific color. Or you can choose a specific field value to change its color of the element it's part of. Using dashboard elements 1345 Amazon QuickSight User Guide Sorting dashboard data in Amazon QuickSight You can sort data in three ways: 1. You can hover over the label for the field you want to sort by, and choose the sort icon. 2. You can choose the filter icon at the upper right of one of the dashboard elements. Sorting data 1346 Amazon QuickSight User Guide 3. You can click or tap on the field and choose Sort from the context menu. Sorting for pivot tables is different; you specify the sort order by using the column sort icon on the pivot table. Sorting data 1347 Amazon QuickSight User Guide Exporting and printing interactive Amazon QuickSight dashboard reports You can export or print a PDF version of an interactive dashboard. You can also export some visuals in a dashboard to a CSV. Exporting an entire dashboard to a CSV is not currently supported for interactive dashboards. Exporting data from a dashboard to a PDF To export an interactive dashboard report as a PDF 1. From the dashboard report that you want to export, choose the Export icon at the top right. 2. Choose Generate PDF. 3. When you choose Generate PDF, QuickSight will begin preparing the dashboard report for download. Choose View downloads in the blue pop-up to open the Downloads pane on the right. 4. There are two ways to download your report: • Choose DOWNLOAD NOW in the green pop-up. Exporting and printing dashboard reports 1348 Amazon QuickSight User Guide • Choose the Export icon at the top right, and then choose View downloads to view and download every report that is ready to download. To print an interactive dashboard report 1. From the report that you want to print, choose the Export icon at the top right, and then choose Print. 2. In the Prepare for printing pop-up that appears, choose the paper size and orientation that you want. You can optionally choose to include the background color |
amazon-quicksight-user-376 | amazon-quicksight-user.pdf | 376 | download your report: • Choose DOWNLOAD NOW in the green pop-up. Exporting and printing dashboard reports 1348 Amazon QuickSight User Guide • Choose the Export icon at the top right, and then choose View downloads to view and download every report that is ready to download. To print an interactive dashboard report 1. From the report that you want to print, choose the Export icon at the top right, and then choose Print. 2. In the Prepare for printing pop-up that appears, choose the paper size and orientation that you want. You can optionally choose to include the background color by selecting Print background color. 3. Choose GO TO PREVIEW. Exporting and printing dashboard reports 1349 Amazon QuickSight User Guide 4. In the preview window that appears, choose PRINT. Exporting data from a dashboard to a CSV Note Export files can directly return information from the dataset import. This makes the files vulnerable to CSV injection if the imported data contains formulas or commands. For this reason, export files can prompt security warnings. To avoid malicious activity, turn off links and macros when reading exported files. To export data from an analysis or dashboard to a comma-separated value (CSV) file, use the settings menu at the upper right of a widget. Exports only include data that currently displays in the item that you choose. Exporting and printing dashboard reports 1350 Amazon QuickSight User Guide In tables and pivot tables, you can export data to a comma-separated value (CSV) file or Microsoft Excel file. You can choose to export only visible fields or all fields. To export only visible fields to a CSV or Excel file, choose the menu at upper-right of the visual. Choose either Export to CSV or Export to Excel, and then choose Export visible fields to CSV or Export visible fields to Excel. To export all fields to a CSV or Excel file, choose the menu at upper-right of the visual. Choose either Export to CSV or Export to Excel, and then choose Export all fields to CSV or Export all fields to Excel. Generate an executive summary of an Amazon QuickSight dashboard Dashboard readers can generate executive summaries that provide a summary of all insights that QuickSight has generated for the dashboard. Executive summaries make it easier for readers to find key insights and information about a dashboard at a glance. When readers are viewing a dashboard that uses executive summaries, the Executive summary option is available in the Build dropdown list that is located in the rop right of the Dashboard's page. Use the procedure below to genrate an exeutive summary. If a dashboard doesnt use executive summaries, the Executive summary option does not appear in the Build dropdown list. Generate an executive summary 1351 Amazon QuickSight User Guide To generate an executive summary 1. In the dashboard that you want to work in, choose Build, and then choose Executive summary. 2. Choose Summarize. The executive summary is generated and the appears on the left. Executive summaries use the data of the current dashboard sheet and visual settings. If the dashboard or visual settings are updated, a warning appears at the top of an executive summary. To refresh the executive summary of an updated dashboard, generate a new executive summary. After an executive summary is generated, QuickSight readers can copy the summary to their clipboard in order to share with others, or include in a story. For more information about QuickSight stories, see Working with data stories in Amazon QuickSight. Interacting with paginated reports in Amazon QuickSight To access a paginated report that you've been invited to share, follow the instructions in the invitation email. You can also access a paginated report if it's embedded into an application or website that you already have access to. When you open the report, the screen should look something like the following example. Interacting with paginated reports 1352 Amazon QuickSight User Guide To fit the paginated report to your screen, open the View menu at upper right and select Fit to window. You can also zoom in and out using the plus (+) and minus (-) icons on the top left corner of the report. Exporting and printing Amazon QuickSight reports Paginated reports are designed to be viewed from a specific point of time. These reports, or snapshots, can be printed or downloaded as a PDF or CSV. To export a paginated report report as a PDF 1. From the paginated report that you want to export, choose the Export icon at the top right. 2. Choose Generate PDF. Exporting and printing 1353 Amazon QuickSight User Guide 3. When you choose Generate PDF, QuickSight will begin preparing the paginated report for download. When the report is ready, a green pop up will appear that says Your PDF is |
amazon-quicksight-user-377 | amazon-quicksight-user.pdf | 377 | Amazon QuickSight reports Paginated reports are designed to be viewed from a specific point of time. These reports, or snapshots, can be printed or downloaded as a PDF or CSV. To export a paginated report report as a PDF 1. From the paginated report that you want to export, choose the Export icon at the top right. 2. Choose Generate PDF. Exporting and printing 1353 Amazon QuickSight User Guide 3. When you choose Generate PDF, QuickSight will begin preparing the paginated report for download. When the report is ready, a green pop up will appear that says Your PDF is ready. 4. There are two ways to download your report: • Choose DOWNLOAD NOW in the green pop-up. • Choose the Export icon at the top right, and then choose View downloads to view and download every report that is ready to download. Exporting and printing 1354 Amazon QuickSight User Guide To export a paginated report as a CSV 1. From the report that you want to export, choose the Scheduling icon at the top right, and then choose Recent snapshots. 2. 3. In the Recent snapshots menu that appears on the right, snapshots are sorted from most recently generated to the oldest. Snapshots are stored for up to 1 year. Find the report that you want to download and choose the download icon to the right of the report. In the report pop-up that appears, choose the download icon next to the version of the report that you want to doenload. You can choose to download the report as a CSV, or you can download the report as a PDF. To print a paginated report 1. From the report that you want to pring, choose the Export icon at the top right, and then choose Print. Exporting and printing 1355 Amazon QuickSight User Guide 2. When you choose Print, your browser's printer pop-up appears. From here, you can print the PDF the same way you would print anything else on your browser. Subscribing to Amazon QuickSight dashboard emails and alerts Using Amazon QuickSight, you can subscribe to updates for certain events, such as dashboard updates and anomaly alerts. Topics • Sign up for dashboard emails • Sign up for anomaly alerts Sign up for dashboard emails You can sign up to get a dashboard in report form, and receive it in an email. You can also configure your report settings. Subscribe to emails and alerts 1356 Amazon QuickSight User Guide To change subscription and report settings for a dashboard 1. Open a dashboard that is shared with you. 2. Choose the Schedules icon at upper right, and then choose Schedules in the dropdown. 3. The Schedules pane appears on the right. This pane shows all of the different scheduled reports that you are or can be subscribed to. Navigate to the report that you want and toggle the switch to subscribe or unsubscribe from the report. Sign up for anomaly alerts On a dashboard that has a narrative insight that's configured for anomaly detection, you can sign up to get alerts for anomalies and contribution analysis. You receive anomaly alerts when anomalies are updated. The alerts email displays the total number of anomalies, and provides detail on the top five, according to your personal alert configuration. You receive key driver contribution analysis when it's updated, provided that contribution analysis is configured to run with anomaly detection. To set up anomaly alerts 1. Open a dashboard that is shared with you. 2. You can configure alerts from one of two screens. Choose one of the following, then go to the next step: Sign up for anomaly alerts 1357 Amazon QuickSight User Guide • In the dashboard, locate the anomaly widget that you're interested in. Select it so that it has a highlighted box around it. • If you're in the dashboard and have the Explore Anomalies page open, you can configure the alert without returning to the dashboard view. 3. At upper right, choose Configure alert. The Alert configuration screen appears. 4. For Severity, choose the lowest level of significance that you want to see. For Direction, choose to get alerts about anomalies that are Higher than expected or Lower than expected. You can also choose [ALL] to receive alerts about all anomalies. 5. Choose OK to confirm your choices. 6. To stop receiving to an anomaly alert, locate the anomaly widget in the dashboard and use the bell icon to unsubscribe. You can also use the To manage this alert link at the bottom of an alert email. Creating a reader generated report in Amazon QuickSight If a QuickSight author has set up a prompted report for a QuickSight paginated report, QuickSight dashboard viewers can use the prompt to schedule their own reports for themselves. For more information about |
amazon-quicksight-user-378 | amazon-quicksight-user.pdf | 378 | than expected. You can also choose [ALL] to receive alerts about all anomalies. 5. Choose OK to confirm your choices. 6. To stop receiving to an anomaly alert, locate the anomaly widget in the dashboard and use the bell icon to unsubscribe. You can also use the To manage this alert link at the bottom of an alert email. Creating a reader generated report in Amazon QuickSight If a QuickSight author has set up a prompted report for a QuickSight paginated report, QuickSight dashboard viewers can use the prompt to schedule their own reports for themselves. For more information about prompts for paginated reports, see Setting up prompts for paginated reports. Use the following sections to learn how to create and modify a reader generated report. Topics • Creating a reader generated report • Loading a saved view of a reader generated report • Updating the view of a scheduled reader generated report • Updating a reader generated report schedule Creating a reader generated report Use the following procedure to create a reader generated report. To create a reader generated report 1. Open the QuickSight console. Reader generated reports 1358 Amazon QuickSight User Guide 2. Open the dashboard that you want to create a report for. 3. Choose the Scheduling at the top of the dashboard page. 4. 5. 6. 7. 8. The scheduling pane opens. To add a new report schedule, choose Add. If you do not see the Add button, the dashboard does not contain a paginated sheet, or your QuickSight account does not have the Paginated reports add on. For more information about the paginater reports add on, see Getting started . For Schedule name, enter a name for the new schedule. The schedule name can be up to 100 chatacters long. For Description, choose the view option that you want the report to use. You can choose from the following views: • Custom view – The current view of the dashboard. • Original view – The author published view of the dashboard. For Content, choose the paginated report sheet that you want to generate a PDF report for. For Dates, choose the frequency at which you want to receive the report. Scheduling options that are available for an email report include the following: • Once (Does not repeat) – Sends the report only once at the date and time that you choose. • Daily – Repeats daily at the time that you choose. • Weekly – Repeats each week on the same day or days at the time that you choose. You can also use this option to send reports in weekly intervals, such as every other week or every three weeks. • Monthly – Repeats each month on the same day of the month at the time that you choose. You can also use this option to send reports on specific days of the month, such as the second Wednesday or the last Friday of each month. • Yearly – Repeats each year on the same day of the month or months selected at the time that you choose. You can also use this option to send reports on specific days or sets of days in selected months. For example, you can configure a report to be sent on the first Monday of January, March, and September, or on July 14th, or on the second day of February, April, and June each year. • Custom – Configure your own scheduled report that best fits your business needs. The scheduled report is sent within 1 hour from the specified time. Delays may occur during peak hours. Creating a reader generated report 1359 Amazon QuickSight User Guide 9. In the Email tab, for E-mail subject line, enter a custom subject line, or leave it blank to use the report title. 10. Enter the email addresses of the QuickSight group name of the users or groups that you want to receive the report. 11. For Email header, enter the header that you want the emal report to show. 12. (Optional) For E-mail body text, leave it blank or enter a custom message to display at the beginning of the email. 13. (Optional, recommended) To send a sample of the report before you save changes, choose Send test report. 14. Do one of the following: • (Recommended) Choose Save to confirm your entries. • To immediately send a report, choose Save and run now. The report is sent immediately, even if your schedule's start date is in the future. After you save a report schedule, the schedule appears in the Schedules pane. Reader generated reports are only available to the user that created them and can't be shared. Loading a saved view of a reader generated report QuickSight readers can use the Schedules pane to load a saved view |
amazon-quicksight-user-379 | amazon-quicksight-user.pdf | 379 | the report before you save changes, choose Send test report. 14. Do one of the following: • (Recommended) Choose Save to confirm your entries. • To immediately send a report, choose Save and run now. The report is sent immediately, even if your schedule's start date is in the future. After you save a report schedule, the schedule appears in the Schedules pane. Reader generated reports are only available to the user that created them and can't be shared. Loading a saved view of a reader generated report QuickSight readers can use the Schedules pane to load a saved view of any scheduled paginated report thay have created or received. Use the following procedure to load a saved review of a scheduled report. To load a saved view of a scheduled report 1. Open the QuickSight console. 2. Open the dashboard that contains the report that you want to change. 3. Choose the Scheduling at the top of the dashboard page. 4. The scheduling pane opens. Locate the schedule that you want to change and choose the ellipsis (three dots) icon next to the report to open the schedule menu, and then choose Details. Loading a saved view of a reader generated report 1360 Amazon QuickSight User Guide 5. Choose Load saved view. The saved view of the dashboard that was used for the selected schedule is rendered. All filter values that were active when the dashboard snapshot was taken are applied to the dashboard. When a saved view of a dashboard is loaded, the reader's current view of the dashboard is lost. Updating the view of a scheduled reader generated report After a QuickSight reader has created a report in QuickSight, they can use the Schedules pane to update the dashboard view that is used in the scheduled report. Use the following procedure to update the dashboard view of a scheduled report. To change the dashboard view of a scheduled report 1. Open the QuickSight console. 2. Open the dashboard that contains the report that you want to change. 3. Choose the Scheduling at the top of the dashboard page. 4. The scheduling pane opens. Locate the schedule that you want to change and choose the ellipsis (three dots) icon next to the report to open the schedule menu, and then choose Details. 5. Choose Load saved view. The saved view of the dashboard that was used for the selected schedule is rendered. All filter values that were active when the dashboard snapshot was taken are applied to the dashboard. When a saved view of a dashboard is loaded, the reader's current view of the dashboard is lost. 6. Update the dashboard filters that you want to change. 7. Choose the Scheduling at the top of the dashboard page. 8. The scheduling pane opens. Locate the schedule that you want to change and choose the ellipsis (three dots) icon next to the report to open the schedule menu, and then choose Edit. 9. Navigate to the Dashboard view section, and then choose Custom view. The new filter values that you updated are applied to the dashboard report. 10. Choose Save to update the schedule. Updating the view of a scheduled reader generated report 1361 Amazon QuickSight User Guide Updating a reader generated report schedule After they create a reader generated report, QuickSight readers can use the Schedules pane to make a report schedule active or inactive. Use the following procedure to update active status of a reader generated report schedule. 1. Open the QuickSight console. 2. Open the dashboard that contains the report that you want to change. 3. Choose the Scheduling at the top of the dashboard page to open the Schedulespane. 4. Choose Schedules. 5. Navigate to the My schedules section and find the schedule that you want to update. 6. Use the toggle to set the report schedule to Active or Inactive. 7. When you are finished making changes to the report schedule, close the Schedules pane. Bookmarking views of a Amazon QuickSight dashboard When you load a dashboard as an Amazon QuickSight reader or author, you can create bookmarks to capture specific views of your interests. For example, you can create a bookmark for a dashboard with a specific filter setting that differs from the original published dashboard. By doing this, you can quickly return to the data that's relevant to you. After you create a bookmark, you can set it as the default view of the dashboard that you see when you open the dashboard in a new session. This doesn't affect anyone else's view of the dashboard. You can create up to 200 bookmarks for a dashboard and share them by a URL link with other subscribers of that dashboard. Dashboard bookmarks are available on the Amazon QuickSight console. Dashboard bookmarks for paginated |
amazon-quicksight-user-380 | amazon-quicksight-user.pdf | 380 | dashboard with a specific filter setting that differs from the original published dashboard. By doing this, you can quickly return to the data that's relevant to you. After you create a bookmark, you can set it as the default view of the dashboard that you see when you open the dashboard in a new session. This doesn't affect anyone else's view of the dashboard. You can create up to 200 bookmarks for a dashboard and share them by a URL link with other subscribers of that dashboard. Dashboard bookmarks are available on the Amazon QuickSight console. Dashboard bookmarks for paginated reports are currently not supported. For more information on paginated reports, see Working with paginated reports in Amazon QuickSight. Use the following topics to learn how to use bookmarks. Topics • Creating bookmarks in Amazon QuickSight • Updating bookmarks in Amazon QuickSight Updating a reader generated report schedule 1362 Amazon QuickSight User Guide • Renaming bookmarks in Amazon QuickSight • Making a bookmark the default view in Amazon QuickSight • Sharing bookmarks in Amazon QuickSight • Deleting bookmarks in Amazon QuickSight Creating bookmarks in Amazon QuickSight Use the following procedure to create a bookmark for a dashboard. To create a bookmark for a dashboard 1. Open the published dashboard that you want to view and make changes to the filters or parameters, or select the sheet that you want. For example, you can filter to the Region that interests you, or you can select a specific date range using a sheet control on the dashboard. 2. Choose the bookmark icon at upper right, and then choose Add bookmark. 3. In the Add a bookmark pane that opens, enter a name for the bookmark, and then choose Save. The bookmark is saved, and the dashboard name updates with the bookmark name (at top left). You can return to the original dashboard view that the author published at any time by selecting Original dashboard in the Bookmarks pane at right. Creating bookmarks 1363 Amazon QuickSight User Guide Updating bookmarks in Amazon QuickSight At any time, you can change a bookmark dashboard view and update the bookmark to always reflect those changes. To update a bookmark 1. Open the published dashboard and make needed changes to the filters or parameters, or select a sheet. 2. Choose the bookmark icon at upper right. 3. In the Bookmarks pane that opens, choose the context menu (the three vertical dots) for the bookmark that you want to update, and then choose Update. A message appears, confirming the update. Renaming bookmarks in Amazon QuickSight Use the following procedure to rename a bookmark. Updating bookmarks 1364 Amazon QuickSight To rename a bookmark User Guide 1. In a published dashboard, choose the bookmark icon at upper right to open the Bookmarks pane. 2. In the Bookmarks pane, choose the context menu (the three vertical dots) for the bookmark that you want to rename, and then choose rename. 3. In the Rename bookmark pane, enter a name for the bookmark, and then choose Save. Making a bookmark the default view in Amazon QuickSight By default, when you update a dashboard, QuickSight remembers those changes and keeps them after you close the dashboard. This way, you can pick up where you left off when you open the dashboard again. You can set a bookmark as the default view of a dashboard instead. If you do, anytime that you open the dashboard, the bookmark view is presented to you, regardless of the changes you made during your last session. To set a bookmark as your default view of the dashboard 1. In a published dashboard, choose the bookmark icon at upper right to open the Bookmarks pane. Making a bookmark the default view 1365 Amazon QuickSight User Guide 2. In the Bookmarks pane, choose the context menu (the three dots) for the bookmark that you want to set as your default view, and then choose Set as default. Sharing bookmarks in Amazon QuickSight After you create a bookmark, you can share a URL link for the view with others who have permission to view the dashboard. They can then save that view as their own bookmark. To share a bookmark with another dashboard subscriber 1. In a published dashboard, choose the bookmark icon at upper right to open the Bookmarks pane. 2. In the Bookmarks pane, choose the bookmark that you want to share so that the dashboard updates to that view. Sharing bookmarks 1366 Amazon QuickSight User Guide 3. Choose the share icon at upper right, and then choose Share this view. You can copy the URL link that QuickSight provides and paste it in an email or IM message to share it with others. The recipient of the URL link can then save the view as their own bookmark. For |
amazon-quicksight-user-381 | amazon-quicksight-user.pdf | 381 | dashboard subscriber 1. In a published dashboard, choose the bookmark icon at upper right to open the Bookmarks pane. 2. In the Bookmarks pane, choose the bookmark that you want to share so that the dashboard updates to that view. Sharing bookmarks 1366 Amazon QuickSight User Guide 3. Choose the share icon at upper right, and then choose Share this view. You can copy the URL link that QuickSight provides and paste it in an email or IM message to share it with others. The recipient of the URL link can then save the view as their own bookmark. For more information about sharing views of a dashboard, see Sharing your view of a Amazon QuickSight dashboard. Deleting bookmarks in Amazon QuickSight Use the following procedure to delete a bookmark. To delete a bookmark 1. In a published dashboard, choose the bookmark icon at upper right to open the Bookmarks pane. 2. In the Bookmarks pane, choose the context menu (the three vertical dots) for the bookmark that you want to delete, and then choose Delete. Deleting bookmarks 1367 Amazon QuickSight User Guide 3. In the Delete Bookmark pane that opens, choose Yes, Delete Bookmark. Deleting bookmarks 1368 Amazon QuickSight User Guide Monitoring data in Amazon QuickSight QuickSight sends metrics to Amazon CloudWatch that you can use to observe and respond to the availability and performance of your QuickSight environment in near real time. Currently, you can monitor metrics for QuickSight dashboards, visuals, and dataset ingestions to provide your readers with a consistent, high-performing, and uninterrupted experience on Amazon QuickSight. For more information about using Amazon CloudWatch, see the Amazon CloudWatch User Guide. Use the topics below to find information on how to access CloudWatch and a list of all current supported metrics. Topics • Accessing Amazon QuickSight metrics in Amazon CloudWatch • Metrics • Aggregate metrics • Aggregate SPICE metrics • Dimensions Accessing Amazon QuickSight metrics in Amazon CloudWatch Use the following procedure to access Amazon QuickSight metrics in Amazon CloudWatch. To access QuickSight metrics in CloudWatch 1. 2. Sign in to the AWS account that's associated with your QuickSight account. In the upper-left corner of the AWS Management Console home page, choose Services, and then choose CloudWatch. 3. In the navigation pane, choose Metrics, All metrics, QuickSight. Graph metrics with the Amazon CloudWatch console You can also use the Amazon CloudWatch console to graph metric data generated by Amazon QuickSight. For more information, see Graphing metrics in the Amazon CloudWatch User Guide. Accessing metrics in CloudWatch 1369 Amazon QuickSight User Guide Creating alarms with the Amazon CloudWatch console You can create a Amazon CloudWatch alarm that monitors CloudWatch metrics for your Amazon QuickSight assets. When the metric reaches a threshold that you specify, CloudWatch automatically sends you a notification. For examples, see Creating Amazon CloudWatch alarms in the Amazon CloudWatch User Guide. Metrics The AWS/QuickSight namespace includes the following metrics for monitoring traffic and latency of your Amazon QuickSight dashboards and ingestions. Per-dashboard metrics The following metrics track dashboard view counts and load times. You can find these metrics under the AWS/QuickSight/Dashboard Metrics group in CloudWatch. Unit Count Metric Description Dimension DashboardViewCount DashboardId The number of times that a dashboard has been viewed. This number includes all access patterns such as web, mobile, and embedded. The most useful statistic for this metric is SUM, which represents the total number of dashboard views during a set period of time. DashboardViewLoadT ime The amount of time that it takes DashboardId Millisecond Creating alarms with the CloudWatch console 1370 Amazon QuickSight User Guide Metric Description Dimension Unit for a QuickSight dashboard to load. The measureme nt begins when a user reaches the QuickSight dashboard and ends when all of the dashboard's visuals finish rendering. The most useful statistic for this metric is AVERAGE, which represents the average load time of a QuickSigh t dashboard during a set period of time. Per-dataset ingestion metrics The following metrics track ingestions for specific SPICE datasets. You can find these metrics under the AWS/QuickSight/Ingestion Metrics group in CloudWatch. Metric Description Dimension IngestionErrorCount The number of failed ingestions. DatasetId Unit Count The most useful statistic for this metric is SUM, which represents the total number of failed Per-dataset ingestion metrics 1371 Amazon QuickSight User Guide Metric Description Dimension Unit DatasetId Count DatasetId Second IngestionInvocatio nCount IngestionLatency ingestions during a set period of time. The number of ingestions that have been initiated. This includes scheduled and manual ingestion s that are initiated through the console and the Amazon QuickSight API operations. The most useful statistic for this metric is SUM, which represents the total number of ingestions initiated during a set period of time. The time period between the initiatio n of an ingestion to the completion of the ingestion. The most useful statistic for this metric |
amazon-quicksight-user-382 | amazon-quicksight-user.pdf | 382 | failed Per-dataset ingestion metrics 1371 Amazon QuickSight User Guide Metric Description Dimension Unit DatasetId Count DatasetId Second IngestionInvocatio nCount IngestionLatency ingestions during a set period of time. The number of ingestions that have been initiated. This includes scheduled and manual ingestion s that are initiated through the console and the Amazon QuickSight API operations. The most useful statistic for this metric is SUM, which represents the total number of ingestions initiated during a set period of time. The time period between the initiatio n of an ingestion to the completion of the ingestion. The most useful statistic for this metric is AVERAGE, which represents the average runtime of ingestions during a set period of time. Per-dataset ingestion metrics 1372 Amazon QuickSight User Guide Unit Count Metric Description Dimension IngestionRowCount DatasetId The number of successful row ingestions. The most useful statistic for this metric is SUM, which represents the total amount of data ingested during a set period of time. Per-visual metrics The following metrics track the load times and error counts of individual visuals on a QuickSight dashboard. You can find these metrics under the AWS/QuickSight/Visual Metrics group in CloudWatch. Metric Description Dimension Unit • DashboardId Millisecond • SheetId • VisualId VisualLoadTime The time that it takes for a QuickSight visual to receive the necessary query data for an initial paint of the visual. This includes the round- trip query time from the client, to the QuickSight service, and then back to client. The most useful statistic for this Per-visual metrics 1373 Amazon QuickSight User Guide Metric Description Dimension Unit • DashboardId Count • SheetId • VisualId VisualLoadErrorCount metric is AVERAGE, which represents the average load time of a visual during a set period of time. The number of times that a QuickSigh t visual fails to complete a data query for the initial paint. Any error that occurs during a visual's loading period is included in this metric. The most useful statistic for this metric is SUM, which represents the total number of failed visual loads during a set period. Aggregate metrics The AWS/QuickSight namespace includes the following aggregate metrics for monitoring traffic and latency of your Amazon QuickSight dashboards and ingestions. Aggregate dashboard metrics The following metrics track view counts and load times of all dashboards in a QuickSight account and region. You can find these metrics under the AWS/QuickSight/Aggregate Metrics group in CloudWatch. Aggregate metrics 1374 Amazon QuickSight User Guide Unit Count Millisecond Metric Description DashboardViewCount DashboardViewLoadTime The number of times that all QuickSight dashboards have been viewed across the entire QuickSight account in the region. This number is an aggregate that includes all access patterns such as web, mobile, and embedded. The most useful statistic for this metric is SUM, which represents the total number of QuickSight dashboard views during a set period of time. The amount of time that it takes for all QuickSigh t dashboards to load. The measurement begins when a user navigates to the QuickSight dashboard and ends when all of the dashboard's visuals finish rendering. The most useful statistic for this metric is AVERAGE, which represents the average load time of all QuickSight dashboard during a set period of time. Aggregate dashboard metrics 1375 Amazon QuickSight User Guide Aggregate ingestion metrics The following metrics track all ingestions associated with a QuickSight account and AWS Region. You can find these metrics under the AWS/QuickSight/Aggregate Metrics group in CloudWatch. Metric Description IngestionErrorCount The number of failed ingestions. IngestionInvocationCount IngestionLatency The most useful statistic for this metric is SUM, which represents the total number of failed ingestion during a set period. The number of ingestion s that have been initiated . This includes scheduled and manual ingestions that are initiated through the console and the QuickSight API operations. The most useful statistic for this metric is SUM, which represents the total number of ingestions initiated during a set period of time. The time period between the initiation of an ingestion to the completion of the ingestion. The most useful statistic for this metric is AVERAGE, Unit Count Count Second Aggregate ingestion metrics 1376 Amazon QuickSight User Guide Metric Description Unit which represents the average runtime of ingestions during a set period of time. IngestionRowCount The number of successful row ingestions. Count The most useful statistic for this metric is SUM, which represents the total amount of data ingested during a set period of time. Aggregate visual metrics The following metrics track load times and error counts of all visuals on a dashboard and in a QuickSight account in a Region. You can find these metrics under the AWS/QuickSight/ Aggregate Metrics group for CloudWatch. Metric Description Unit VisualLoadTime Millisecond The time that it takes for all QuickSight visuals to receive the necessary query data for an initial paint of the visuals. This includes the round-trip |
amazon-quicksight-user-383 | amazon-quicksight-user.pdf | 383 | The number of successful row ingestions. Count The most useful statistic for this metric is SUM, which represents the total amount of data ingested during a set period of time. Aggregate visual metrics The following metrics track load times and error counts of all visuals on a dashboard and in a QuickSight account in a Region. You can find these metrics under the AWS/QuickSight/ Aggregate Metrics group for CloudWatch. Metric Description Unit VisualLoadTime Millisecond The time that it takes for all QuickSight visuals to receive the necessary query data for an initial paint of the visuals. This includes the round-trip query time from the client, to the QuickSight service, and then back to the client. The most useful statistic for this metric is AVERAGE, which represents the average load time of all visuals during a set period of time. Aggregate visual metrics 1377 Amazon QuickSight User Guide Unit Count Metric Description VisualLoadErrorCount The number of times that all QuickSight visuals that belong to the QuickSight account fail to complete a data query for an initial paint. The most useful statistic for this metric is SUM, which represents the total number of failed visuals during a set period. Aggregate SPICE metrics The following metrics monitor SPICE consumption information to help you avoid reaching the SPICE consumption limit that can cause your ingestions to fail. Statistics are stored for up to 15 months so that you can access historical information to better understand the consumption trends of your QuickSight account. You can find these metrics in the AWS/QuickSight/Aggregate Metrics group for CloudWatch. Metric Description Unit SPICECapacityLimitInMB SPICECapacityConsumedInMB This value represents the provisioned SPICE capacity at a specific point in time. This metric refreshes when an update of 1 MB or more in consumed or purchased capacity is made. This value represents the consumed SPICE capacity at a specific point in time. This metric refreshes when MegaBytes MegaBytes Aggregate SPICE metrics 1378 Amazon QuickSight User Guide Metric Description Unit an update of 1 MB or more in consumed or purchased capacity is made. Dimensions Following is a list of Amazon QuickSight metric dimensions that appear in Amazon CloudWatch. Dimension DashboardId DatasetId SheetId Dimensions Description The public ID of a QuickSight dashboard. You can use the ListDashb oards API operation to see a list of every dashboard in your Amazon QuickSight account. For more informati on, see ListDashboards in the Amazon QuickSight API Reference. The public ID of a QuickSight dataset. You can use the ListDataS ets API operation to see a list of every dataset in your Amazon QuickSight account. For more information, see ListDataSets in the Amazon QuickSight API Reference. The public ID of a QuickSight sheet. 1379 Amazon QuickSight Dimension VisualId Description The public ID of a QuickSight visual. User Guide Dimensions 1380 Amazon QuickSight User Guide Developing with Amazon QuickSight We provide API operations for Amazon QuickSight, and also software development kits (SDKs) for AWS that enable you to access Amazon QuickSight from your preferred programming language. Currently, you can manage users and groups. In Enterprise edition, you can also embed dashboards in your webpage or app. To monitor the calls made to the Amazon QuickSight API for your account, including calls made by the AWS Management Console, command line tools, and other services, use AWS CloudTrail. For more information, see the AWS CloudTrail User Guide. Required knowledge If you plan to access Amazon QuickSight through an API, you should be familiar with the following: • JSON • Web services • HTTP requests • One or more programming languages, such as JavaScript, Java, Python, or C#. We recommend visiting the AWS Getting Started Resource Center for a tour of what AWS SDKs and toolkits have to offer. Although you can use a terminal and your favorite text editor, you might benefit from the more visual UI experience you get in an integrated development environment (IDE). We provide a list of IDEs in the AWS Getting Started Resource Center in the IDE and IDE Toolkits section. This site provides AWS toolkits that you can download for your preferred IDE. Some IDEs also offer tutorials to help you learn more about programming languages. Available API operations for Amazon QuickSight AWS provides libraries, sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific API operations instead of submitting a request over HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and handling error responses. These libraries help make it easier for you to get started. Required knowledge 1381 Amazon QuickSight User Guide For more information about downloading the AWS SDKs, see AWS SDKs and Tools. The following links are a sample of the language-specific API documentation available. AWS Command Line Interface • AWS CLI QuickSight Command |
amazon-quicksight-user-384 | amazon-quicksight-user.pdf | 384 | sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific API operations instead of submitting a request over HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and handling error responses. These libraries help make it easier for you to get started. Required knowledge 1381 Amazon QuickSight User Guide For more information about downloading the AWS SDKs, see AWS SDKs and Tools. The following links are a sample of the language-specific API documentation available. AWS Command Line Interface • AWS CLI QuickSight Command Reference • AWS CLI User Guide • AWS CLI Command Reference AWS SDK for .NET • Amazon.Quicksight • Amazon.Quicksight.Model AWS SDK for C++ • Aws::QuickSight::QuickSightClient Class Reference AWS SDK for Go • quicksight AWS SDK for Java • com.amazonaws.services.quicksight • com.amazonaws.services.quicksight.model AWS SDK for JavaScript • AWS.QuickSight AWS SDK for PHP • QuickSightClient Available API operations for Amazon QuickSight 1382 User Guide Amazon QuickSight AWS SDK for Python (Boto3) • QuickSight AWS SDK for Ruby • Aws::QuickSight Terminology and concepts This section provides a list of terms for development in Amazon QuickSight. Anonymous QuickSight User: – A temporary Amazon QuickSight user identity that virtually belongs to a namespace, and is usable only with embedding. You can use tag-based rules to implement row-level security for such users. Caller identity: – The identity of the AWS Identity and Access Management user making an API request. The identity of the caller is determined by Amazon QuickSight using the signature attached to the request. Through the use of our provided SDK clients, no manual steps are necessary to generate the signature or attach it to the requests. However, you can do it manually if you want to. Invoker identity: – In addition to the caller identity, but not as a replacement for it, you can assume a caller’s identity through the IAM AssumeRole API when making calls to Amazon QuickSight. AWS approves callers through their invoker’s identity. This is done to avoid having to explicitly add multiple accounts belonging to the same Amazon QuickSight subscription. Namespace: – a logical container that allows you to isolate user pools so that you can organize clients, subsidiaries, teams, and so on. For more information, see Supporting multitenancy with isolated namespaces QuickSight ARN: – Amazon Resource Name (ARN). Amazon QuickSight resources are identified using their name or ARN. For example, these are the ARNs for a group named MyGroup1, a user named User1, and a dashboard with the ID 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89: arn:aws:quicksight:us-east-1:111122223333:group/default/MyGroup1 arn:aws:quicksight:us-east-1:111122223333:user/default/User1 arn:aws:quicksight:us-west-2:111122223333:dashboard/1a1ac2b2-3fc3-4b44-5e5d- c6db6778df89 Terminology and concepts 1383 Amazon QuickSight User Guide The following examples show ARNs for a template named MyTemplate and a dashboard named MyDashboard. 1. Sample ARN for a template arn:aws:quicksight:us-east-1:111122223333:template/MyTemplate 2. Sample ARN for a template, referencing a specific version of the template arn:aws:quicksight:us-east-1:111122223333:template/MyTemplate/version/10 3. Sample ARN for a template alias arn:aws:quicksight:us-east-1:111122223333:template/MyTemplate/alias/STAGING 4. Sample ARN for a dashboard arn:aws:quicksight:us-east-1:111122223333:dashboard/MyDashboard 5. Sample ARN for a dashboard, referencing a specific version of the dashboard arn:aws:quicksight:us-east-1:111122223333:dashboard/MyDashboard/version/10 Depending on the scenario, you might need to provide an entity’s name, ID, or ARN. You can retrieve the ARN if you have the name, using some of the QuickSight API operations. QuickSight dashboard: – An entity which identifies QuickSight reports, created from analyses or templates. QuickSight dashboards are sharable. With the right permissions, scheduled email reports can be created from them. The CreateDashboard and DescribeDashboard API Operations act on the dashboard entity. QuickSight template: – An entity which encapsulates the metadata required to create an analysis or a dashboard. It abstracts the dataset associated with the analysis by replacing it with placeholders. Templates can be used to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template. QuickSight user: – This is an Amazon QuickSight user identity acted upon by your API call. This user isn't identical to the caller identity but might be the one that maps to the user within Amazon QuickSight. Terminology and concepts 1384 Amazon QuickSight User Guide Using the Amazon QuickSight Developer portal The QuickSight dev portal helps you learn by example how to use the QuickSight API in your web site or application. In this initial offering, the dev portal focuses on API operations for embedded analytics. The dev portal provides easy-to-use code samples to get you started. You can choose from the following three different use cases: • Displaying embedded dashboards to everyone (non-authenticated users) • Personalizing dashboards for your users • Embedding dashboard authoring The portal itself displays dashboards by using embedding for everyone. QuickSight Dev portal 1385 Amazon QuickSight User Guide To get started with the dev portal 1. Open QuickSight dev portal and choose Try it on the use case you want to view. 2. To view |
amazon-quicksight-user-385 | amazon-quicksight-user.pdf | 385 | or application. In this initial offering, the dev portal focuses on API operations for embedded analytics. The dev portal provides easy-to-use code samples to get you started. You can choose from the following three different use cases: • Displaying embedded dashboards to everyone (non-authenticated users) • Personalizing dashboards for your users • Embedding dashboard authoring The portal itself displays dashboards by using embedding for everyone. QuickSight Dev portal 1385 Amazon QuickSight User Guide To get started with the dev portal 1. Open QuickSight dev portal and choose Try it on the use case you want to view. 2. To view code examples, choose How to embed it in the menu bar. Then choose each of the folloinwing from the navigation pane at left: • Configure permissions • Get embedding URL (code samples in Java, JavaScript, and Python) • Embed URL in your application To download all of the code in a zip file, choose Download all code. To customize the dashboard, choose How to customize it. This screen is interactive, so you can choose any item in the navigation pane to view the changes live. 3. 4. 5. You can also view and download the html code at bottom left. 6. To return to the start page, click on the QuickSight icon, top left. Developing applications with the Amazon QuickSight API You can manage most aspects of your deployment by using the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs. For more information on the API operations, see Amazon QuickSight API Reference. Before you can call the Amazon QuickSight API operations, you need the quicksight:operation-name permission in a policy attached to your IAM identity. For example, to call list-users, you need the permission quicksight:ListUsers. The same pattern applies to all operations. If you're not sure what the necessary permission is, you can attempt to make a call. The client then tells you what the missing permission is. You can use asterisk (*) in the Resource field of your permission policy instead of specifying explicit resources. However, we recommended that you restrict each permission as much as possible. You can restrict user access by specifying or excluding resources in the policy, using their Amazon QuickSight Amazon Resource Name (ARN) identifier. For more information, see the following: • IAM policy examples for Amazon QuickSight Developing with the QuickSight APIs 1386 Amazon QuickSight User Guide • Actions, Resources, and Condition Keys • IAM JSON Policy Elements To retrieve the ARN of a user or a group, use the Describe operation on the relevant resource. You can also add conditions in IAM to further restrict access to an API in some scenarios. For instance, when adding User1 to Group1, the main resource is Group1, so you can allow or deny access to certain groups, but you can also add a condition by using the IAM Amazon QuickSight key quicksight:UserName to allow or prevent certain users from being added to that group. Following is an example policy. It means that the caller with this policy attached, is able to invoke the CreateGroupMembership operation on any group, provided that the user name they are adding to the group is not user1. { "Effect": "Allow", "Action": "quicksight:CreateGroupMembership", "Resource": "arn:aws:quicksight:us-east-1:aws-account-id:group/default/*", "Condition": { "StringNotEquals": { "quicksight:UserName": "user1" } } } AWS CLI The following procedure explains how to interact with Amazon QuickSight API operations through the AWS CLI. The following instructions have been tested in Bash but should be identical or similar in other command-line environments. 1. Install AWS SDK in your environment. Instructions on how to do that are located here: AWS Command line Interface. 2. Set up your AWS CLI identity and region using the following command and follow-up instructions. Use the credentials for an IAM identity or role that has the proper permissions. aws configure 3. Look at the Amazon QuickSight SDK help by issuing the following command: Developing with the QuickSight APIs 1387 Amazon QuickSight User Guide aws quicksight help 4. To get detailed instructions on how to use an API, enter its name followed by help, like so: aws quicksight list-users help 5. Now you can call an Amazon QuickSight API operation. This example returns a list of Amazon QuickSight users in your account. aws quicksight list-users --aws-account-id aws-account-id --namespace default -- region us-east-1 Java SDK Use the following procedure to set up a Java app that interacts with Amazon QuickSight. 1. 2. To get started, create a Java project in your IDE. Import the Amazon QuickSight SDK into your new project, for example: AWSQuickSightJavaClient-1.11.x.jar 3. Once your IDE indexes the Amazon QuickSight SDK, you should be able to add an import line as follows: import com.amazonaws.services.quicksight.AmazonQuickSight; If you IDE doesn't recognize this as valid, verify that you imported |
amazon-quicksight-user-386 | amazon-quicksight-user.pdf | 386 | QuickSight API operation. This example returns a list of Amazon QuickSight users in your account. aws quicksight list-users --aws-account-id aws-account-id --namespace default -- region us-east-1 Java SDK Use the following procedure to set up a Java app that interacts with Amazon QuickSight. 1. 2. To get started, create a Java project in your IDE. Import the Amazon QuickSight SDK into your new project, for example: AWSQuickSightJavaClient-1.11.x.jar 3. Once your IDE indexes the Amazon QuickSight SDK, you should be able to add an import line as follows: import com.amazonaws.services.quicksight.AmazonQuickSight; If you IDE doesn't recognize this as valid, verify that you imported the SDK. 4. Like other AWS SDKs, Amazon QuickSight SDK requires external dependencies to perform many of its functions. You need to download and import those into the same project. The following dependencies are required: • aws-java-sdk-1.11.402.jar (AWS Java SDK and credentials setup) — See Set up the AWS SDK for Java • commons-logging-1.2.jar — See https://commons.apache.org/proper/commons- logging/download_logging.cgi • jackson-annotations-2.9.6.jar, jackson-core-2.9.6.jar, and jackson- databind-2.9.6.jar — See http://repo1.maven.org/maven2/com/fasterxml/ jackson/core/ Developing with the QuickSight APIs 1388 Amazon QuickSight User Guide • httpclient-4.5.6.jar, httpcore-4.4.10.jar — See https://hc.apache.org/ downloads.cgi • joda-time-2.1.jar — See https://mvnrepository.com/artifact/joda-time/joda- time/2.1 5. Now, you are ready to create an Amazon QuickSight client. You can use a default public endpoint that the client can communicate with or you can reference the endpoint explicitly. There are multiple ways to provide your AWS credentials. In the following example, we provide a direct, simple approach. The following client method is used to make all the API calls that follow: private static AmazonQuickSight getClient() { final AWSCredentialsProvider credsProvider = new AWSCredentialsProvider() { @Override public AWSCredentials getCredentials() { // provide actual IAM access key and secret key here return new BasicAWSCredentials("access-key", "secret-key"); } @Override public void refresh() {} }; return AmazonQuickSightClientBuilder .standard() .withRegion(Regions.US_EAST_1.getName()) .withCredentials(credsProvider) .build(); } 6. Now, we can use the above client to list all the users in our Amazon QuickSight account. Note You have to provide the AWS account ID that you used to subscribe to Amazon QuickSight. This must match the AWS account ID of the caller’s identity. Cross- account calls aren't supported at this time. Furthermore, the required parameter namespace should always be set to default. Developing with the QuickSight APIs 1389 Amazon QuickSight User Guide getClient().listUsers(new ListUsersRequest() .withAwsAccountId("relevant_AWS_account_ID") .withNamespace("default")) .getUserList().forEach(user -> { System.out.println(user.getArn()); }); 7. To see a list of all possible API operations and the request objects they use, you can CTRL- click on the client object in your IDE in order to view the Amazon QuickSight interface. Alternatively, find it within the com.amazonaws.services.quicksight package in the Amazon QuickSight JavaClient JAR file. JavaScript (Node.js) SDK Use the following procedure to interact with Amazon QuickSight using Node.js. 1. Set up your node environment using the following commands: • npm install aws-sdk • npm install aws4 • npm install request • npm install url 2. For information on configuring the Node.js with AWS SDK and setting your credentials, see--> the AWS SDK for JavaScript Developer Guide for SDK v2. 3. Use the following code sample to test your setup. HTTPS is required. The sample displays a full listing of Amazon QuickSight operations along with their URL request parameters, followed by a list of Amazon QuickSight users in your account. const AWS = require('aws-sdk'); const https = require('https'); var quicksight = new AWS.Service({ apiConfig: require('./quicksight-2018-04-01.min.json'), region: 'us-east-1', }); console.log(quicksight.config.apiConfig.operations); Developing with the QuickSight APIs 1390 Amazon QuickSight User Guide quicksight.listUsers({ // Enter your actual AWS account ID 'AwsAccountId': 'relevant_AWS_account_ID', 'Namespace': 'default', }, function(err, data) { console.log('---'); console.log('Errors: '); console.log(err); console.log('---'); console.log('Response: '); console.log(data); }); Python3 SDK Use the following procedure to create a custom built botocore package to interact with Amazon QuickSight. 1. Create a credentials file in the AWS directory for your environment. In a Linux/Mac-based environment, that file is called ~/.aws/credentials and looks like this: [default] aws_access_key_id = Your_IAM_access_key aws_secret_access_key = Your_IAM_secret_key 2. Unzip the folder botocore-1.12.10. Change directory into botocore-1.12.10 and enter the Python3 interpreter environment. 3. Responses come back as a dictionary object. They each have a ResponseMetadata entry that contains request IDs and response status. Other entries are based on what type of operation you run. 4. The following example is a sample app that first creates, deletes, and lists groups. Then, it lists users in a Quicksight account: import botocore.session default_namespace = 'default' account_id = 'relevant_AWS_Account' session = botocore.session.get_session() client = session.create_client("quicksight", region_name='us-east-1') Developing with the QuickSight APIs 1391 Amazon QuickSight User Guide print('Creating three groups: ') client.create_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup1') client.create_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup2') client.create_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup3') print('Retrieving the groups and listing them: ') response = client.list_groups(AwsAccountId = account_id, Namespace=default_namespace) for group in response['GroupList']: print(group) print('Deleting our groups: ') client.delete_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup1') client.delete_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup2') client.delete_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup3') response = client.list_users(AwsAccountId = account_id, Namespace=default_namespace) for |
amazon-quicksight-user-387 | amazon-quicksight-user.pdf | 387 | deletes, and lists groups. Then, it lists users in a Quicksight account: import botocore.session default_namespace = 'default' account_id = 'relevant_AWS_Account' session = botocore.session.get_session() client = session.create_client("quicksight", region_name='us-east-1') Developing with the QuickSight APIs 1391 Amazon QuickSight User Guide print('Creating three groups: ') client.create_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup1') client.create_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup2') client.create_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup3') print('Retrieving the groups and listing them: ') response = client.list_groups(AwsAccountId = account_id, Namespace=default_namespace) for group in response['GroupList']: print(group) print('Deleting our groups: ') client.delete_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup1') client.delete_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup2') client.delete_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup3') response = client.list_users(AwsAccountId = account_id, Namespace=default_namespace) for user in response['UserList']: print(user) .NET/C# SDK Use the following procedure to interact with Amazon QuickSight using C#.NET. This example is constructed on Microsoft Visual for Mac; the instructions can vary slightly based on your IDE and platform. However, they should be similar. 1. Unzip the nuget.zip file into a folder called nuget. 2. Create a new Console app project in Visual Studio. 3. Under your solution, locate app Dependencies, then open the context (right-click menu and choose Add Packages. 4. In the sources list, choose Configure Sources. Developing with the QuickSight APIs 1392 Amazon QuickSight User Guide 5. Choose Add, and name the source QuickSightSDK. Browse to the nuget folder and choose Add Source. 6. Choose OK. Then, with QuickSightSDK selected, select all three Amazon QuickSight packages: • AWSSDK.QuickSight • AWSSDK.Extensions.NETCore.Setup • AWSSDK.Extensions.CognitoAuthentication 7. Click Add Package. 8. Copy and paste the following sample app into your console app editor. using System; using Amazon.QuickSight.Model; using Amazon.QuickSight; namespace DotNetQuickSightSDKTest { class Program { private static readonly string AccessKey = "insert_your_access_key"; private static readonly string SecretAccessKey = "insert_your_secret_key"; private static readonly string AccountID = "AWS_account_ID"; private static readonly string Namespace = "default"; // leave this as default static void Main(string[] args) { var client = new AmazonQuickSightClient( AccessKey, SecretAccessKey, Amazon.RegionEndpoint.USEast1); var listUsersRequest = new ListUsersRequest { AwsAccountId = AccountID, Namespace = Namespace }; client.ListUsersAsync(listUsersRequest).Result.UserList.ForEach( user => Console.WriteLine(user.Arn) Developing with the QuickSight APIs 1393 Amazon QuickSight ); User Guide var listGroupsRequest = new ListGroupsRequest { AwsAccountId = AccountID, Namespace = Namespace }; client.ListGroupsAsync(listGroupsRequest).Result.GroupList.ForEach( group => Console.WriteLine(group.Arn) ); } } } Amazon QuickSight events integration With Amazon EventBridge, you can respond automatically to events in Amazon QuickSight such as new dashboard creation or updates. These events are delivered to EventBridge in near real time. As a developer, you can write simple rules to indicate which events are of interest, and what actions to take when an event matches a rule. By using events, you can complete use cases such as continuous backup and deployment. Topics • Supported events • Example event payload • Creating rules to send Amazon QuickSight events to Amazon CloudWatch • Creating rules to send Amazon QuickSight events to AWS Lambda Supported events QuickSight currently supports the following events. Events integration 1394 Amazon QuickSight Asset type Dashboard Action Create User Guide Event detail type Event detail QuickSight Dashboard Creation Successful Dashboard Create QuickSight Dashboard Creation Failed { "dashboar dId": "6fdbc328 -ebbd-457f- aa02-9780173afc8 3", "versionN umber": 1 } { "dashboar dId": "6fdbc328 -ebbd-457f- aa02-9780173afc8 3", "versionN umber": 1, "errors": [ { "Type": "PARAMETE R_NOT_FOUND", "Message" : "Missing property abc" }, { "Type": "DATA_SET _NOT_FOUND", "Message" : "Cannot find dataset with id abc" } ] } Supported events 1395 Amazon QuickSight Asset type Dashboard Action Create Dashboard Update Event detail type Event detail User Guide QuickSight Dashboard Permisson s Updated QuickSight Dashboard Update Successful {"dashboardId": "6fdbc328- ebbd-457f- aa02-9780173afc8 3" } { "dashboar dId": "6fdbc328 -ebbd-457f- aa02-9780173afc8 3", "versionN umber": 1 } Supported events 1396 Amazon QuickSight Asset type Dashboard Action Update Event detail type Event detail User Guide QuickSight Dashboard Update Failed { "dashboar dId": "6fdbc328 -ebbd-457f- aa02-9780173afc8 3", "versionN umber": 1, "errors": [ { "Type": "PARAMETE R_NOT_FOUND", "Message" : "Missing property abc" }, { "Type": "DATA_SET _NOT_FOUND", "Message" : "Cannot find dataset with id abc" } ] } {"dashboardId": "6fdbc328- ebbd-457f- aa02-9780173afc8 3"} Dashboard Update QuickSight Dashboard Permisson s Updated Supported events 1397 Amazon QuickSight Asset type Dashboard Action Publish Event detail type Event detail User Guide QuickSight Dashboard Published Version Updated Dashboard Delete QuickSight Dashboard Deleted Analysis Create QuickSight Analysis Creation Successful { "dashboar dId": "6fdbc328 -ebbd-457f- aa02-9780173afc8 3", "versionN umber": 2 } { "dashboar dId": "6fdbc328 -ebbd-457f- aa02-9780173afc8 3" } { "analysis Id": "e5f37119- e24c-4874-901a- af9032b729b5" } Supported events 1398 Amazon QuickSight Asset type Analysis Action Create Event detail type Event detail User Guide QuickSight Analysis Creation Failed { "analysis Id": "e5f37119- e24c-4874-901a- af9032b729b5", "errors": [ { "Type": "PARAMETE R_NOT_FOUND", "Message" : "Missing property abc" }, { "Type": "DATA_SET _NOT_FOUND", "Message" : "Cannot find dataset with id abc" } ] } {"analysisId": "e5f37119- e24c-4874-901a- af9032b729b5" } { "analysis Id": "e5f37119- e24c-4874-901a- af9032b729b5" } Analysis Create QuickSight Analysis Permissons Updated Analysis Delete QuickSight Analysis Deleted Supported events 1399 Amazon QuickSight Asset |
amazon-quicksight-user-388 | amazon-quicksight-user.pdf | 388 | 2 } { "dashboar dId": "6fdbc328 -ebbd-457f- aa02-9780173afc8 3" } { "analysis Id": "e5f37119- e24c-4874-901a- af9032b729b5" } Supported events 1398 Amazon QuickSight Asset type Analysis Action Create Event detail type Event detail User Guide QuickSight Analysis Creation Failed { "analysis Id": "e5f37119- e24c-4874-901a- af9032b729b5", "errors": [ { "Type": "PARAMETE R_NOT_FOUND", "Message" : "Missing property abc" }, { "Type": "DATA_SET _NOT_FOUND", "Message" : "Cannot find dataset with id abc" } ] } {"analysisId": "e5f37119- e24c-4874-901a- af9032b729b5" } { "analysis Id": "e5f37119- e24c-4874-901a- af9032b729b5" } Analysis Create QuickSight Analysis Permissons Updated Analysis Delete QuickSight Analysis Deleted Supported events 1399 Amazon QuickSight Asset type Analysis Action Update Event detail type Event detail User Guide QuickSight Analysis update successful { "analysis Id": "e5f37119- e24c-4874-901a- af9032b729b5" } Supported events 1400 Amazon QuickSight Asset type Analysis Action Update Event detail type Event detail User Guide QuickSight Analysis update failed { "analysis Id": "e5f37119- e24c-4874-901a- af9032b729b5", "errors": [ { "Type": "PARAMETE R_NOT_FOUND", "Message" : "Missing property abc" }, { "Type": "DATA_SET _NOT_FOUND", "Message": "Cannot find dataset with id abc" } ] } Supported events 1401 Amazon QuickSight Asset type Analysis Action Update VPC connection Create Event detail type Event detail User Guide QuickSight Analysis Permissons Updated QuickSight VPC Connection Creation Successful VPC connection Create QuickSight VPC Connection Creation Failed {"analysisId": "e5f37119- e24c-4874-901a- af9032b729b5" } { "vpcConne ctionId": "53d34238 -57e7-488d- b99a-a0037d275a4 e", "availabi lityStatu s": "CREATION _SUCCESSFUL" } { "vpcConne ctionId": "53d34238 -57e7-488d- b99a-a0037d275a4 e", "availabi lityStatu s": "CREATION _FAILED" } Supported events 1402 Amazon QuickSight User Guide Asset type Action Event detail type Event detail VPC connection Update QuickSight VPC Connection Update Successful VPC connection Update QuickSight VPC Connection Update Failed VPC connection Delete QuickSight VPC Connection Deletion Successful { "vpcConne ctionId": "53d34238 -57e7-488d- b99a-a0037d275a4 e", "availabi lityStatu s": "UPDATE_S UCCESSFUL" } { "vpcConne ctionId": "53d34238 -57e7-488d- b99a-a0037d275a4 e", "availabi lityStatus": "UPDATE_FAILED" } { "vpcConne ctionId": "53d34238 -57e7-488d- b99a-a0037d275a4 e", "availabi lityStatus": "DELETED" } Supported events 1403 Amazon QuickSight User Guide Asset type Action Event detail type Event detail VPC connection Delete QuickSight VPC Connection Deletion Failed Folder Create QuickSight Folder Created Folder Create QuickSight Folder Permissions Updated { "vpcConne ctionId": "53d34238 -57e7-488d- b99a-a0037d275a4 e", "availabi lityStatu s": "DELETION _FAILED" } { "folderId ": "77e307e8- b41b-472a-90e8- fe3f471537be", "parentFo lderArn": "arn:aws: quicksight:us- east-1:123456 789012:fo lder/0987 65432134" } {"folderId": "77e307e8- b41b-472a-90e8- fe3f471537be" } Supported events 1404 Amazon QuickSight Asset type Folder Action Update Event detail type Event detail User Guide QuickSight Folder Updated Folder Update QuickSight Folder Permissions Updated Folder Delete QuickSight Folder Deleted Folder Membership update QuickSight Folder Membership Updated { "folderId ": "77e307e8- b41b-472a-90e8- fe3f471537be" } {"folderId": "77e307e8- b41b-472a-90e8- fe3f471537be" } { "folderId ": "77e307e8- b41b-472a-90e8- fe3f471537be" } { "folderId ": "77e307e8- b41b-472a-90e8- fe3f471537be", "membersA dded": ["arn:aws :quicksight:us- east-1:12345 6789012:a nalysis/e 5f37119-e 24c-4874-901a- af9032b729b5"], "membersR emoved": [] } Supported events 1405 Amazon QuickSight Asset type Dataset Action Create Event detail type Event detail User Guide QuickSight Dataset Created Dataset Create QuickSight Dataset Permissions Updated Dataset Update QuickSight Dataset Updated Dataset Update QuickSight Dataset Permissions Updated Dataset Delete QuickSight Dataset Deleted { "datasetI d": "a6553a81- f97e-4ffa-a860- baea63196efa" } {"datasetId": "a6553a81- f97e-4ffa-a860- baea63196efa" } { "datasetI d": "a6553a81- f97e-4ffa-a860- baea63196efa" } {"datasetId": "a6553a81- f97e-4ffa-a860- baea63196efa" } { "datasetI d": "a6553a81- f97e-4ffa-a860- baea63196efa" } Supported events 1406 Amazon QuickSight Asset type DataSource Action Create Event detail type Event detail User Guide QuickSight DataSourc e Creation Successful DataSource Create QuickSight DataSourc e Creation Failed DataSource Create QuickSight DataSourc e Permissions Updated { "datasour ceId": "230caa6e -dc87-406 b-91fb-03 7f29c32824" } { "datasour ceId": "230caa6e -dc87-406 b-91fb-03 7f29c32824", "error": { "message" : "AMAZON_E LASTICSEARCH engine version 7.4 is lower than minimum supported version 7.7", "type": "ENGINE_V ERSION_NO T_SUPPORTED" } } {"datasourceId": "230caa6e -dc87-406 b-91fb-03 7f29c32824" } Supported events 1407 Amazon QuickSight Asset type DataSource Action Update Event detail type Event detail User Guide QuickSight DataSourc e Update Successful DataSource Update QuickSight DataSourc e Update Failed DataSource Update QuickSight DataSourc e Permissions Updated { "datasour ceId": "230caa6e -dc87-406 b-91fb-03 7f29c32824" } { "datasour ceId": "230caa6e -dc87-406 b-91fb-03 7f29c32824", "error": { "message" : "AMAZON_E LASTICSEARCH engine version 7.4 is lower than minimum supported version 7.7", "type": "ENGINE_V ERSION_NO T_SUPPORTED" } } {"datasourceId": "230caa6e -dc87-406 b-91fb-03 7f29c32824" } Supported events 1408 Amazon QuickSight Asset type DataSource Action Delete Event detail type Event detail User Guide QuickSight DataSourc e Deleted Theme Create QuickSight Theme Creation Successful Theme Create QuickSight Theme Creation Failed Theme Create QuickSight Theme Permissions Updated { "datasour ceId": "230caa6e -dc87-406 b-91fb-03 7f29c32824" } { ""themeId ": "6fdbc328 -ebbd-457f- aa02-9780173afc8 3", "versionN umber": 1" } { "themeId" : "6fdbc328 -ebbd-457f- aa02-9780173afc8 3", "versionN umber": 1 } {"themeId": "6fdbc328- ebbd-457f- aa02-9780173afc8 3" } Supported events 1409 Amazon QuickSight Asset type Theme Action Update Event detail type Event detail User Guide QuickSight Theme Update Successful Theme Update QuickSight Theme Update Failed Theme Update QuickSight Theme Permissions Updated |
amazon-quicksight-user-389 | amazon-quicksight-user.pdf | 389 | Action Delete Event detail type Event detail User Guide QuickSight DataSourc e Deleted Theme Create QuickSight Theme Creation Successful Theme Create QuickSight Theme Creation Failed Theme Create QuickSight Theme Permissions Updated { "datasour ceId": "230caa6e -dc87-406 b-91fb-03 7f29c32824" } { ""themeId ": "6fdbc328 -ebbd-457f- aa02-9780173afc8 3", "versionN umber": 1" } { "themeId" : "6fdbc328 -ebbd-457f- aa02-9780173afc8 3", "versionN umber": 1 } {"themeId": "6fdbc328- ebbd-457f- aa02-9780173afc8 3" } Supported events 1409 Amazon QuickSight Asset type Theme Action Update Event detail type Event detail User Guide QuickSight Theme Update Successful Theme Update QuickSight Theme Update Failed Theme Update QuickSight Theme Permissions Updated Theme Delete QuickSight Theme deleted { "themeId" : "6fdbc328 -ebbd-457f- aa02-9780173afc8 3", "versionN umber": 2 } { "themeId" : "6fdbc328 -ebbd-457f- aa02-9780173afc8 3", "versionN umber": 2 } {"themeId": "6fdbc328- ebbd-457f- aa02-9780173afc8 3" } { "themeId" : "6fdbc328 -ebbd-457f- aa02-9780173afc8 3" } Supported events 1410 Amazon QuickSight User Guide Asset type Action Event detail type Event detail Theme Alias Create QuickSight Theme Alias Created Theme Alias Update QuickSight Alias Updated Theme Alias Delete QuickSight Theme Alias Deleted { "themeId" : "6fdbc328 -ebbd-457f- aa02-9780173afc8 3", "aliasName": "MyThemeAlias" "versionN umber": 2 } { "themeId" : "6fdbc328 -ebbd-457f- aa02-9780173afc8 3", "aliasName": "MyThemeAlias" "versionN umber": 4 } { "themeId" : "6fdbc328 -ebbd-457f- aa02-9780173afc8 3", "aliasName": "MyThemeAlias" "versionN umber": 2 } Supported events 1411 Amazon QuickSight Example event payload User Guide All events follow the standard EventBridge object structure. The detail field is a JSON object that contains more information about the event. { "version": "0", "id": "3acb26c8-397c-4c89-a80a-ce672a864c55", "detail-type": "QuickSight Dashboard Creation Successful", "source": "aws.quicksight", "account": "123456789012", "time": "2023-10-30T22:06:31Z", "region": "us-east-1", "resources": ["arn:aws:quicksight:us-east-1:123456789012:dashboard/6fdbc328- ebbd-457f-aa02-9780173afc83"], "detail": { "dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83", "versionNumber": 1 } } Creating rules to send Amazon QuickSight events to Amazon CloudWatch You can write simple rules to indicate which Amazon QuickSight events interest you and which automated actions to take when an event matches a rule. For example, you can configure Amazon QuickSight to send events to Amazon CloudWatch whenever a Amazon QuickSight asset is placed in a folder. For more information, see the Amazon EventBridge user guide. 1. Sign in to the AWS Management Console and open the CloudWatch console at https:// console.aws.amazon.com/cloudwatch/. 2. Under Events in the navigation pane, choose Rules. 3. Choose Create rule. 4. Enter a name and description for the rule. The rule name must be unique within this Region. For example, enter QuickSightAssetChangeRuleCloudWatch. 5. Choose default Event bus. 6. Choose Rule with an event pattern, and then choose Next. 7. For Event source, choose AWS events or EventBridge partner events. Example event payload 1412 Amazon QuickSight User Guide 8. 9. In the Creation method section, choose Custom pattern (JSON editor). In the Event pattern text box, enter the following snippet and choose Next. { "source": ["aws.quicksight"] } Alternatively, you can create the rule that only subscribes to a subset of event types in Amazon QuickSight. For example, the following rule will only triggered when an asset is added to or removed from a folder with id 77e307e8-b41b-472a-90e8-fe3f471537be. { "source": ["aws.quicksight"], "detail-type": ["QuickSight Folder Membership Updated"], "detail": { "folderId": "77e307e8-b41b-472a-90e8-fe3f471537be" } } 10. For Targets, choose AWS service > CloudWatch log group. 11. Choose from an existing log group or create a new one by entering a new log group name. 12. Optionally, you can add another target for this rule. 13. In Configure tags, choose Next. 14. Choose Create rule. For more information, see Creating Amazon EventBridge rule that reacts To events in the Amazon EventBridge user guide. Creating rules to send Amazon QuickSight events to AWS Lambda In this tutorial, you create an AWS Lambda function that logs the asset events in the Amazon QuickSight account. You then create a rule that runs the function whenever there is an asset change. This tutorial assumes that you already signed up for QuickSight. Step 1: Create a Lambda function Create a Lambda function to log the state change events. You specify this function when you create your rule. Creating rules to send events to AWS Lambda 1413 Amazon QuickSight User Guide 1. Sign in to the AWS Management Console and open the AWS Lambda console at https:// console.aws.amazon.com/lambda/. 2. If you're new to Lambda, you see a welcome page. Choose Get Started Now. Otherwise, choose Create function. 3. Choose Author from scratch. 4. On the Create function page, enter a name and description for the Lambda function. For example, name the function QuickSightAssetChangeFn. 5. 6. 7. In Runtime, select Node.js 18.x. For Architecture, choose x86_64. For Execution role, choose either Create a new role with basic Lambda permissions or Use an existing role and choose the role you want. 8. Choose Create function. 9. On the QuickSightAssetChange page, choose index.js. 10. In the index.js pane, delete the existing code. 11. Enter the following code snippet. console.log('Loading function'); exports.handler = async |
amazon-quicksight-user-390 | amazon-quicksight-user.pdf | 390 | Get Started Now. Otherwise, choose Create function. 3. Choose Author from scratch. 4. On the Create function page, enter a name and description for the Lambda function. For example, name the function QuickSightAssetChangeFn. 5. 6. 7. In Runtime, select Node.js 18.x. For Architecture, choose x86_64. For Execution role, choose either Create a new role with basic Lambda permissions or Use an existing role and choose the role you want. 8. Choose Create function. 9. On the QuickSightAssetChange page, choose index.js. 10. In the index.js pane, delete the existing code. 11. Enter the following code snippet. console.log('Loading function'); exports.handler = async (event, context) => { console.log('Received QuickSight event:', JSON.stringify(event)); }; 12. Choose Deploy. Step 2: Create a rule Create a rule to run your Lambda function whenever you create/update/delete a QuickSight asset. 1. Sign in to the AWS Management Console and open the Amazon EventBridge console at https://console.aws.amazon.com/events/. 2. In the navigation pane, choose Rules. 3. Choose Create rule. 4. Enter a name and description for the rule. For example, enter QuickSightAssetChangeRule. 5. Select default Event bus. Creating rules to send events to AWS Lambda 1414 Amazon QuickSight User Guide 6. Choose Rule with an event pattern, and then choose Next. 7. 8. 9. For Event source, choose AWS events or EventBridge partner events. In the Creation method section, choose Custom pattern (JSON editor). In the Event pattern text box, enter the following snippet and choose Next. { "source": ["aws.quicksight"] } Alternatively, you can create the rule that only subscribes to a subset of event types in Amazon QuickSight. For example, the following rule will only triggered when an asset is added to or removed from a folder with id 77e307e8-b41b-472a-90e8-fe3f471537be. { "source": ["aws.quicksight"], "detail-type": ["QuickSight Folder Membership Updated"], "detail": { "folderId": "77e307e8-b41b-472a-90e8-fe3f471537be" } } 10. For Target types, choose AWS service and Lambda function. 11. For Function, choose the Lambda function that you created. Then choose Next. 12. In Configure tags, choose Next. 13. Review the steps in your rule. Then choose Create rule. Step 3: Test the rule To test your rule, create an analysis. After waiting a minute, verify that your Lambda function was invoked. 1. Open the Amazon QuickSight console at https://quicksight.aws.amazon.com/. 2. Create a new analysis. 3. 4. In the navigation pane, choose Rules, choose the name of the rule that you created. In Rule details, choose Monitoring. 5. You will be redirected to the Amazon CloudWatch console. If you are not redirected, choose View the metrics in CloudWatch. Creating rules to send events to AWS Lambda 1415 Amazon QuickSight User Guide 6. In All metrics, choose the name of the rule that you created. The graph indicates that the rule was invokved. 7. In the navigation pane, choose Log groups. 8. Choose the name of the log group for your Lambda function. For example, /aws/lambda/ function-name. 9. Choose the name of the log stream to view the data provided by the function for the instance that you launched. You should see a received event similar to the following: { "version": "0", "id": "3acb26c8-397c-4c89-a80a-ce672a864c55", "detail-type": "QuickSight Analysis Creation Successful", "source": "aws.quicksight", "account": "123456789012", "time": "2023-10-30T22:06:31Z", "region": "us-east-1", "resources": ["arn:aws:quicksight:us-east-1:123456789012:analysis/e5f37119- e24c-4874-901a-af9032b729b5"], "detail": { "analysisId": "e5f37119-e24c-4874-901a-af9032b729b5" } } For an example of QuickSight event in JSON format, see Overview of events for Amazon QuickSight. Embedded analytics for Amazon QuickSight Important Amazon QuickSight has new API operations for embedding analytics: GenerateEmbedUrlForAnonymousUser and GenerateEmbedUrlForRegisteredUser. You can still use the GetDashboardEmbedUrl and GetSessionEmbedUrl API operations to embed dashboards and the QuickSight console, but they don't contain the latest embedding capabilities. For more information about embedding using the old API operations, see Embedding analytics using the GetDashboardEmbedURL and GetSessionEmbedURL API operations. Embedded analytics 1416 Amazon QuickSight User Guide Applies to: Enterprise Edition Intended audience: Amazon QuickSight developers With Amazon QuickSight embedded analytics, you can seamlessly integrate data-driven experiences into your software applications. You can style the embedded components to match your brand. This capability brings the power of QuickSight to your end users, where they can analyze and interact with data without ever leaving the application. Improving the user experience by reducing cognitive complexity gives users a better opportunity for deeper understanding and effectiveness. QuickSight supports embedding for these elements: • QuickSight console (full authoring experience for registered users ) • QuickSight dashboards and visuals (for registered users, anonymous users, public end users) • QuickSight Q search bar (for registered users and anonymous users) With an embedded QuickSight console, you embed the full QuickSight experience. Doing this makes it possible to use QuickSight authoring tools as part of your application, rather than in the context of the AWS Management Console or a standalone website. Users of an embedded QuickSight console need to be registered as QuickSight authors or admins in your AWS account. They also need to be authenticated into the same |
amazon-quicksight-user-391 | amazon-quicksight-user.pdf | 391 | console (full authoring experience for registered users ) • QuickSight dashboards and visuals (for registered users, anonymous users, public end users) • QuickSight Q search bar (for registered users and anonymous users) With an embedded QuickSight console, you embed the full QuickSight experience. Doing this makes it possible to use QuickSight authoring tools as part of your application, rather than in the context of the AWS Management Console or a standalone website. Users of an embedded QuickSight console need to be registered as QuickSight authors or admins in your AWS account. They also need to be authenticated into the same AWS account, using any of the QuickSight- supported authentication methods. With an embedded QuickSight dashboard or visual, readers get the same functionality and interactivity as they do in a published dashboard or visual. To use an embedded dashboard or visual, readers (viewers) can include any of the following: • QuickSight users authenticated in your AWS account by any method supported by QuickSight. • Unauthenticated visitors to a website or application – This option requires session packs with capacity pricing. • Multiple end users viewing a display on monitors or large screens by programmatic access. Embedded analytics 1417 Amazon QuickSight User Guide If your app also resides in AWS, the app doesn't need to reside on the same AWS account as the QuickSight subscription. However, the app needs to be able to assume the AWS Identity and Access Management (IAM) role that you use for the API calls. Before you can embed content, make sure that you're using QuickSight Enterprise edition in the AWS account where you plan to use embedding. QuickSight embedding is available in all supported AWS Regions. Topics • Embedding QuickSight analytics into your applications • Embedding custom QuickSight assets into your application • Embedding QuickSight visuals and dashboards with a 1-click embed code • Embedding with the Amazon QuickSight APIs Embedding QuickSight analytics into your applications Applies to: Enterprise Edition To embed analytics, you can run the Amazon QuickSight embedding API to generate the embed code. Alternatively for dashboards, you can copy an embed code when you share the dashboard in QuickSight. Each option is described below. 1-click embedding for registered users When you share a dashboard with registered users in your account, you can copy an embed code for the dashboard and paste it into your internal application's HTML. Using 1-click enterprise embedding is best for when you want to embed a QuickSight dashboard in an internal application that users need to authenticate in to. When you copy the embed code, you get a static embed code that doesn't change. For more information, see Embedding QuickSight visuals and dashboards for registered users with a 1-click embed code. Embedding analytics into your applications 1418 Amazon QuickSight User Guide Embedding with the QuickSight APIs Embedding with the QuickSight API is best for when you want to embed the QuickSight experience in an internal application that users must authenticate in to, or an external application that anyone can access. When you use the embedding API operations to generate an embed code, you get a one-time code. For more information, see Embedding with the Amazon QuickSight APIs. Embedding custom QuickSight assets into your application You can use Amazon QuickSight embedded analytics to embed custom QuickSight assets into your application that are tailored to meet your business needs. For embedded dashboards and visuals, QuickSight authors can add filters and drill downs that readers can access as they navigate the dashboard or visual. Amazon QuickSight developers can also use the QuickSight SDKs to build tighter integrations between their SaaS applications and their QuickSight embedded assets to add datapoint callback actions to visuals on a dashboard at runtime. For more information about the Amazon QuickSight SDKs, see the amazon-quicksight- embedding-sdk on GitHub or NPM. Following, you can find descriptions of how to use the QuickSight SDKs to customize your QuickSight embedded analytics. Topics • Adding embedded callback actions at runtime in Amazon QuickSight • Filtering data at runtime for QuickSight embedded dashboards and visuals • Customize the look and feel of QuickSight embedded dashboards and visuals • Using the Amazon QuickSight Embedding SDK to enable shareable links to embedded dashboard views Adding embedded callback actions at runtime in Amazon QuickSight Use embedded datapoint callback actions to build tighter integrations between your software as a service (SaaS) application and your Amazon QuickSight embedded dashboards and visuals. Developers can register datapoints to be called back with the QuickSight embedding SDK. When you register a callback action for a visual, readers can select a datapoint on the visual to receive a callback that provides data specific to the selected data point. This information can be used to Embedding custom assets 1419 Amazon QuickSight User Guide flag key records, compile raw data specific to the datapoint, capture |
amazon-quicksight-user-392 | amazon-quicksight-user.pdf | 392 | callback actions at runtime in Amazon QuickSight Use embedded datapoint callback actions to build tighter integrations between your software as a service (SaaS) application and your Amazon QuickSight embedded dashboards and visuals. Developers can register datapoints to be called back with the QuickSight embedding SDK. When you register a callback action for a visual, readers can select a datapoint on the visual to receive a callback that provides data specific to the selected data point. This information can be used to Embedding custom assets 1419 Amazon QuickSight User Guide flag key records, compile raw data specific to the datapoint, capture records, and compile data for backend processes. Embedded callbacks aren't supported for custom visual content, text boxes, or insights. Before you begin registering datapoints for callback, update the Embedding SDK to version 2.3.0. For more information about using the QuickSight Embedding SDK, see the amazon-quicksight- embedding-sdk on GitHub. A datapoint callback can be registered to one or more visuals at runtime through the QuickSight SDK. You can also register a datapoint callback to any interaction supported by the VisualCustomAction API structure. This allows the datapoint callback to initiate when the user selects the datapoint on the visual or when the datapoint is selected from the datapoint context menu. The following example registers a datapoint callback that the reader initiates when they select a datapoint on the visual. /const MY_GET_EMBED_URL_ENDPOINT = "https://my.api.endpoint.domain/MyGetEmbedUrlApi"; // Sample URL // The dashboard id to embed const MY_DASHBOARD_ID = "my-dashboard"; // Sample ID // The container element in your page that will have the embedded dashboard const MY_DASHBOARD_CONTAINER = "#experience-container"; // Sample ID // SOME HELPERS const ActionTrigger = { DATA_POINT_CLICK: "DATA_POINT_CLICK", DATA_POINT_MENU: "DATA_POINT_MENU", }; const ActionStatus = { ENABLED: "ENABLED", DISABLED: "DISABLED", }; // This function makes a request to your endpoint to obtain an embed url for a given dashboard id // The example implementation below assumes the endpoint takes dashboardId as request data // and returns an object with EmbedUrl property Embedding custom assets 1420 Amazon QuickSight User Guide const myGetEmbedUrl = async (dashboardId) => { const apiOptions = { dashboardId, }; const apiUrl = new URL(MY_GET_EMBED_URL_ENDPOINT); apiUrl.search = new URLSearchParams(apiOptions).toString(); const apiResponse = await fetch(apiUrl.toString()); const apiResponseData = await apiResponse.json(); return apiResponseData.EmbedUrl; }; // This function constructs a custom action object const myConstructCustomActionModel = ( customActionId, actionName, actionTrigger, actionStatus ) => { return { Name: actionName, CustomActionId: customActionId, Status: actionStatus, Trigger: actionTrigger, ActionOperations: [ { CallbackOperation: { EmbeddingMessage: {}, }, }, ], }; }; // This function adds a custom action on the first visual of first sheet of the embedded dashboard const myAddVisualActionOnFirstVisualOfFirstSheet = async ( embeddedDashboard ) => { // 1. List the sheets on the dashboard const { SheetId } = (await embeddedDashboard.getSheets())[0]; // If you'd like to add action on the current sheet instead, you can use getSelectedSheetId method // const SheetId = await embeddedDashboard.getSelectedSheetId(); Embedding custom assets 1421 Amazon QuickSight User Guide // 2. List the visuals on the specified sheet const { VisualId } = (await embeddedDashboard.getSheetVisuals(SheetId))[0]; // 3. Add the custom action to the visual try { const customActionId = "custom_action_id"; // Sample ID const actionName = "Flag record"; // Sample name const actionTrigger = ActionTrigger.DATA_POINT_CLICK; // or ActionTrigger.DATA_POINT_MENU const actionStatus = ActionStatus.ENABLED; const myCustomAction = myConstructCustomActionModel( customActionId, actionName, actionTrigger, actionStatus ); const response = await embeddedDashboard.addVisualActions( SheetId, VisualId, [myCustomAction] ); if (!response.success) { console.log("Adding visual action failed", response.errorCode); } } catch (error) { console.log("Adding visual action failed", error); } }; const parseDatapoint = (visualId, datapoint) => { datapoint.Columns.forEach((Column, index) => { // FIELD | METRIC const columnType = Object.keys(Column)[0]; // STRING | DATE | INTEGER | DECIMAL const valueType = Object.keys(Column[columnType])[0]; const { Column: columnMetadata } = Column[columnType][valueType]; const value = datapoint.RawValues[index][valueType]; const formattedValue = datapoint.FormattedValues[index]; console.log( `Column: ${columnMetadata.ColumnName} has a raw value of ${value} and formatted value of ${formattedValue.Value} for visual: ${visualId}` Embedding custom assets 1422 Amazon QuickSight ); }); }; User Guide // This function is used to start a custom workflow after the end user selects a datapoint const myCustomDatapointCallbackWorkflow = (callbackData) => { const { VisualId, Datapoints } = callbackData; parseDatapoint(VisualId, Datapoints); }; // EMBEDDING THE DASHBOARD const main = async () => { // 1. Get embed url let url; try { url = await myGetEmbedUrl(MY_DASHBOARD_ID); } catch (error) { console.log("Obtaining an embed url failed"); } if (!url) { return; } // 2. Create embedding context const embeddingContext = await createEmbeddingContext(); // 3. Embed the dashboard const embeddedDashboard = await embeddingContext.embedDashboard( { url, container: MY_DASHBOARD_CONTAINER, width: "1200px", height: "300px", resizeHeightOnSizeChangedEvent: true, }, { onMessage: async (messageEvent) => { const { eventName, message } = messageEvent; switch (eventName) { case "CONTENT_LOADED": { Embedding custom assets 1423 Amazon QuickSight User Guide await myAddVisualActionOnFirstVisualOfFirstSheet(embeddedDashboard); break; } case "CALLBACK_OPERATION_INVOKED": { myCustomDatapointCallbackWorkflow(message); break; } } }, } ); }; main().catch(console.error); You can also configure |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.