Awso_quicksight.Values_0Sourceval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]Configuration for API key-based authentication to external services.
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
The Quick Sight customizations associated with your Amazon Web Services account or a Quick Sight namespace in a specific Amazon Web Services Region.
A structure that contains the following account information elements: Your Quick Sight account name. The edition of Quick Sight that your account is using. The notification email address that is associated with the Quick Sight account. The authentication type of the Quick Sight account. The status of the Quick Sight account's subscription.
The Quick Sight settings associated with your Amazon Web Services account.
Read-only metadata for connections that do not require authentication credentials.
Read-only metadata for IAM-based connections, containing role and source ARN information.
Read-only configuration details for OAuth2 client credentials grant flow, including client ID and token endpoint.
Read-only details for OAuth2 client credentials, containing non-sensitive configuration information.
Read-only metadata for OAuth2 client credentials grant authentication configuration.
Read-only metadata for basic authentication connections, containing non-sensitive configuration details.
Read-only configuration details for OAuth2 authorization code grant flow, including endpoints and client information.
Read-only credentials details for OAuth2 authorization code grant flow, containing non-sensitive configuration information.
Read-only metadata for OAuth2 authorization code grant authentication configuration.
Read-only authentication metadata for API key-based connections, containing non-sensitive configuration details.
Read-only authentication metadata union containing non-sensitive configuration details for different authentication types.
Read-only authentication configuration containing non-sensitive authentication details for action connectors.
Contains error information for an action connector that is in an error state.
Contains detailed information about an action connector, including its configuration, status, and enabled actions.
A filter used to search for action connectors based on specific criteria.
Contains summary information about an action connector, used in list and search operations.
The active Identity and Access Management (IAM) policy assignment.
An ad hoc (one-time) filtering option.
The definition of an Agg function.
Maps a source column identifier to a target column identifier during transform operations.
Specifies the source of data for a transform operation, including the source operation and column mappings.
A simple aggregation function that performs standard statistical operations on a column.
An aggregation function that concatenates values from multiple rows into a single string with a specified separator.
Defines the type of aggregation function to apply to data during data preparation, supporting simple and list aggregations.
Defines an aggregation function to be applied to grouped data, creating a new column with the calculated result.
A transform operation that groups rows by specified columns and applies aggregation functions to calculate summary values.
An aggregation based on the percentile of values in a dimension or measure.
Aggregation for numerical values.
Aggregation for attributes.
An aggregation function aggregates values from a dimension or measure. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The definition of an AggregationPartitionBy.
A column of a data set.
The configuration options to sort aggregated values.
An empty object that represents that the AllSheets option is the chosen value for the FilterScopeConfiguration parameter. This structure applies the filter to all visuals on all sheets of an Analysis, Dashboard, or Template. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The parameters for OpenSearch.
The parameters for OpenSearch.
The generative BI authoring settings of an embedded Quick Sight console.
The executive summary settings of an embedded Quick Sight console or dashboard.
The data story settings of an embedded Quick Sight console.
The generative Q&A settings of an embedded Quick Sight console.
A collection of Amazon Q feature configurations in an embedded Quick Sight console.
A collection of Amazon Q feature configurations in an embedded Quick Sight dashboard.
The text that appears in the sheet image tooltip.
The tooltip configuration for a sheet image.
The source of the static file that contains the image.
The source of the image.
Determines how the image is scaled
The menu options for the interactions of an image.
The general image interactions setup for image publish options.
The URL operation that opens a link to another webpage.
The customized parameter values. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The configuration of custom values for the destination parameter in DestinationParameterValueConfiguration.
The configuration of destination parameter values. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The configuration of adding parameters in action.
The set parameter operation that sets parameters in custom action.
The navigation configuration for CustomActionNavigationOperation.
The navigation operation that navigates between different sheets in the same analysis. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The operation that is defined by the custom action. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
A custom action defined on an image.
An image that is located on a sheet.
A sheet, which is an object that contains a set of visuals that are viewed together on one page in Quick Sight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
An object, structure, or sub-structure of an analysis, template, or dashboard.
Analysis error.
The options for a paper canvas of a section-based layout.
The options for the canvas of a section-based layout.
The options that determine the default settings for a section-based layout configuration.
The options that determine the default settings for a paginated layout configuration.
String based length that is composed of value and unit in px
The options that determine the sizing of the canvas used in a grid layout.
Configuration options for the canvas of a grid layout.
The options that determine the default settings for a grid layout configuration.
The options that determine the sizing of the canvas used in a free-form layout.
Configuration options for the canvas of a free-form layout.
The options that determine the default settings of a free-form layout configuration.
The options that determine the default settings for interactive layout configuration.
The configuration for default new sheet settings.
The configuration for default analysis settings.
The limit configuration of the visual display for an axis.
The sort configuration for a column that is not used in a field well.
The field sort options in a chart configuration.
The sort configuration of a word cloud visual.
The word cloud options for a word cloud visual.
The options that determine the thousands separator configuration.
The options that determine the numeric separator configuration.
The options that determine the null value format configuration.
The options that determine the negative value configuration.
The option that determines the decimal places configuration.
The options that determine the percentage display format configuration.
The options that determine the number display format configuration.
The options that determine the currency display format configuration.
The options that determine the numeric format configuration. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
Formatting configuration for number fields.
The measure type field with numerical type columns.
Formatting configuration for DateTime fields.
The measure type field with date type columns.
Formatting configuration for string fields.
The measure type field with categorical type columns.
The table calculation measure field for pivot tables.
The measure (metric) type field.
The dimension type field with numerical type columns.
The dimension type field with date type columns.
The dimension type field with categorical type columns..
The dimension type field.
The aggregated field wells of a word cloud.
The field wells of a word cloud visual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The menu options for a visual.
The context menu options for a visual's interactions.
The general visual interactions setup for visual publish options
The option that determines the text display weight, or boldness.
Configures the display properties of the given text.
The reference that specifies where the axis label is applied to.
The label options for a chart axis. You must specify the field that the label is targeted to.
The label options for an axis on a chart.
The configuration of a word cloud visual.
The text format for the title. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The title label options for a visual.
The text format for a subtitle. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The subtitle label options for a visual.
The configuration of the same-sheet target visuals that you want to be filtered. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The configuration of target visuals that you want to be filtered. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The configuration of selected fields in theCustomActionFilterOperation. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The filter operation that filters data included in a visual or in an entire sheet.
The operation that is defined by the custom action. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
A custom action defined on a visual.
The time range drill down filter.
The numeric equality type drill down filter.
The category drill down filter.
The drill down filter for the column hierarchies. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.
The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.
The option that determines the hierarchy of any DateTime fields.
The option that determines the hierarchy of the fields for a visual element.
A word cloud. For more information, see Using word clouds in the Amazon Quick Suite User Guide.
The sort configuration of a waterfall visual.
The options that determine the presentation of a waterfall visual.
The field well configuration of a waterfall visual.
The field well configuration of a waterfall visual.
The color configuration for individual groups within a waterfall visual.
The color configuration of a waterfall visual.
The type of the data path value.
The data path that needs to be sorted.
The color map that determines the color options for a particular element.
The visual display options for the visual palette.
The share label options for the labels.
The options for the legend setup of a visual.
The range ends label type of a data path label.
The minimum label of a data path label.
The maximum label of a data path label.
The field label type.
The option that specifies individual data values for labels.
The option that determines the data label type. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The options that determine the presentation of the data labels.
The percent range in the visible range.
The range options for the data zoom scroll bar.
The visual display options for a data zoom scroll bar.
The tick label options of an axis.
The logarithmic axis scale setup.
The liner axis scale setup. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The scale setup options for a numeric axis display. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The minimum and maximum setup for an axis display range.
The options that are saved for future extension.
The range setup of a numeric axis display range. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The options for an axis with a numeric field.
The options that determine how a date axis is displayed.
The data options for an axis. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The display options for the axis label.
The configuration for a waterfall visual.
A waterfall chart. For more information, see Using waterfall charts in the Amazon Quick Suite User Guide.
The sort configuration of a tree map.
Aggregated field wells of a tree map.
The field wells of a tree map. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The configuration of the sheet tooltip.
The tooltip item for the fields.
The tooltip item for the columns that are not part of a field well.
The tooltip. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The setup for the detailed tooltip.
The display options for the visual tooltip.
Determines the color that is applied to a particular data value.
Determines the color scale that is applied to the visual.
The configuration of a tree map.
A tree map. For more information, see Using tree maps in the Amazon Quick Suite User Guide.
An aggregation function that aggregates the total values of a measure.
The total aggregation settings map of a field id.
The border options for a table border.
The side border options for a table.
Determines the border options for a table visual.
The table cell style for a cell in pivot table or table visual.
The total options for a table visual.
The pagination configuration for a table visual or boxplot.
The sort configuration for a TableVisual.
The paginated report options for a table visual.
Determines the row alternate color options.
The table options for a table visual.
Marker styles options for a line series in LineChartVisual.
The options for sparklines in a table.
The options for data bars.
The inline visualization of a specific type to display within a chart.
The formatting configuration for all types of field.
The unaggregated field for a table.
The unaggregated field well for the table.
The aggregated field well for the table.
The field wells for a table visual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The integer value of a column index in the transposed table.
The column option of the transposed table.
The settings for the pinned columns of a table visual.
The custom text content (value, font configuration) for the table link content configuration.
The custom icon content for the table link content configuration.
The URL content (text, icon) for the table link configuration.
The link configuration of a table field URL.
The sizing options for the table image configuration.
The image configuration of a table field URL.
The URL configuration for a table field.
The options for a table field.
The field options of a table visual.
The configuration that controls field customization options available to dashboard readers for a visual.
The options that define customizations available to dashboard readers for a specific visual
The configuration for a TableVisual.
Formatting configuration for solid color.
Determines the gradient stop configuration.
Determines the gradient color settings.
Formatting configuration for gradient color.
The formatting configuration for the color.
The conditional formatting of a table row.
Formatting configuration for icon set.
Determines the icon display configuration.
Custom icon options for an icon set.
Determines the custom condition for an icon set.
The formatting configuration for the icon.
The conditional formatting for the text.
The cell conditional formatting option for a table.
Conditional formatting options for a PivotTableVisual.
The conditional formatting for a PivotTableVisual.
A table visual. For more information, see Using tables as visuals in the Amazon Quick Suite User Guide.
The sort configuration of a scatter plot.
The unaggregated field wells of a scatter plot.
The aggregated field well of a scatter plot.
The field well configuration of a scatter plot. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The configuration of a scatter plot.
A scatter plot. For more information, see Using scatter plots in the Amazon Quick Suite User Guide.
The sort configuration of a sankey diagram.
The field well configuration of a sankey diagram.
The field well configuration of a sankey diagram.
The configuration of a sankey diagram.
A sankey diagram. For more information, see Using Sankey diagrams in the Amazon Quick Suite User Guide.
The sort configuration of a RadarChartVisual.
The configured style settings of a radar chart.
The series settings of a radar chart.
The aggregated field well configuration of a RadarChartVisual.
The field wells of a radar chart visual.
The configuration of a RadarChartVisual.
A radar chart visual.
A query limits configuration.
The table query sorting options for the plugin visual.
Determines how the plugin visual sorts the data during query.
The key value pair of the persisted property.
The options and persisted properties for the plugin visual.
A collection of field wells for a plugin visual.
The plugin visual configuration. This includes the field wells, sorting options, and persisted options of the plugin visual.
A flexible visualization type that allows engineers to create new custom charts in Quick Sight.
The table style target.
The optional configuration of subtotals cells.
The subtotal options.
The optional configuration of totals cells in a PivotTableVisual.
The total options for a pivot table visual.
Allows data paths to be sorted by a specific data value.
The sort by field for the field sort options.
The field sort options for a pivot table sort configuration.
The sort configuration for a PivotTableVisual.
The paginated report options for a pivot table visual.
The options for the label thta is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.
The table options for a pivot table visual.
The aggregated field well for the pivot table.
The field wells for a pivot table visual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The selected field options for the pivot table field options.
The target of a pivot table field collapse state.
The collapse state options for the pivot table field options.
The data path options for the pivot table field options.
The field options for a pivot table visual.
The configuration for a PivotTableVisual.
The scope of the cell for conditional formatting.
The cell conditional formatting option for a pivot table.
Conditional formatting options for a PivotTableVisual.
The conditional formatting for a PivotTableVisual.
A pivot table. For more information, see Using pivot tables in the Amazon Quick Suite User Guide.
Configures the properties of a chart's axes that are used by small multiples panels.
The options that determine the title styles for each small multiples panel.
A collection of options that configure how each panel displays in a small multiples chart.
Options that determine the layout and display options of a chart's small multiples.
The sort configuration of a pie chart.
The field well configuration of a pie chart.
The field well configuration of a pie chart. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.
The options that determine the arc thickness of a GaugeChartVisual.
The options for configuring a donut chart or pie chart.
The contribution analysis visual display for a line, pie, or bar chart.
The configuration of a pie chart.
A pie or donut chart. The PieChartVisual structure describes a visual that is a member of the pie chart family. The following charts can be described by using this structure: Pie charts Donut charts For more information, see Using pie charts in the Amazon Quick Suite User Guide. For more information, see Using donut charts in the Amazon Quick Suite User Guide.
The options that are available for a single Y axis in a chart.
The settings of a chart's single axis configuration.
Line styles options for a line series in LineChartVisual.
Decal settings for accessibility features that define visual patterns and styling for data elements.
The options that determine the presentation of a line series in the visual
The field series item configuration of a line chart.
The data field series item configuration of a line chart.
The series item configuration of a line chart. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The style configuration of the reference line.
The value label configuration of the label in a reference line.
The configuration for a custom label on a ReferenceLine.
The label configuration of a reference line.
The static data configuration of the reference line data configuration.
The dynamic configuration of the reference line data configuration.
The data configuration of the reference line.
The reference line visual display options.
The configuration options that determine how missing data is treated during the rendering of a line chart.
The series axis configuration of a line chart.
The sort configuration of a line chart.
The field well configuration of a line chart.
The field well configuration of a line chart.
The options that determine the default presentation of all line series in LineChartVisual.
The forecast properties setup of a forecast in the line chart.
Provides the forecast to meet the target for a particular date range.
Provides the forecast to meet the target for a particular date.
The forecast scenario of a forecast in the line chart.
The forecast configuration that is used in a line chart's display properties.
The configuration of a line chart.
A line chart. For more information, see Using line charts in the Amazon Quick Suite User Guide.
The map style properties for a map.
The bound options (north, south, west, east) of the geospatial window options.
The map state properties for a map.
The operation that is defined by the custom action. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
A layer custom action.
The color field that defines a gradient or categorical style.
The custom actions for a layer.
The width properties for a line.
The definition for a solid color.
The symbol style for null data.
The properties for the visualization of null data.
The gradient step color for a single step.
The definition for a gradient color.
The categorical data color for a single category.
The definition for a categorical color.
The visualization properties for solid, gradient, and categorical colors.
The polygon symbol style for a polygon layer.
The polygon style for a polygon layer.
The geospatial polygon layer.
The geospatial radius for a circle.
The properties for a circle symbol style.
The point style for a point layer.
The geospatial Point layer.
The symbol style for a line layer.
The visualization style for a line layer.
The geospatial Line layer.
The definition properties for a geospatial layer.
The source properties for a geospatial static file.
The data source properties for the geospatial data.
The properties for a single geospatial layer.
The map definition that defines map state, map style, and geospatial layers.
A layer map visual.
The sort configuration of a KPI visual.
The options that determine the presentation of trend arrows in a KPI visual.
The options that determine the presentation of the secondary value of a KPI visual.
The options that determine the presentation of the progress bar of a KPI visual.
The standard layout of the KPI visual.
The options that determine the layout a KPI visual.
The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
The format of the comparison. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The comparison display configuration of a KPI or gauge chart.
The options that determine the presentation of a KPI visual.
The field well configuration of a KPI visual.
The configuration of a KPI visual.
The conditional formatting for the progress bar of a KPI visual.
The conditional formatting for the primary value of a KPI visual.
The conditional formatting for the comparison value of a KPI visual.
The conditional formatting for the actual value of a KPI visual.
The conditional formatting options of a KPI visual.
The conditional formatting of a KPI visual.
A key performance indicator (KPI). For more information, see Using KPIs in the Amazon Quick Suite User Guide.
The custom narrative options.
The unique values computation configuration.
The total aggregation computation configuration.
The top ranked and bottom ranked computation configuration.
The top movers and bottom movers computation setup.
The period to date computation configuration.
The period over period computation configuration.
The metric comparison computation configuration.
The maximum and minimum computation configuration.
The growth rate computation configuration.
The forecast computation configuration.
The computation union that is used in an insight visual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The configuration of an insight visual.
An insight visual. For more information, see Working with insights in the Amazon Quick Suite User Guide.
The field well configuration of a histogram.
The field well configuration of a histogram.
The options that determine the bin width of a histogram.
The options that determine the bin count of a histogram.
The options that determine the presentation of histogram bins.
The configuration for a HistogramVisual.
A histogram. For more information, see Using histograms in the Amazon Quick Suite User Guide.
The sort configuration of a heat map.
The aggregated field wells of a heat map.
The field well configuration of a heat map. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The configuration of a heat map.
A heat map. For more information, see Using heat maps in the Amazon Quick Suite User Guide.
The window options of the geospatial map visual.
The color to be used in the heatmap point style.
The color scale specification for the heatmap point style.
The heatmap configuration of the geospatial point style.
The simple cluster marker of the cluster marker.
The cluster marker that is a part of the cluster marker configuration.
The cluster marker configuration of the geospatial map selected point style.
The point style of the geospatial map.
The map style options of the geospatial map.
The aggregated field wells for a geospatial map.
The field wells of a GeospatialMapVisual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The configuration of a GeospatialMapVisual.
The preference hierarchy for the geocode preference.
The preference coordinate for the geocode preference.
The preference value for the geocode preference.
The geocode preference.
A geospatial map or a points on map visual. For more information, see Creating point maps in the Amazon Quick Suite User Guide.
The arc configuration of a GaugeChartVisual.
The arc axis range of a GaugeChartVisual.
The arc axis configuration of a GaugeChartVisual.
The options that determine the presentation of the GaugeChartVisual.
The field well configuration of a GaugeChartVisual.
The color configuration of a GaugeChartVisual.
The configuration of a GaugeChartVisual.
The conditional formatting for the primary value of a GaugeChartVisual.
The options that determine the presentation of the arc of a GaugeChartVisual.
Conditional formatting options of a GaugeChartVisual.
The conditional formatting of a GaugeChartVisual.
A gauge chart. For more information, see Using gauge charts in the Amazon Quick Suite User Guide.
The sort configuration of a FunnelChartVisual.
The field well configuration of a FunnelChartVisual.
The field well configuration of a FunnelChartVisual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The options that determine the presentation of the data labels.
The configuration of a FunnelChartVisual.
A funnel chart. For more information, see Using funnel charts in the Amazon Quick Suite User Guide.
The sort configuration of a FilledMapVisual.
The aggregated field well of the filled map.
The field wells of a FilledMapVisual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The configuration for a FilledMapVisual.
The shape conditional formatting of a filled map visual.
The conditional formatting that determines the shape of the filled map.
Conditional formatting options of a FilledMapVisual.
The conditional formatting of a FilledMapVisual.
A filled map. For more information, see Creating filled maps in the Amazon Quick Suite User Guide.
An empty visual. Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Quick Sight console is considered an EmptyVisual until a visual type is selected.
The configuration of a CustomContentVisual.
A visual that contains custom content. For more information, see Using custom visual content in the Amazon Quick Suite User Guide.
Border settings configuration for visual elements, including visibility, width, and color properties.
Options that determine the presentation of a series in the visual.
The field series item configuration of a ComboChartVisual.
The data field series item configuration of a ComboChartVisual.
The series item configuration of a ComboChartVisual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The sort configuration of a ComboChartVisual.
The aggregated field wells of a combo chart.
The field wells of the visual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The options that determine the default presentation of all series in ComboChartVisual.
The configuration of a ComboChartVisual.
A combo chart. The ComboChartVisual includes stacked bar combo charts and clustered bar combo charts For more information, see Using combo charts in the Amazon Quick Suite User Guide.
The sort configuration of a BoxPlotVisual.
The style options of the box plot.
The options of a box plot visual.
The aggregated field well for a box plot.
The field wells of a BoxPlotVisual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The configuration of a BoxPlotVisual.
A box plot. For more information, see Using box plots in the Amazon Quick Suite User Guide.
Options that determine the presentation of a bar series in the visual.
The field series item configuration of a BarChartVisual.
The data field series item configuration of a BarChartVisual.
The series item configuration of a BarChartVisual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
sort-configuration-description
The aggregated field wells of a bar chart.
The field wells of a BarChartVisual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The options that determine the default presentation of all bar series in BarChartVisual.
The configuration of a BarChartVisual.
A bar chart. The BarChartVisual structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure: Horizontal bar chart Vertical bar chart Horizontal stacked bar chart Vertical stacked bar chart Horizontal stacked 100% bar chart Vertical stacked 100% bar chart For more information, see Using bar charts in the Amazon Quick Suite User Guide.
A visual displayed on a sheet in an analysis, dashboard, or template. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The menu options for the interactions of a textbox.
The general textbox interactions setup for textbox publish options.
A text box.
The options that style a section.
String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value
The override configuration of the rendering rules of a sheet.
The rendering rules of a sheet that uses a free-form layout.
The configuration of loading animation in free-form layout.
String to encapsulate the most generic way Width can be formatted with whatever units (px, em etc)
The background style configuration of a free-form layout element.
The background style configuration of a free-form layout element.
An element within a free-form layout.
The free-form layout configuration of a section.
The layout configuration of a section.
The configuration of a header or footer section.
The configuration of a page break after a section.
The configuration of a page break for a section.
The page break configuration to apply for each repeating instance.
Describes the Numeric dataset column and constraints for the dynamic values used to repeat the contents of a section.
Describes the Category dataset column and constraints for the dynamic values used to repeat the contents of a section.
Describes the dataset column and constraints for the dynamic values used to repeat the contents of a section. The dataset column is either Category or Numeric column configuration
Describes the configurations that are required to declare a section as repeating.
The configuration of content in a body section.
The configuration of a body section.
The configuration for a section-based layout.
The border style configuration of a grid layout element.
The background style configuration of a grid layout element.
An element within a grid layout.
The configuration for a grid layout. Also called a tiled layout. Visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size.
A member of a sheet layout group.
A group of elements within a sheet layout.
The configuration of a free-form layout.
The configuration that determines what the type of layout will be used on a sheet. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
A Layout defines the placement of elements within a sheet. For more information, see Types of layout in the Amazon Quick Suite User Guide. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
A tooltip sheet is an object that contains a set of visuals that are used as a tooltip. Every analysis and dashboard must contain at least one non-tooltip sheet.
The structure that contains the URL to download the static file from.
The structure that contains the Amazon S3 location to download the static file from.
The source of the static file.
A static file that contains the geospatial data.
A static file that contains an image.
The static file.
Defines what initiates a highlight operation on a visual, such as a click or hover.
A list of custom actions applied to visuals in an analysis or sheet.
The configuration that determines the elements and canvas size options of sheet control.
A grid layout to define the placement of sheet control.
The configuration of the placeholder options in a text control.
A control to display info icons for filters and parameters.
The display options of a control.
The rich text title for a sheet control.
The plain text title for a sheet control.
The title format text configuration for a sheet control. This is a tagged union type. Specify either PlainText or RichText, but not both.
A control to display a text box that is used to enter a single entry.
The display options of a control.
A control to display a text box that is used to enter multiple entries.
The display options of a control.
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
A list of selectable values that are used in a control.
The configuration of the Select all options in a list control.
The configuration of the search options in a list control.
The display options of a control.
The sort configuration for selectable values in a control.
The sort configuration for control values. This is a tagged union type. Specify either SelectableValuesSort or ControlColumnSort, but not both.
The source controls that are used in a CascadingControlConfiguration.
The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
A control to display a list with buttons or boxes that are used to select either a single value or multiple values.
The display options of a control.
A control to display a dropdown list with buttons that are used to select a single value.
The display options of a control.
A control from a date parameter that specifies date and time.
The control of a parameter that users can interact with in a dashboard or an analysis. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
A control to display a text box that is used to enter a single entry.
A control to display a text box that is used to enter multiple entries.
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
The display options of a control.
A control from a date filter that is used to specify the relative date.
A list of selectable values that are used in a control.
A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.
A control to display a dropdown list with buttons that are used to select a single value.
A control from a date filter that is used to specify date and time.
A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet
The control of a filter that is used to interact with a dashboard or an analysis. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.
A structure that describes the query execution options.
The configuration that defines the default value of a String parameter when a value has not been set.
Defines different defaults to the users or groups based on mapping.
The default values of the StringParameterDeclaration.
A dataset parameter that is mapped to an analysis parameter.
A parameter declaration for the String data type.
A parameter declaration for the Integer data type. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The default values of the IntegerParameterDeclaration.
A parameter declaration for the Integer data type.
The configuration that defines the default value of a Decimal parameter when a value has not been set.
The default values of the DecimalParameterDeclaration.
A parameter declaration for the Decimal data type.
The configuration that defines the default value of a DateTime parameter when a value has not been set.
The rolling date configuration of a date time filter.
The default values of the DateTimeParameterDeclaration.
A parameter declaration for the DateTime data type.
The declaration definition of a parameter. For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite User Guide. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The filter that is applied to the options.
The configuration for applying a filter to specific sheets or visuals. You can apply this filter to multiple visuals that are on one sheet or to all visuals on a sheet. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The scope configuration for a FilterGroup. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The default options that correspond to the TextField filter control type.
The default options that correspond to the TextArea filter control type.
The default options that correspond to the Slider filter control type.
The default options that correspond to the RelativeDateTime filter control type.
The default options that correspond to the List filter control type.
The default options that correspond to the Dropdown filter control type.
The default options that correspond to the filter control type of a DateTimePicker.
The option that corresponds to the control type of the filter.
The default configuration for all dependent controls of the filter.
A TopBottomFilter filters values that are at the top or the bottom.
The value of a time range filter. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
The exclude period of TimeRangeFilter or RelativeDatesFilter.
A TimeRangeFilter filters values that are between two specified values.
A TimeEqualityFilter filters values that are equal to a given value.
The date configuration of the filter.
A RelativeDatesFilter filters relative dates values.
The value input pf the numeric range filter.
A NumericRangeFilter filters values that are within the value range.
A NumericEqualityFilter filters values that are equal to the specified value.
A list of filter configurations.
A list of custom filter values.
A custom filter that filters based on a single value. This filter can be partially matched.
The configuration for a CategoryFilter. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
A CategoryInnerFilter filters text values for the NestedFilter.
The InnerFilter defines the subset of data to be used with the NestedFilter.
A NestedFilter filters data with a subset of data that is defined by the nested inner filter.
A CategoryFilter filters text values. For more information, see Adding text filters in the Amazon Quick Suite User Guide.
With a Filter, you can remove portions of data from a particular visual or view. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
A grouping of individual filters. Filter groups are applied to the same group of visuals. For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon Quick Suite User Guide.
A data set.
Decal settings configuration for a column
Determines the color that's applied to a particular data value in a column.
The color configurations for a column.
The general configuration of a column.
The calculated field of an analysis.
An array of analysis level configurations.
The definition of an analysis.
A filter that you apply when searching for one or more analyses.
Dataset reference.
The source template of an analysis.
The source entity of an analysis.
The summary metadata that describes an analysis.
The shared view settings of an embedded dashboard.
The feature configuration for an embedded dashboard.
Information about the dashboard that you want to embed.
A structure that contains the following elements: The DashboardId of the dashboard that has the visual that you want to embed. The SheetId of the sheet that has the visual that you want to embed. The VisualId of the visual that you want to embed. The DashboardId, SheetId, and VisualId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon Quick Sight console. You can also get the DashboardId with a ListDashboards API operation.
The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.
The settings that you want to use with the Q search bar.
The settings that you want to use for the Generative Q&A experience.
The type of experience you want to embed. For anonymous users, you can embed Quick dashboards.
An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon Quick Sight bucket.
A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.
Information on the error that caused the snapshot job to fail.
The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.